mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-04-14 10:07:39 +08:00
88d623bedb
* Add vitepress tree * Update existing workflows so they dont trigger on changes in the docs path * Add nojekyll, package.json, LICENCE etc * Add crowdin docs upload/download scripts * Add docs flaw checker workflows * Used docs prefix for docs workflows * Crowdin obvious fixes * ci: docs move to self hosted runner runs on a beefy server for faster builds Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: don't run build action for docs or ci changes Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: update runners Signed-off-by: Ramon Roche <mrpollo@gmail.com> * Add docs/en * Add docs assets and scripts * Fix up editlinks to point to PX4 sources * Download just the translations that are supported * Add translation sources for zh, uk, ko * Update latest tranlsation and uorb graphs * update vitepress to latest --------- Signed-off-by: Ramon Roche <mrpollo@gmail.com> Co-authored-by: Ramon Roche <mrpollo@gmail.com>
55 lines
1.1 KiB
Markdown
55 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
|
|
```
|
|
|
|
|
|
<a id="module_usage"></a>
|
|
### 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.
|
|
|
|
|
|
<a id="work_item_example_usage"></a>
|
|
### Usage
|
|
```
|
|
work_item_example <command> [arguments...]
|
|
Commands:
|
|
start
|
|
|
|
stop
|
|
|
|
status print status info
|
|
```
|