diff --git a/docs/en/modules/modules_driver.md b/docs/en/modules/modules_driver.md index f4ebd987eb..c747d6c7b0 100644 --- a/docs/en/modules/modules_driver.md +++ b/docs/en/modules/modules_driver.md @@ -1108,8 +1108,12 @@ px4io [arguments...] ``` ## rgbled +<<<<<<< HEAD Source: [drivers/lights/rgbled_ncp5623c](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/lights/rgbled_ncp5623c) +======= +Source: [drivers/lights/rgbled](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/lights/rgbled) +>>>>>>> 5b409a45c1 (docs: update module reference metadata) ### Usage {#rgbled_usage} @@ -1124,9 +1128,7 @@ rgbled [arguments...] [-f ] bus frequency in kHz [-q] quiet startup (no message if no device found) [-a ] I2C address - default: 57 - [-o ] RGB PWM Assignment - default: 123 + default: 85 stop diff --git a/docs/en/modules/modules_driver_distance_sensor.md b/docs/en/modules/modules_driver_distance_sensor.md index 4e78a7e7ff..f92f57c5aa 100644 --- a/docs/en/modules/modules_driver_distance_sensor.md +++ b/docs/en/modules/modules_driver_distance_sensor.md @@ -4,6 +4,7 @@ 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. @@ -11,13 +12,10 @@ Driver for the Broadcom AFBRS50. ### Examples Attempt to start driver on a specified serial device. - ``` afbrs50 start ``` - Stop driver - ``` afbrs50 stop ``` @@ -32,6 +30,8 @@ afbrs50 [arguments...] [-r ] Sensor rotation - downward facing by default default: 25 + test Test driver + stop Stop driver ``` @@ -63,6 +63,7 @@ gy_us42 [arguments...] 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. @@ -74,13 +75,10 @@ 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 ``` @@ -102,9 +100,10 @@ leddar_one [arguments...] 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, SF30/d. +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 @@ -134,6 +133,7 @@ lightware_laser_i2c [arguments...] 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. @@ -145,13 +145,10 @@ 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 ``` @@ -173,20 +170,19 @@ lightware_laser_serial [arguments...] 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 ``` @@ -204,7 +200,8 @@ lightware_sf45_serial [arguments...] ## ll40ls -Source: [drivers/distance_sensor/ll40ls](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/ll40ls) +Source: [drivers/distance_sensor/ll40ls_pwm](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/ll40ls_pwm) + ### Description @@ -238,32 +235,6 @@ ll40ls [arguments...] status print status info ``` -## ll40ls_pwm - -Source: [drivers/distance_sensor/ll40ls_pwm](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/ll40ls_pwm) - -### Description - -PWM 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 - -### Usage {#ll40ls_pwm_usage} - -``` -ll40ls_pwm [arguments...] - Commands: - start Start driver - [-R ] Sensor rotation - downward facing by default - default: 25 - - status Print driver status information - - stop Stop driver -``` - ## mappydot Source: [drivers/distance_sensor/mappydot](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/mappydot) @@ -316,6 +287,7 @@ mb12xx [arguments...] 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. @@ -373,11 +345,13 @@ srf02 [arguments...] 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. + ### Description + + Driver for HY-SRF05 / HC-SR05 and HC-SR04 rangefinders. + + The sensor/driver must be enabled using the parameter SENS_EN_HXSRX0X. -The sensor/driver must be enabled using the parameter SENS_EN_HXSRX0X. ### Usage {#srf05_usage} @@ -401,6 +375,7 @@ srf05 [arguments...] 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. @@ -461,6 +436,7 @@ tf02pro [arguments...] 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. @@ -472,13 +448,10 @@ 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 ``` @@ -504,6 +477,7 @@ tfmini [arguments...] 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. @@ -513,13 +487,10 @@ 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 ```