docs: update module reference metadata

This commit is contained in:
Ramon Roche 2025-06-05 11:51:15 -07:00
parent 91bafed906
commit fa4c77cb11
No known key found for this signature in database
GPG Key ID: 275988FAE5821713
3 changed files with 28 additions and 17 deletions

View File

@ -1141,7 +1141,7 @@ px4io <command> [arguments...]
## rgbled
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)
### Usage {#rgbled_usage}
@ -1156,9 +1156,7 @@ rgbled <command> [arguments...]
[-f <val>] bus frequency in kHz
[-q] quiet startup (no message if no device found)
[-a <val>] I2C address
default: 57
[-o <val>] RGB PWM Assignment
default: 123
default: 85
stop
@ -1479,7 +1477,7 @@ Start the driver with a given device:
```
uwb start -d /dev/ttyS2
```
### Usage {#uwb_usage}
```
@ -1639,7 +1637,7 @@ Source: [modules/zenoh](https://github.com/PX4/PX4-Autopilot/tree/main/src/modul
### Description
Zenoh demo bridge
### Usage {#zenoh_usage}
```

View File

@ -200,12 +200,12 @@ lightware_sf45_serial <command> [arguments...]
## ll40ls
Source: [drivers/distance_sensor/ll40ls_pwm](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/ll40ls_pwm)
Source: [drivers/distance_sensor/ll40ls](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/distance_sensor/ll40ls)
### Description
PWM driver for LidarLite rangefinders.
I2C bus driver for LidarLite rangefinders.
The sensor/driver must be enabled using the parameter SENS_EN_LL40LS.
@ -216,13 +216,23 @@ Setup/usage information: https://docs.px4.io/main/en/sensor/lidar_lite.html
```
ll40ls <command> [arguments...]
Commands:
start Start driver
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
status Print driver status information
regdump
stop Stop driver
stop
status print status info
```
## mappydot
@ -342,7 +352,7 @@ Source: [drivers/distance_sensor/srf05](https://github.com/PX4/PX4-Autopilot/tre
The sensor/driver must be enabled using the parameter SENS_EN_HXSRX0X.
### Usage {#srf05_usage}
```

View File

@ -343,7 +343,7 @@ Source: [modules/internal_combustion_engine_control](https://github.com/PX4/PX4-
### Description
The module controls internal combustion engine (ICE) features including:
ignition (on/off), throttle and choke level, starter engine delay, and user request.
@ -377,18 +377,21 @@ The ICE is implemented with a (4) state machine:
![Architecture](../../assets/hardware/ice/ice_control_state_machine.png)
The state machine:
- Checks if [Rpm.msg](../msg_docs/Rpm.md) is updated to know if the engine is running
- Allows for user inputs from:
- AUX{N}
- Manual control AUX
- Arming state in [VehicleStatus.msg](../msg_docs/VehicleStatus.md)
- In the state "Stopped" the throttle is set to NAN, which by definition will set the
throttle output to the disarmed value configured for the specific output.
The module publishes [InternalCombustionEngineControl.msg](../msg_docs/InternalCombustionEngineControl.md).
The architecture is as shown below:
![Architecture](../../assets/hardware/ice/ice_control_diagram.png)
<a id="internal_combustion_engine_control_usage"></a>
### Usage {#internal_combustion_engine_control_usage}