mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-11-22 14:19:57 +08:00
Only modules_main.md told readers that the module reference is generated from source. The per-category pages (modules_driver.md, modules_system.md, ...) and the per-subcategory pages (modules_driver_imu.md, ...) had no such note, so contributors kept fixing typos directly in docs/en/modules/ and the next metadata sync silently reverted them (see #29614). Emit a `::: info` block right under the H1 of every category and subcategory page. The wording follows the existing disclaimers on the airframe reference and the uORB message index: it links to the generator script and names the `make module_documentation` target. docs/en/modules/*.md are regenerated with the updated generator and run through Prettier, mirroring what the docs-orchestrator metadata sync does on main, so the diff is only the new note. Fixes #29624 Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Alex E <aelejandro9@gmail.com>
46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
# Modules Reference: Optical Flow (Driver)
|
|
|
|
::: info
|
|
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
|
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
|
:::
|
|
|
|
## thoneflow
|
|
|
|
Source: [drivers/optical_flow/thoneflow](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/optical_flow/thoneflow)
|
|
|
|
### Description
|
|
|
|
Serial bus driver for the ThoneFlow-3901U optical flow sensor.
|
|
|
|
Most boards are configured to enable/start the driver on a specified UART using the SENS_TFLOW_CFG parameter.
|
|
|
|
Setup/usage information: https://docs.px4.io/main/en/sensor/pmw3901.html#thone-thoneflow-3901u
|
|
|
|
### Examples
|
|
|
|
Attempt to start driver on a specified serial device.
|
|
|
|
```
|
|
thoneflow start -d /dev/ttyS1
|
|
```
|
|
|
|
Stop driver
|
|
|
|
```
|
|
thoneflow stop
|
|
```
|
|
|
|
### Usage {#thoneflow_usage}
|
|
|
|
```
|
|
thoneflow <command> [arguments...]
|
|
Commands:
|
|
start Start driver
|
|
-d <val> Serial device
|
|
|
|
stop Stop driver
|
|
|
|
info Print driver information
|
|
```
|