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>
95 lines
2.0 KiB
Markdown
95 lines
2.0 KiB
Markdown
# Modules Reference: Template
|
|
|
|
::: 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.
|
|
:::
|
|
|
|
## mc_raptor
|
|
|
|
Source: [modules/mc_raptor](https://github.com/PX4/PX4-Autopilot/tree/main/src/modules/mc_raptor)
|
|
|
|
### Description
|
|
|
|
RAPTOR Policy Flight Mode
|
|
|
|
### Usage {#mc_raptor_usage}
|
|
|
|
```
|
|
mc_raptor <command> [arguments...]
|
|
Commands:
|
|
start
|
|
|
|
intref Modify internal reference
|
|
lissajous Set Lissajous trajectory parameters
|
|
<A> Amplitude X [m]
|
|
<B> Amplitude Y [m]
|
|
<C> Amplitude Z [m]
|
|
<fa> Frequency a
|
|
<fb> Frequency b
|
|
<fc> Frequency c
|
|
<duration> Total duration [s]
|
|
<ramp> Ramp duration [s]
|
|
|
|
stop
|
|
|
|
status print status info
|
|
```
|
|
|
|
## module
|
|
|
|
Source: [templates/template_module](https://github.com/PX4/PX4-Autopilot/tree/main/src/templates/template_module)
|
|
|
|
### Description
|
|
|
|
Section that describes the provided module functionality.
|
|
|
|
This is a template for a module running as a task in the background with start/stop/status functionality.
|
|
|
|
### Implementation
|
|
|
|
Section describing the high-level implementation of this module.
|
|
|
|
### Examples
|
|
|
|
CLI usage example:
|
|
|
|
```
|
|
module start -f -p 42
|
|
```
|
|
|
|
### Usage {#module_usage}
|
|
|
|
```
|
|
module <command> [arguments...]
|
|
Commands:
|
|
start
|
|
[-f] Optional example flag
|
|
[-p <val>] Optional example parameter
|
|
default: 0
|
|
|
|
stop
|
|
|
|
status print status info
|
|
```
|
|
|
|
## work_item_example
|
|
|
|
Source: [examples/work_item](https://github.com/PX4/PX4-Autopilot/tree/main/src/examples/work_item)
|
|
|
|
### Description
|
|
|
|
Example of a simple module running out of a work queue.
|
|
|
|
### Usage {#work_item_example_usage}
|
|
|
|
```
|
|
work_item_example <command> [arguments...]
|
|
Commands:
|
|
start
|
|
|
|
stop
|
|
|
|
status print status info
|
|
```
|