mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-10-14 15:33:33 +08:00
Update meta docs (#24892)
* 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>
This commit is contained in:
Hamish Willee
co-authored by
PX4BuildBot
PX4BuildBot
parent
0b3fc0a62d
commit
54ddb14137
@@ -1,6 +1,9 @@
|
||||
# Modules Reference: Command
|
||||
|
||||
|
||||
|
||||
## actuator_test
|
||||
|
||||
Source: [systemcmds/actuator_test](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/actuator_test)
|
||||
|
||||
|
||||
@@ -8,8 +11,8 @@ Utility to test actuators.
|
||||
|
||||
WARNING: remove all props before using this command.
|
||||
|
||||
<a id="actuator_test_usage"></a>
|
||||
### Usage
|
||||
### Usage {#actuator_test_usage}
|
||||
|
||||
```
|
||||
actuator_test <command> [arguments...]
|
||||
Commands:
|
||||
@@ -27,12 +30,14 @@ actuator_test <command> [arguments...]
|
||||
|
||||
iterate-servos Iterate all servos deflecting one after the other
|
||||
```
|
||||
|
||||
## bl_update
|
||||
|
||||
Source: [systemcmds/bl_update](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/bl_update)
|
||||
|
||||
Utility to flash the bootloader from a file
|
||||
<a id="bl_update_usage"></a>
|
||||
### Usage
|
||||
### Usage {#bl_update_usage}
|
||||
|
||||
```
|
||||
bl_update [arguments...]
|
||||
setopt Set option bits to unlock the FLASH (only needed if in locked
|
||||
@@ -40,27 +45,33 @@ bl_update [arguments...]
|
||||
|
||||
<file> Bootloader bin file
|
||||
```
|
||||
|
||||
## bsondump
|
||||
|
||||
Source: [systemcmds/bsondump](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/bsondump)
|
||||
|
||||
Utility to read BSON from a file and print or output document size.
|
||||
<a id="bsondump_usage"></a>
|
||||
### Usage
|
||||
### Usage {#bsondump_usage}
|
||||
|
||||
```
|
||||
bsondump [arguments...]
|
||||
<file> The BSON file to decode and print.
|
||||
```
|
||||
|
||||
## dumpfile
|
||||
|
||||
Source: [systemcmds/dumpfile](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/dumpfile)
|
||||
|
||||
Dump file utility. Prints file size and contents in binary mode (don't replace LF with CR LF) to stdout.
|
||||
<a id="dumpfile_usage"></a>
|
||||
### Usage
|
||||
### Usage {#dumpfile_usage}
|
||||
|
||||
```
|
||||
dumpfile [arguments...]
|
||||
<file> File to dump
|
||||
```
|
||||
|
||||
## dyn
|
||||
|
||||
Source: [systemcmds/dyn](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/dyn)
|
||||
|
||||
|
||||
@@ -73,14 +84,16 @@ dyn ./hello.px4mod start
|
||||
```
|
||||
|
||||
|
||||
<a id="dyn_usage"></a>
|
||||
### Usage
|
||||
### Usage {#dyn_usage}
|
||||
|
||||
```
|
||||
dyn [arguments...]
|
||||
<file> File containing the module
|
||||
[arguments...] Arguments to the module
|
||||
```
|
||||
|
||||
## failure
|
||||
|
||||
Source: [systemcmds/failure](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/failure)
|
||||
|
||||
|
||||
@@ -95,8 +108,8 @@ Test the GPS failsafe by stopping GPS:
|
||||
|
||||
failure gps off
|
||||
|
||||
<a id="failure_usage"></a>
|
||||
### Usage
|
||||
### Usage {#failure_usage}
|
||||
|
||||
```
|
||||
failure [arguments...]
|
||||
help Show this help text
|
||||
@@ -107,7 +120,9 @@ failure [arguments...]
|
||||
[-i <val>] sensor instance (0=all)
|
||||
default: 0
|
||||
```
|
||||
|
||||
## gpio
|
||||
|
||||
Source: [systemcmds/gpio](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/gpio)
|
||||
|
||||
|
||||
@@ -136,8 +151,8 @@ gpio write /dev/gpio1 1
|
||||
```
|
||||
|
||||
|
||||
<a id="gpio_usage"></a>
|
||||
### Usage
|
||||
### Usage {#gpio_usage}
|
||||
|
||||
```
|
||||
gpio [arguments...]
|
||||
read
|
||||
@@ -151,15 +166,17 @@ gpio [arguments...]
|
||||
[PUSHPULL|OPENDRAIN] Pushpull/Opendrain
|
||||
[--force] Force (ignore board gpio list)
|
||||
```
|
||||
|
||||
## hardfault_log
|
||||
|
||||
Source: [systemcmds/hardfault_log](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/hardfault_log)
|
||||
|
||||
Hardfault utility
|
||||
|
||||
Used in startup scripts to handle hardfaults
|
||||
|
||||
<a id="hardfault_log_usage"></a>
|
||||
### Usage
|
||||
### Usage {#hardfault_log_usage}
|
||||
|
||||
```
|
||||
hardfault_log <command> [arguments...]
|
||||
Commands:
|
||||
@@ -180,27 +197,33 @@ hardfault_log <command> [arguments...]
|
||||
|
||||
reset Reset the reboot counter
|
||||
```
|
||||
|
||||
## hist
|
||||
|
||||
Source: [systemcmds/hist](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/hist)
|
||||
|
||||
Command-line tool to show the px4 message history. There are no arguments.
|
||||
<a id="hist_usage"></a>
|
||||
### Usage
|
||||
### Usage {#hist_usage}
|
||||
|
||||
```
|
||||
hist [arguments...]
|
||||
```
|
||||
|
||||
## i2cdetect
|
||||
|
||||
Source: [systemcmds/i2cdetect](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/i2cdetect)
|
||||
|
||||
Utility to scan for I2C devices on a particular bus.
|
||||
<a id="i2cdetect_usage"></a>
|
||||
### Usage
|
||||
### Usage {#i2cdetect_usage}
|
||||
|
||||
```
|
||||
i2cdetect [arguments...]
|
||||
[-b <val>] I2C bus
|
||||
default: 1
|
||||
```
|
||||
|
||||
## led_control
|
||||
|
||||
Source: [systemcmds/led_control](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/led_control)
|
||||
|
||||
|
||||
@@ -220,8 +243,8 @@ led_control blink -c blue -l 0 -n 5
|
||||
```
|
||||
|
||||
|
||||
<a id="led_control_usage"></a>
|
||||
### Usage
|
||||
### Usage {#led_control_usage}
|
||||
|
||||
```
|
||||
led_control <command> [arguments...]
|
||||
Commands:
|
||||
@@ -251,7 +274,9 @@ led_control <command> [arguments...]
|
||||
[-p <val>] Priority
|
||||
default: 2
|
||||
```
|
||||
|
||||
## listener
|
||||
|
||||
Source: [systemcmds/topic_listener](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/topic_listener)
|
||||
|
||||
|
||||
@@ -259,8 +284,8 @@ Utility to listen on uORB topics and print the data to the console.
|
||||
|
||||
The listener can be exited any time by pressing Ctrl+C, Esc, or Q.
|
||||
|
||||
<a id="listener_usage"></a>
|
||||
### Usage
|
||||
### Usage {#listener_usage}
|
||||
|
||||
```
|
||||
listener <command> [arguments...]
|
||||
Commands:
|
||||
@@ -272,23 +297,27 @@ listener <command> [arguments...]
|
||||
[-r <val>] Subscription rate (unlimited if 0)
|
||||
default: 0
|
||||
```
|
||||
|
||||
## mfd
|
||||
|
||||
Source: [systemcmds/mft](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/mft)
|
||||
|
||||
Utility interact with the manifest
|
||||
<a id="mfd_usage"></a>
|
||||
### Usage
|
||||
### Usage {#mfd_usage}
|
||||
|
||||
```
|
||||
mfd <command> [arguments...]
|
||||
Commands:
|
||||
query Returns true if not existed
|
||||
```
|
||||
|
||||
## mft_cfg
|
||||
|
||||
Source: [systemcmds/mft_cfg](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/mft_cfg)
|
||||
|
||||
Tool to set and get manifest configuration
|
||||
<a id="mft_cfg_usage"></a>
|
||||
### Usage
|
||||
### Usage {#mft_cfg_usage}
|
||||
|
||||
```
|
||||
mft_cfg <command> [arguments...]
|
||||
Commands:
|
||||
@@ -301,12 +330,14 @@ mft_cfg <command> [arguments...]
|
||||
-i <val> argument to set extended hardware id (id == version for
|
||||
<hwver>, id == revision for <hwrev> )
|
||||
```
|
||||
|
||||
## mtd
|
||||
|
||||
Source: [systemcmds/mtd](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/mtd)
|
||||
|
||||
Utility to mount and test partitions (based on FRAM/EEPROM storage as defined by the board)
|
||||
<a id="mtd_usage"></a>
|
||||
### Usage
|
||||
### Usage {#mtd_usage}
|
||||
|
||||
```
|
||||
mtd <command> [arguments...]
|
||||
Commands:
|
||||
@@ -326,7 +357,9 @@ mtd <command> [arguments...]
|
||||
[<partition_name1> [<partition_name2> ...]] Partition names (eg.
|
||||
/fs/mtd_params), use system default if not provided
|
||||
```
|
||||
|
||||
## nshterm
|
||||
|
||||
Source: [systemcmds/nshterm](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/nshterm)
|
||||
|
||||
Start an NSH shell on a given port.
|
||||
@@ -334,13 +367,15 @@ Start an NSH shell on a given port.
|
||||
This was previously used to start a shell on the USB serial port.
|
||||
Now there runs mavlink, and it is possible to use a shell over mavlink.
|
||||
|
||||
<a id="nshterm_usage"></a>
|
||||
### Usage
|
||||
### Usage {#nshterm_usage}
|
||||
|
||||
```
|
||||
nshterm [arguments...]
|
||||
<file:dev> Device on which to start the shell (eg. /dev/ttyACM0)
|
||||
```
|
||||
|
||||
## param
|
||||
|
||||
Source: [systemcmds/param](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/param)
|
||||
|
||||
|
||||
@@ -368,8 +403,8 @@ param set SYS_AUTOCONFIG 1
|
||||
reboot
|
||||
```
|
||||
|
||||
<a id="param_usage"></a>
|
||||
### Usage
|
||||
### Usage {#param_usage}
|
||||
|
||||
```
|
||||
param <command> [arguments...]
|
||||
Commands:
|
||||
@@ -436,7 +471,9 @@ param <command> [arguments...]
|
||||
find Show index of a param
|
||||
<param> param name
|
||||
```
|
||||
|
||||
## payload_deliverer
|
||||
|
||||
Source: [modules/payload_deliverer](https://github.com/PX4/PX4-Autopilot/tree/main/src/modules/payload_deliverer)
|
||||
|
||||
|
||||
@@ -445,8 +482,8 @@ Handles payload delivery with either Gripper or a Winch with an appropriate time
|
||||
and communicates back the delivery result as an acknowledgement internally
|
||||
|
||||
|
||||
<a id="payload_deliverer_usage"></a>
|
||||
### Usage
|
||||
### Usage {#payload_deliverer_usage}
|
||||
|
||||
```
|
||||
payload_deliverer <command> [arguments...]
|
||||
Commands:
|
||||
@@ -462,12 +499,14 @@ payload_deliverer <command> [arguments...]
|
||||
|
||||
status print status info
|
||||
```
|
||||
|
||||
## perf
|
||||
|
||||
Source: [systemcmds/perf](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/perf)
|
||||
|
||||
Tool to print performance counters
|
||||
<a id="perf_usage"></a>
|
||||
### Usage
|
||||
### Usage {#perf_usage}
|
||||
|
||||
```
|
||||
perf [arguments...]
|
||||
reset Reset all counters
|
||||
@@ -476,24 +515,28 @@ perf [arguments...]
|
||||
|
||||
Prints all performance counters if no arguments given
|
||||
```
|
||||
|
||||
## reboot
|
||||
|
||||
Source: [systemcmds/reboot](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/reboot)
|
||||
|
||||
Reboot the system
|
||||
<a id="reboot_usage"></a>
|
||||
### Usage
|
||||
### Usage {#reboot_usage}
|
||||
|
||||
```
|
||||
reboot [arguments...]
|
||||
[-b] Reboot into bootloader
|
||||
[-i] Reboot into ISP (1st stage bootloader)
|
||||
[lock|unlock] Take/release the shutdown lock (for testing)
|
||||
```
|
||||
|
||||
## sd_bench
|
||||
|
||||
Source: [systemcmds/sd_bench](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/sd_bench)
|
||||
|
||||
Test the speed of an SD Card
|
||||
<a id="sd_bench_usage"></a>
|
||||
### Usage
|
||||
### Usage {#sd_bench_usage}
|
||||
|
||||
```
|
||||
sd_bench [arguments...]
|
||||
[-b <val>] Block size for each read/write
|
||||
@@ -508,12 +551,14 @@ sd_bench [arguments...]
|
||||
[-U] Test performance with forced byte unaligned data
|
||||
[-v] Verify data and block number
|
||||
```
|
||||
|
||||
## sd_stress
|
||||
|
||||
Source: [systemcmds/sd_stress](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/sd_stress)
|
||||
|
||||
Test operations on an SD Card
|
||||
<a id="sd_stress_usage"></a>
|
||||
### Usage
|
||||
### Usage {#sd_stress_usage}
|
||||
|
||||
```
|
||||
sd_stress [arguments...]
|
||||
[-r <val>] Number of runs
|
||||
@@ -521,15 +566,17 @@ sd_stress [arguments...]
|
||||
[-b <val>] Number of bytes
|
||||
default: 100
|
||||
```
|
||||
|
||||
## serial_passthru
|
||||
|
||||
Source: [systemcmds/serial_passthru](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/serial_passthru)
|
||||
|
||||
Pass data from one device to another.
|
||||
|
||||
This can be used to use u-center connected to USB with a GPS on a serial port.
|
||||
|
||||
<a id="serial_passthru_usage"></a>
|
||||
### Usage
|
||||
### Usage {#serial_passthru_usage}
|
||||
|
||||
```
|
||||
serial_passthru [arguments...]
|
||||
-e <val> External device path
|
||||
@@ -540,7 +587,9 @@ serial_passthru [arguments...]
|
||||
default: 115200
|
||||
[-t] Track the External devices baudrate on internal device
|
||||
```
|
||||
|
||||
## system_time
|
||||
|
||||
Source: [systemcmds/system_time](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/system_time)
|
||||
|
||||
|
||||
@@ -556,8 +605,8 @@ system_time set 1600775044
|
||||
system_time get
|
||||
```
|
||||
|
||||
<a id="system_time_usage"></a>
|
||||
### Usage
|
||||
### Usage {#system_time_usage}
|
||||
|
||||
```
|
||||
system_time <command> [arguments...]
|
||||
Commands:
|
||||
@@ -565,32 +614,38 @@ system_time <command> [arguments...]
|
||||
|
||||
get Get the system time
|
||||
```
|
||||
|
||||
## top
|
||||
|
||||
Source: [systemcmds/top](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/top)
|
||||
|
||||
Monitor running processes and their CPU, stack usage, priority and state
|
||||
<a id="top_usage"></a>
|
||||
### Usage
|
||||
### Usage {#top_usage}
|
||||
|
||||
```
|
||||
top [arguments...]
|
||||
once print load only once
|
||||
```
|
||||
|
||||
## usb_connected
|
||||
|
||||
Source: [systemcmds/usb_connected](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/usb_connected)
|
||||
|
||||
Utility to check if USB is connected. Was previously used in startup scripts.
|
||||
A return value of 0 means USB is connected, 1 otherwise.
|
||||
<a id="usb_connected_usage"></a>
|
||||
### Usage
|
||||
### Usage {#usb_connected_usage}
|
||||
|
||||
```
|
||||
usb_connected [arguments...]
|
||||
```
|
||||
|
||||
## ver
|
||||
|
||||
Source: [systemcmds/ver](https://github.com/PX4/PX4-Autopilot/tree/main/src/systemcmds/ver)
|
||||
|
||||
Tool to print various version information
|
||||
<a id="ver_usage"></a>
|
||||
### Usage
|
||||
### Usage {#ver_usage}
|
||||
|
||||
```
|
||||
ver <command> [arguments...]
|
||||
Commands:
|
||||
|
||||
Reference in New Issue
Block a user