Modules Reference: Command
actuator_test
Source: systemcmds/actuator_test
Утиліта для тестування актуаторів.
ПОПЕРЕДЖЕННЯ: перед використанням цієї команди приберіть усі пропелери.
Використання
actuator_test <command> [arguments...]
Commands:
set Set an actuator to a specific output value
The actuator can be specified by motor, servo or function directly:
[-m <val>] Motor to test (1...8)
[-s <val>] Servo to test (1...8)
[-f <val>] Specify function directly
-v <val> value (-1...1)
[-t <val>] Timeout in seconds (run interactive if not set)
default: 0
iterate-motors Iterate all motors starting and stopping one after the other
iterate-servos Iterate all servos deflecting one after the other
bl_update
Source: systemcmds/bl_update
Utility to flash the bootloader from a file
Використання
bl_update [arguments...]
setopt Set option bits to unlock the FLASH (only needed if in locked
state)
<file> Bootloader bin file
bsondump
Source: systemcmds/bsondump
Utility to read BSON from a file and print or output document size.
Використання
bsondump [arguments...]
<file> The BSON file to decode and print.
dumpfile
Source: systemcmds/dumpfile
Утиліта для роботи з файлами дампу. Виводить розмір та вміст файлу у бінарному режимі (не замінюйте LF на CR LF) до stdout.
Використання
dumpfile [arguments...]
<file> File to dump
dyn
Source: systemcmds/dyn
Опис
Завантажує та запускає динамічний модуль PX4, який не було скомпільовано у бінарний файл PX4.
Приклад
dyn ./hello.px4mod start
Використання
dyn [arguments...]
<file> File containing the module
[arguments...] Arguments to the module
failure
Source: systemcmds/failure
Опис
Впроваджує збої в систему.
Імплементація
Ця системна команда надсилає транспортному засобу команду через uORB, щоб спровокувати збій.
Приклади
Перевірити failsafe GPS, зупинивши GPS:
failure gps off
Використання
failure [arguments...]
help Show this help text
gps|... Specify component
ok|off|... Specify failure type
[-i <val>] sensor instance (0=all)
default: 0
gpio
Source: systemcmds/gpio
Опис
Ця команда використовується для читання та запису GPIO
gpio read <PORT><PIN>/<DEVICE> [PULLDOWN|PULLUP] [--force]
gpio write <PORT><PIN>/<DEVICE> <VALUE> [PUSHPULL|OPENDRAIN] [--force]
Приклади
Зчитати значення на port H pin 4 налаштований як імпульс, і це високо
gpio read H4 PULLUP
1 OK
Встановіть вихідне значення на виводі порту E на високий рівень
gpio write E7 1 --force
Встановіть вихідне значення на пристрої /dev/gpio1 на високе значення
gpio write /dev/gpio1 1
Використання
gpio [arguments...]
read
<PORT><PIN>/<DEVICE> GPIO port and pin or device
[PULLDOWN|PULLUP] Pulldown/Pullup
[--force] Force (ignore board gpio list)
write
<PORT> <PIN> GPIO port and pin
<VALUE> Value to write
[PUSHPULL|OPENDRAIN] Pushpull/Opendrain
[--force] Force (ignore board gpio list)
hardfault_log
Source: systemcmds/hardfault_log
Утиліта апаратного збою
Використовується у сценаріях запуску для обробки апаратних збоїв
Використання
hardfault_log <command> [arguments...]
Commands:
check Check if there's an uncommitted hardfault
rearm Drop an uncommitted hardfault
fault Generate a hardfault (this command crashes the system :)
[0|1|2|3] Hardfault type: 0=divide by 0, 1=Assertion, 2=jump to 0x0,
3=write to 0x0 (default=0)
commit Write uncommitted hardfault to /fs/microsd/fault_%i.txt (and
rearm, but don't reset)
count Read the reboot counter, counts the number of reboots of an
uncommitted hardfault (returned as the exit code of the
program)
reset Reset the reboot counter
hist
Source: systemcmds/hist
Інструмент командного рядка для відображення історії повідомлень px4. Немає аргументів.
Використання
hist [arguments...]
i2cdetect
Source: systemcmds/i2cdetect
Utility to scan for I2C devices on a particular bus.
Використання
i2cdetect [arguments...]
[-b <val>] I2C bus
default: 1
led_control
Source: systemcmds/led_control
Опис
Command-line tool to control & test the (external) LED's.
Щоб скористатися ним, переконайтеся, що запущено драйвер, який обробляє тему led_control uorb.
Існують різні пріоритети, наприклад, один модуль може встановити колір з низьким пріоритетом, а інший модуль може блимати N разів з високим пріоритетом, і світлодіоди автоматично повертаються до стану з низьким пріоритетом після блимання. The reset
command can also be used to return to a lower priority.
Приклади
Блимання першого світлодіода 5 разів синім кольором:
led_control blink -c blue -l 0 -n 5
Використання
led_control <command> [arguments...]
Commands:
test Run a test pattern
on Turn LED on
off Turn LED off
reset Reset LED priority
blink Blink LED N times
[-n <val>] Number of blinks
default: 3
[-s <val>] Set blinking speed
values: fast|normal|slow, default: normal
breathe Continuously fade LED in & out
flash Two fast blinks and then off with frequency of 1Hz
The following arguments apply to all of the above commands except for 'test':
[-c <val>] color
values: red|blue|green|yellow|purple|amber|cyan|white, default:
white
[-l <val>] Which LED to control: 0, 1, 2, ... (default=all)
[-p <val>] Priority
default: 2
listener
Source: systemcmds/topic_listener
Утиліта для прослуховування тем uORB та виводу даних у консоль.
Із прослуховування можна вийти в будь-який момент, натиснувши Ctrl+C, Esc або Q.
Використання
listener <command> [arguments...]
Commands:
<topic_name> uORB topic name
[-i <val>] Topic instance
default: 0
[-n <val>] Number of messages
default: 1
[-r <val>] Subscription rate (unlimited if 0)
default: 0
mfd
Source: systemcmds/mft
Utility interact with the manifest
Використання
mfd <command> [arguments...]
Commands:
query Returns true if not existed
mtd
Source: systemcmds/mtd
Utility to mount and test partitions (based on FRAM/EEPROM storage as defined by the board)
Використання
mtd <command> [arguments...]
Commands:
status Print status information
readtest Perform read test
rwtest Perform read-write test
erase Erase partition(s)
The commands 'readtest' and 'rwtest' have an optional instance index:
[-i <val>] storage index (if the board has multiple storages)
default: 0
The commands 'readtest', 'rwtest' and 'erase' have an optional parameter:
[<partition_name1> [<partition_name2> ...]] Partition names (eg.
/fs/mtd_params), use system default if not provided
nshterm
Source: systemcmds/nshterm
Запуск оболонки NSH на заданому порту.
Раніше це використовувалося для запуску оболонки на послідовному порту USB. Тепер там працює mavlink, і можна використовувати оболонку поверх mavlink.
Використання
nshterm [arguments...]
<file:dev> Device on which to start the shell (eg. /dev/ttyACM0)
param
Source: systemcmds/param
Опис
Команда для доступу до параметрів і маніпулювання ними через оболонку або скрипт.
Це використовується, наприклад, у сценарії запуску для встановлення специфічних для планера параметрів.
Parameters are automatically saved when changed, eg. with param set
. Зазвичай вони зберігаються на FRAM або на SD-карту. param select
can be used to change the storage location for subsequent saves (this will need to be (re-)configured on every boot).
If the FLASH-based backend is enabled (which is done at compile time, e.g. for the Intel Aero or Omnibus), param select
has no effect and the default is always the FLASH backend. However param save/load <file>
can still be used to write to/read from files.
Кожен параметр має прапорець «використано», який встановлюється при його зчитуванні під час завантаження. Він використовується для відображення лише релевантних параметрів на наземну станцію керування.
Приклади
Змініть планер і переконайтеся, що завантажені параметри планера за замовчуванням:
param set SYS_AUTOSTART 4001
param set SYS_AUTOCONFIG 1
reboot
Використання
param <command> [arguments...]
Commands:
load Load params from a file (overwrite all)
[<file>] File name (use default if not given)
import Import params from a file
[<file>] File name (use default if not given)
save Save params to a file
[<file>] File name (use default if not given)
select Select default file
[<file>] File name
select-backup Select default file
[<file>] File name
show Show parameter values
[-a] Show all parameters (not just used)
[-c] Show only changed params (unused too)
[-q] quiet mode, print only param value (name needs to be exact)
[<filter>] Filter by param name (wildcard at end allowed, eg. sys_*)
show-for-airframe Show changed params for airframe config
status Print status of parameter system
set Set parameter to a value
<param_name> <value> Parameter name and value to set
[fail] If provided, let the command fail if param is not found
set-default Set parameter default to a value
[-s] If provided, silent errors if parameter doesn't exists
<param_name> <value> Parameter name and value to set
[fail] If provided, let the command fail if param is not found
compare Compare a param with a value. Command will succeed if equal
[-s] If provided, silent errors if parameter doesn't exists
<param_name> <value> Parameter name and value to compare
greater Compare a param with a value. Command will succeed if param is
greater than the value
[-s] If provided, silent errors if parameter doesn't exists
<param_name> <value> Parameter name and value to compare
<param_name> <value> Parameter name and value to compare
touch Mark a parameter as used
[<param_name1> [<param_name2>]] Parameter name (one or more)
reset Reset only specified params to default
[<param1> [<param2>]] Parameter names to reset (wildcard at end allowed)
reset_all Reset all params to default
[<exclude1> [<exclude2>]] Do not reset matching params (wildcard at end
allowed)
index Show param for a given index
<index> Index: an integer >= 0
index_used Show used param for a given index
<index> Index: an integer >= 0
find Show index of a param
<param> param name
payload_deliverer
Source: modules/payload_deliverer
Опис
Керує доставкою вантажу за допомогою захвату або лебідки з відповідним налаштуванням тайм-ауту / датчиком зворотнього зв'язку, та повертає результат доставки як підтвердження внутрішньо
Використання
payload_deliverer <command> [arguments...]
Commands:
start
gripper_test Tests the Gripper's release & grabbing sequence
gripper_open Opens the gripper
gripper_close Closes the gripper
stop
status print status info
perf
Source: systemcmds/perf
Tool to print performance counters
Використання
perf [arguments...]
reset Reset all counters
latency Print HRT timer latency histogram
Prints all performance counters if no arguments given
reboot
Source: systemcmds/reboot
Використання
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
Використання
sd_bench [arguments...]
[-b <val>] Block size for each read/write
default: 4096
[-r <val>] Number of runs
default: 5
[-d <val>] Duration of a run in ms
default: 2000
[-k] Keep the test file
[-s] Call fsync after each block (default=at end of each run)
[-u] Test performance with unaligned data
[-U] Test performance with forced byte unaligned data
[-v] Verify data and block number
sd_stress
Source: systemcmds/sd_stress
Використання
sd_stress [arguments...]
[-r <val>] Number of runs
default: 5
[-b <val>] Number of bytes
default: 100
serial_passthru
Source: systemcmds/serial_passthru
Передає дані з одного пристрою на інший.
Це може бути використано для використання u-center, підключеного до USB з GPS через послідовний порт.
Використання
serial_passthru [arguments...]
-e <val> External device path
values: <file:dev>
-d <val> Internal device path
values: <file:dev>
[-b <val>] Baudrate
default: 115200
[-t] Track the External devices baudrate on internal device
system_time
Source: systemcmds/system_time
Опис
Інструмент командного рядка для встановлення та отримання системного часу.
Приклади
Встановіть системний час і прочитайте його назад
system_time set 1600775044
system_time get
Використання
system_time <command> [arguments...]
Commands:
set Set the system time, provide time in unix epoch time format
get Get the system time
top
Source: systemcmds/top
Monitor running processes and their CPU, stack usage, priority and state
Використання
top [arguments...]
once print load only once
usb_connected
Source: systemcmds/usb_connected
Утиліта для перевірки підключення USB. Раніше використовувався в стартових скриптах. Значення 0 означає, що USB підключено, 1 - ні.
Використання
usb_connected [arguments...]
ver
Source: systemcmds/ver
Tool to print various version information
Використання
ver <command> [arguments...]
Commands:
hw Hardware architecture
mcu MCU info
git git version information
bdate Build date and time
gcc Compiler info
bdate Build date and time
px4guid PX4 GUID
uri Build URI
all Print all versions
hwcmp Compare hardware version (returns 0 on match)
<hw> [<hw2>] Hardware to compare against (eg. PX4_FMU_V4). An OR comparison
is used if multiple are specified
hwtypecmp Compare hardware type (returns 0 on match)
<hwtype> [<hwtype2>] Hardware type to compare against (eg. V2). An OR
comparison is used if multiple are specified
hwbasecmp Compare hardware base (returns 0 on match)
<hwbase> [<hwbase2>] Hardware type to compare against (eg. V2). An OR
comparison is used if multiple are specified