mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-04-14 10:07:39 +08:00
54ddb14137
* 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>
60 lines
1.1 KiB
Markdown
60 lines
1.1 KiB
Markdown
# Modules Reference: Template
|
|
|
|
|
|
|
|
## 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
|
|
```
|