mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-10-20 05:53:34 +08:00
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>
This commit is contained in:
Hamish Willee
co-authored by
Ramon Roche
Ramon Roche
parent
8e6d2ebe4a
commit
88d623bedb
@@ -0,0 +1,528 @@
|
||||
# Modules Reference: Distance Sensor (Driver)
|
||||
## afbrs50
|
||||
Source: [drivers/distance_sensor/broadcom/afbrs50](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/broadcom/afbrs50)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
Driver for the Broadcom AFBRS50.
|
||||
|
||||
### Examples
|
||||
|
||||
Attempt to start driver on a specified serial device.
|
||||
```
|
||||
afbrs50 start
|
||||
```
|
||||
Stop driver
|
||||
```
|
||||
afbrs50 stop
|
||||
```
|
||||
|
||||
<a id="afbrs50_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
afbrs50 <command> [arguments...]
|
||||
Commands:
|
||||
start Start driver
|
||||
-d <val> Serial device
|
||||
[-r <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
test Test driver
|
||||
|
||||
stop Stop driver
|
||||
```
|
||||
## gy_us42
|
||||
Source: [drivers/distance_sensor/gy_us42](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/gy_us42)
|
||||
|
||||
<a id="gy_us42_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
gy_us42 <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## leddar_one
|
||||
Source: [drivers/distance_sensor/leddar_one](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/leddar_one)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
Serial bus driver for the LeddarOne LiDAR.
|
||||
|
||||
Most boards are configured to enable/start the driver on a specified UART using the SENS_LEDDAR1_CFG parameter.
|
||||
|
||||
Setup/usage information: https://docs.px4.io/main/en/sensor/leddar_one.html
|
||||
|
||||
### Examples
|
||||
|
||||
Attempt to start driver on a specified serial device.
|
||||
```
|
||||
leddar_one start -d /dev/ttyS1
|
||||
```
|
||||
Stop driver
|
||||
```
|
||||
leddar_one stop
|
||||
```
|
||||
|
||||
<a id="leddar_one_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
leddar_one <command> [arguments...]
|
||||
Commands:
|
||||
start Start driver
|
||||
-d <val> Serial device
|
||||
[-r <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop Stop driver
|
||||
```
|
||||
## lightware_laser_i2c
|
||||
Source: [drivers/distance_sensor/lightware_laser_i2c](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/lightware_laser_i2c)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
I2C bus driver for Lightware SFxx series LIDAR rangefinders: SF10/a, SF10/b, SF10/c, SF11/c, SF/LW20.
|
||||
|
||||
Setup/usage information: https://docs.px4.io/main/en/sensor/sfxx_lidar.html
|
||||
|
||||
<a id="lightware_laser_i2c_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
lightware_laser_i2c <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
[-a <val>] I2C address
|
||||
default: 102
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## lightware_laser_serial
|
||||
Source: [drivers/distance_sensor/lightware_laser_serial](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/lightware_laser_serial)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
Serial bus driver for the LightWare SF02/F, SF10/a, SF10/b, SF10/c, SF11/c Laser rangefinders.
|
||||
|
||||
Most boards are configured to enable/start the driver on a specified UART using the SENS_SF0X_CFG parameter.
|
||||
|
||||
Setup/usage information: https://docs.px4.io/main/en/sensor/sfxx_lidar.html
|
||||
|
||||
### Examples
|
||||
|
||||
Attempt to start driver on a specified serial device.
|
||||
```
|
||||
lightware_laser_serial start -d /dev/ttyS1
|
||||
```
|
||||
Stop driver
|
||||
```
|
||||
lightware_laser_serial stop
|
||||
```
|
||||
|
||||
<a id="lightware_laser_serial_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
lightware_laser_serial <command> [arguments...]
|
||||
Commands:
|
||||
start Start driver
|
||||
-d <val> Serial device
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop Stop driver
|
||||
```
|
||||
## lightware_sf45_serial
|
||||
Source: [drivers/distance_sensor/lightware_sf45_serial](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/lightware_sf45_serial)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
Serial bus driver for the Lightware SF45/b Laser rangefinder.
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
Attempt to start driver on a specified serial device.
|
||||
```
|
||||
lightware_sf45_serial start -d /dev/ttyS1
|
||||
```
|
||||
Stop driver
|
||||
```
|
||||
lightware_sf45_serial stop
|
||||
```
|
||||
|
||||
<a id="lightware_sf45_serial_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
lightware_sf45_serial <command> [arguments...]
|
||||
Commands:
|
||||
start Start driver
|
||||
-d <val> Serial device
|
||||
|
||||
stop Stop driver
|
||||
```
|
||||
## ll40ls
|
||||
Source: [drivers/distance_sensor/ll40ls](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/ll40ls)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
I2C bus driver for LidarLite rangefinders.
|
||||
|
||||
The sensor/driver must be enabled using the parameter SENS_EN_LL40LS.
|
||||
|
||||
Setup/usage information: https://docs.px4.io/main/en/sensor/lidar_lite.html
|
||||
|
||||
<a id="ll40ls_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
ll40ls <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
[-a <val>] I2C address
|
||||
default: 98
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
regdump
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## mappydot
|
||||
Source: [drivers/distance_sensor/mappydot](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/mappydot)
|
||||
|
||||
<a id="mappydot_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
mappydot <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## mb12xx
|
||||
Source: [drivers/distance_sensor/mb12xx](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/mb12xx)
|
||||
|
||||
<a id="mb12xx_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
mb12xx <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
|
||||
set_address
|
||||
[-a <val>] I2C address
|
||||
default: 112
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## pga460
|
||||
Source: [drivers/distance_sensor/pga460](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/pga460)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
Ultrasonic range finder driver that handles the communication with the device and publishes the distance via uORB.
|
||||
|
||||
### Implementation
|
||||
|
||||
This driver is implemented as a NuttX task. This Implementation was chosen due to the need for polling on a message
|
||||
via UART, which is not supported in the work_queue. This driver continuously takes range measurements while it is
|
||||
running. A simple algorithm to detect false readings is implemented at the driver levelin an attemptto improve
|
||||
the quality of data that is being published. The driver will not publish data at all if it deems the sensor data
|
||||
to be invalid or unstable.
|
||||
|
||||
<a id="pga460_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
pga460 <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[device_path] The pga460 sensor device path, (e.g: /dev/ttyS6)
|
||||
|
||||
status
|
||||
|
||||
stop
|
||||
|
||||
help
|
||||
```
|
||||
## srf02
|
||||
Source: [drivers/distance_sensor/srf02](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/srf02)
|
||||
|
||||
<a id="srf02_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
srf02 <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
[-a <val>] I2C address
|
||||
default: 112
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## srf05
|
||||
Source: [drivers/distance_sensor/srf05](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/srf05)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
Driver for HY-SRF05 / HC-SR05 and HC-SR04 rangefinders.
|
||||
|
||||
The sensor/driver must be enabled using the parameter SENS_EN_HXSRX0X.
|
||||
|
||||
|
||||
<a id="srf05_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
srf05 <command> [arguments...]
|
||||
Commands:
|
||||
start Start driver
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
status Print driver status information
|
||||
|
||||
stop Stop driver
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## teraranger
|
||||
Source: [drivers/distance_sensor/teraranger](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/teraranger)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
I2C bus driver for TeraRanger rangefinders.
|
||||
|
||||
The sensor/driver must be enabled using the parameter SENS_EN_TRANGER.
|
||||
|
||||
Setup/usage information: https://docs.px4.io/main/en/sensor/rangefinders.html#teraranger-rangefinders
|
||||
|
||||
<a id="teraranger_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
teraranger <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
[-a <val>] I2C address
|
||||
default: 48
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## tf02pro
|
||||
Source: [drivers/distance_sensor/tf02pro](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/tf02pro)
|
||||
|
||||
<a id="tf02pro_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
tf02pro <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
[-a <val>] I2C address
|
||||
default: 16
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## tfmini
|
||||
Source: [drivers/distance_sensor/tfmini](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/tfmini)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
Serial bus driver for the Benewake TFmini LiDAR.
|
||||
|
||||
Most boards are configured to enable/start the driver on a specified UART using the SENS_TFMINI_CFG parameter.
|
||||
|
||||
Setup/usage information: https://docs.px4.io/main/en/sensor/tfmini.html
|
||||
|
||||
### Examples
|
||||
|
||||
Attempt to start driver on a specified serial device.
|
||||
```
|
||||
tfmini start -d /dev/ttyS1
|
||||
```
|
||||
Stop driver
|
||||
```
|
||||
tfmini stop
|
||||
```
|
||||
|
||||
<a id="tfmini_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
tfmini <command> [arguments...]
|
||||
Commands:
|
||||
start Start driver
|
||||
-d <val> Serial device
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
status Driver status
|
||||
|
||||
stop Stop driver
|
||||
|
||||
test Test driver (basic functional tests)
|
||||
|
||||
status Print driver status
|
||||
```
|
||||
## ulanding_radar
|
||||
Source: [drivers/distance_sensor/ulanding_radar](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/ulanding_radar)
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
Serial bus driver for the Aerotenna uLanding radar.
|
||||
|
||||
Setup/usage information: https://docs.px4.io/main/en/sensor/ulanding_radar.html
|
||||
|
||||
### Examples
|
||||
|
||||
Attempt to start driver on a specified serial device.
|
||||
```
|
||||
ulanding_radar start -d /dev/ttyS1
|
||||
```
|
||||
Stop driver
|
||||
```
|
||||
ulanding_radar stop
|
||||
```
|
||||
|
||||
<a id="ulanding_radar_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
ulanding_radar <command> [arguments...]
|
||||
Commands:
|
||||
start Start driver
|
||||
-d <val> Serial device
|
||||
values: <file:dev>, default: /dev/ttyS3
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop Stop driver
|
||||
```
|
||||
## vl53l0x
|
||||
Source: [drivers/distance_sensor/vl53l0x](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/vl53l0x)
|
||||
|
||||
<a id="vl53l0x_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
vl53l0x <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
[-a <val>] I2C address
|
||||
default: 41
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
## vl53l1x
|
||||
Source: [drivers/distance_sensor/vl53l1x](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/vl53l1x)
|
||||
|
||||
<a id="vl53l1x_usage"></a>
|
||||
### Usage
|
||||
```
|
||||
vl53l1x <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-I] Internal I2C bus(es)
|
||||
[-X] External I2C bus(es)
|
||||
[-b <val>] board-specific bus (default=all) (external SPI: n-th bus
|
||||
(default=1))
|
||||
[-f <val>] bus frequency in kHz
|
||||
[-q] quiet startup (no message if no device found)
|
||||
[-a <val>] I2C address
|
||||
default: 41
|
||||
[-R <val>] Sensor rotation - downward facing by default
|
||||
default: 25
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
Reference in New Issue
Block a user