mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-10-24 01:53:35 +08:00
Update meta docs (#24892)
* docs: update module reference metadata * Update failsafe metadata in docs * Update parameter metadata * Fix up uorb graphs based on main * SUMMARY.md - and radio control for modules * Add alternate sidebar --------- Co-authored-by: PX4BuildBot <bot@pixhawk.org>
This commit is contained in:
Hamish Willee
co-authored by
PX4BuildBot
PX4BuildBot
parent
0b3fc0a62d
commit
54ddb14137
@@ -1,5 +1,7 @@
|
||||
# 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)
|
||||
|
||||
|
||||
@@ -18,8 +20,8 @@ Stop driver
|
||||
afbrs50 stop
|
||||
```
|
||||
|
||||
<a id="afbrs50_usage"></a>
|
||||
### Usage
|
||||
### Usage {#afbrs50_usage}
|
||||
|
||||
```
|
||||
afbrs50 <command> [arguments...]
|
||||
Commands:
|
||||
@@ -32,11 +34,13 @@ afbrs50 <command> [arguments...]
|
||||
|
||||
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
|
||||
### Usage {#gy_us42_usage}
|
||||
|
||||
```
|
||||
gy_us42 <command> [arguments...]
|
||||
Commands:
|
||||
@@ -54,7 +58,9 @@ gy_us42 <command> [arguments...]
|
||||
|
||||
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)
|
||||
|
||||
|
||||
@@ -77,8 +83,8 @@ Stop driver
|
||||
leddar_one stop
|
||||
```
|
||||
|
||||
<a id="leddar_one_usage"></a>
|
||||
### Usage
|
||||
### Usage {#leddar_one_usage}
|
||||
|
||||
```
|
||||
leddar_one <command> [arguments...]
|
||||
Commands:
|
||||
@@ -89,7 +95,9 @@ leddar_one <command> [arguments...]
|
||||
|
||||
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)
|
||||
|
||||
|
||||
@@ -99,8 +107,8 @@ I2C bus driver for Lightware SFxx series LIDAR rangefinders: SF10/a, SF10/b, SF1
|
||||
|
||||
Setup/usage information: https://docs.px4.io/main/en/sensor/sfxx_lidar.html
|
||||
|
||||
<a id="lightware_laser_i2c_usage"></a>
|
||||
### Usage
|
||||
### Usage {#lightware_laser_i2c_usage}
|
||||
|
||||
```
|
||||
lightware_laser_i2c <command> [arguments...]
|
||||
Commands:
|
||||
@@ -120,7 +128,9 @@ lightware_laser_i2c <command> [arguments...]
|
||||
|
||||
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)
|
||||
|
||||
|
||||
@@ -143,8 +153,8 @@ Stop driver
|
||||
lightware_laser_serial stop
|
||||
```
|
||||
|
||||
<a id="lightware_laser_serial_usage"></a>
|
||||
### Usage
|
||||
### Usage {#lightware_laser_serial_usage}
|
||||
|
||||
```
|
||||
lightware_laser_serial <command> [arguments...]
|
||||
Commands:
|
||||
@@ -155,7 +165,9 @@ lightware_laser_serial <command> [arguments...]
|
||||
|
||||
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)
|
||||
|
||||
|
||||
@@ -175,8 +187,8 @@ Stop driver
|
||||
lightware_sf45_serial stop
|
||||
```
|
||||
|
||||
<a id="lightware_sf45_serial_usage"></a>
|
||||
### Usage
|
||||
### Usage {#lightware_sf45_serial_usage}
|
||||
|
||||
```
|
||||
lightware_sf45_serial <command> [arguments...]
|
||||
Commands:
|
||||
@@ -185,7 +197,9 @@ lightware_sf45_serial <command> [arguments...]
|
||||
|
||||
stop Stop driver
|
||||
```
|
||||
|
||||
## ll40ls
|
||||
|
||||
Source: [drivers/distance_sensor/ll40ls_pwm](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/ll40ls_pwm)
|
||||
|
||||
|
||||
@@ -197,8 +211,8 @@ 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
|
||||
### Usage {#ll40ls_usage}
|
||||
|
||||
```
|
||||
ll40ls <command> [arguments...]
|
||||
Commands:
|
||||
@@ -210,11 +224,13 @@ ll40ls <command> [arguments...]
|
||||
|
||||
stop Stop driver
|
||||
```
|
||||
|
||||
## 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
|
||||
### Usage {#mappydot_usage}
|
||||
|
||||
```
|
||||
mappydot <command> [arguments...]
|
||||
Commands:
|
||||
@@ -230,11 +246,13 @@ mappydot <command> [arguments...]
|
||||
|
||||
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
|
||||
### Usage {#mb12xx_usage}
|
||||
|
||||
```
|
||||
mb12xx <command> [arguments...]
|
||||
Commands:
|
||||
@@ -254,7 +272,9 @@ mb12xx <command> [arguments...]
|
||||
|
||||
status print status info
|
||||
```
|
||||
|
||||
## pga460
|
||||
|
||||
Source: [drivers/distance_sensor/pga460](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/pga460)
|
||||
|
||||
|
||||
@@ -270,8 +290,8 @@ running. A simple algorithm to detect false readings is implemented at the drive
|
||||
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
|
||||
### Usage {#pga460_usage}
|
||||
|
||||
```
|
||||
pga460 <command> [arguments...]
|
||||
Commands:
|
||||
@@ -284,11 +304,13 @@ pga460 <command> [arguments...]
|
||||
|
||||
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
|
||||
### Usage {#srf02_usage}
|
||||
|
||||
```
|
||||
srf02 <command> [arguments...]
|
||||
Commands:
|
||||
@@ -308,7 +330,9 @@ srf02 <command> [arguments...]
|
||||
|
||||
status print status info
|
||||
```
|
||||
|
||||
## srf05
|
||||
|
||||
Source: [drivers/distance_sensor/srf05](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/srf05)
|
||||
|
||||
|
||||
@@ -319,8 +343,8 @@ Source: [drivers/distance_sensor/srf05](https://github.com/PX4/PX4-Autopilot/tre
|
||||
The sensor/driver must be enabled using the parameter SENS_EN_HXSRX0X.
|
||||
|
||||
|
||||
<a id="srf05_usage"></a>
|
||||
### Usage
|
||||
### Usage {#srf05_usage}
|
||||
|
||||
```
|
||||
srf05 <command> [arguments...]
|
||||
Commands:
|
||||
@@ -336,7 +360,9 @@ srf05 <command> [arguments...]
|
||||
|
||||
status print status info
|
||||
```
|
||||
|
||||
## teraranger
|
||||
|
||||
Source: [drivers/distance_sensor/teraranger](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/teraranger)
|
||||
|
||||
|
||||
@@ -348,8 +374,8 @@ 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
|
||||
### Usage {#teraranger_usage}
|
||||
|
||||
```
|
||||
teraranger <command> [arguments...]
|
||||
Commands:
|
||||
@@ -369,11 +395,13 @@ teraranger <command> [arguments...]
|
||||
|
||||
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
|
||||
### Usage {#tf02pro_usage}
|
||||
|
||||
```
|
||||
tf02pro <command> [arguments...]
|
||||
Commands:
|
||||
@@ -393,7 +421,9 @@ tf02pro <command> [arguments...]
|
||||
|
||||
status print status info
|
||||
```
|
||||
|
||||
## tfmini
|
||||
|
||||
Source: [drivers/distance_sensor/tfmini](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/tfmini)
|
||||
|
||||
|
||||
@@ -416,8 +446,8 @@ Stop driver
|
||||
tfmini stop
|
||||
```
|
||||
|
||||
<a id="tfmini_usage"></a>
|
||||
### Usage
|
||||
### Usage {#tfmini_usage}
|
||||
|
||||
```
|
||||
tfmini <command> [arguments...]
|
||||
Commands:
|
||||
@@ -432,7 +462,9 @@ tfmini <command> [arguments...]
|
||||
|
||||
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)
|
||||
|
||||
|
||||
@@ -453,8 +485,8 @@ Stop driver
|
||||
ulanding_radar stop
|
||||
```
|
||||
|
||||
<a id="ulanding_radar_usage"></a>
|
||||
### Usage
|
||||
### Usage {#ulanding_radar_usage}
|
||||
|
||||
```
|
||||
ulanding_radar <command> [arguments...]
|
||||
Commands:
|
||||
@@ -466,11 +498,13 @@ ulanding_radar <command> [arguments...]
|
||||
|
||||
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
|
||||
### Usage {#vl53l0x_usage}
|
||||
|
||||
```
|
||||
vl53l0x <command> [arguments...]
|
||||
Commands:
|
||||
@@ -490,11 +524,13 @@ vl53l0x <command> [arguments...]
|
||||
|
||||
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
|
||||
### Usage {#vl53l1x_usage}
|
||||
|
||||
```
|
||||
vl53l1x <command> [arguments...]
|
||||
Commands:
|
||||
|
||||
Reference in New Issue
Block a user