Skip to content

Modules Reference: System ​

battery_simulator ​

Джерело: modules/simulation/battery_simulator

Опис ​

Використання ​

battery_simulator <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

battery_status ​

Джерело: modules/battery_status

Опис ​

Надана функціональність включає в себе:

  • Читання вихідних даних драйвера ADC (через інтерфейс ioctl) і публікація battery_status.

Імплементація ​

Він запускається у власній темі і проводить опитування на поточну обрану тему гіроскопа.

Використання ​

battery_status <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

camera_feedback ​

Джерело: modules/camera_feedback

Опис ​

The camera_feedback module publishes CameraCapture UORB topics when image capture has been triggered.

If camera capture is enabled, then trigger information from the camera capture pin is published; otherwise trigger information at the point the camera was commanded to trigger is published (from the camera_trigger module).

The CAMERA_IMAGE_CAPTURED message is then emitted (by streaming code) following CameraCapture updates. CameraCapture topics are also logged and can be used for geotagging.

Імплементація ​

CameraTrigger topics are published by the camera_trigger module (feedback field set false) when image capture is triggered, and may also be published by the camera_capture driver (with feedback field set true) if the camera capture pin is activated.

The camera_feedback module subscribes to CameraTrigger. It discards topics from the camera_trigger module if camera capture is enabled. For the topics that are not discarded it creates a CameraCapture topic with the timestamp information from the CameraTrigger and position information from the vehicle.

Використання ​

camera_feedback <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

cdcacm_autostart ​

Джерело: drivers/cdcacm_autostart

Опис ​

Цей модуль прослуховує USB і автоматично налаштовує протокол в залежності від отриманих байтів. Підтримувані протоколи: MAVLink, nsh та ublox послідовний прохід. Якщо параметр SYS_USB_AUTO=2 модуль буде намагатися запустити mavlink лише тоді, коли буде виявлено USB VBUS. В іншому випадку він буде обертатися і продовжувати перевіряти VBUS та запускати mavlink, як тільки він виявиться.

Використання ​

cdcacm_autostart <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

commander ​

Джерело: modules/commander

Опис ​

Модуль командира містить машину станів для перемикання режимів та аварійної поведінки.

Використання ​

commander <command> [arguments...]
 Commands:
   start
     [-h]        Enable HIL mode

   calibrate     Run sensor calibration
     mag|baro|accel|gyro|level|esc|airspeed Calibration type
     quick       Quick calibration (accel only, not recommended)

   check         Run preflight checks

   arm
     [-f]        Force arming (do not run preflight checks)

   disarm
     [-f]        Force disarming (disarm in air)

   takeoff

   land

   transition    VTOL transition

   mode          Change flight mode
     manual|acro|offboard|stabilized|altctl|posctl|position:slow|auto:mission|au
                 to:loiter|auto:rtl|auto:takeoff|auto:land|auto:precland|ext1
                 Flight mode

   pair

   lockdown
     on|off      Turn lockdown on or off

   set_ekf_origin
     lat, lon, alt Origin Latitude, Longitude, Altitude

   lat|lon|alt   Origin latitude longitude altitude

   poweroff      Power off board (if supported)

   stop

   status        print status info

dataman ​

Джерело: modules/dataman

Опис ​

Модуль для забезпечення постійного сховища для решти системи у вигляді простої бази даних через C API. Підтримується декілька бекендів:

  • файл (наприклад, на SD-карті)
  • Оперативна пам'ять (очевидно, що вона не є постійною)

Використовується для зберігання структурованих даних різних типів: маршрутні точки місії, стан місії та полігони геозони. Кожен тип має певний тип і фіксовану максимальну кількість елементів зберігання, щоб забезпечити швидкий випадковий доступ.

Реалізація ​

Читання і запис одного елемента завжди атомарні.

Використання ​

dataman <command> [arguments...]
 Commands:
   start
     [-f <val>]  Storage file
                 values: <file>
     [-r]        Use RAM backend (NOT persistent)

 The options -f and -r are mutually exclusive. If nothing is specified, a file
 'dataman' is used

   stop

   status        print status info

dmesg ​

Джерело: systemcmds/dmesg

Опис ​

Інструмент командного рядка для показу повідомлень консолі завантаження. Зауважте, що вивід з робочих черг NuttX та syslog не перехоплюється.

Приклади ​

Продовжує друкувати всі повідомлення у фоновому режимі:

dmesg -f &

Використання ​

dmesg <command> [arguments...]
 Commands:
     [-f]        Follow: wait for new messages

esc_battery ​

Джерело: modules/esc_battery

Опис ​

Це реалізує використання інформації зі статусу ESC і публікує її як стан батареї.

Використання ​

esc_battery <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

gyro_calibration ​

Джерело: modules/gyro_calibration

Опис ​

Просте онлайн-калібрування гіроскопа.

Використання ​

gyro_calibration <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

gyro_fft ​

Джерело: modules/gyro_fft

Опис ​

Використання ​

gyro_fft <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

heater ​

Джерело: drivers/heater

Опис ​

Фоновий процес, що періодично запускається в робочій черзі LP для регулювання температури IMU на заданому рівні.

Це завдання можна запустити під час завантаження зі скриптів запуску, встановивши SENS_EN_THERMAL, або через CLI.

Використання ​

heater <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

i2c_launcher ​

Джерело: systemcmds/i2c_launcher

Опис ​

Демон, який запускає драйвери на основі виявлених пристроїв I2C.

Використання ​

i2c_launcher <command> [arguments...]
 Commands:
   start
     -b <val>    Bus number

   stop

   status        print status info

land_detector ​

Джерело: modules/land_detector

Опис ​

Модуль для визначення стану вільного падіння та приземлення транспортного засобу, а також публікації теми vehicle_land_detected. Для кожного типу літального апарату (мультиротор, фіксоване крило, гвинтокрил, ...) передбачено власний алгоритм, що враховує різні стани, такі як задана тяга, стан озброєння та рух апарату.

Імплементація ​

Кожен тип реалізовано у власному класі зі спільним базовим класом. Базовий клас підтримує стан (landed, maybe_landed, ground_contact). Кожен можливий стан реалізується в похідних класах. Гістерезис та фіксований пріоритет кожного внутрішнього стану визначає фактичний стан land_detector.

Мультикоптер Land Detector ​

ground_contact: задане значення тяги та швидкість у напрямку z повинні бути нижче визначеного порогу протягом певного часу GROUND_CONTACT_TRIGGER_TIME_US. При виявленні контакту з землею регулятор положення вимикає задане значення тяги у тілі x та y.

maybe_landed: він вимагає контакту з землею разом з більш жорстким порогом заданого значення тяги і відсутності швидкості в горизонтальному напрямку. Час спрацьовування визначається параметром MAYBE_LAND_TRIGGER_TIME. Коли виявляється maybe_landed, контролер положення встановлює задане значення тяги на нуль.

landed: він вимагає, щоб maybe_landed було true для часу LAND_DETECTOR_TRIGGER_TIME_US.

Модуль періодично запускається у черзі робіт HP.

Використання ​

land_detector <command> [arguments...]
 Commands:
   start         Start the background task
     fixedwing|multicopter|vtol|rover|airship Select vehicle type

   stop

   status        print status info

load_mon ​

Джерело: modules/load_mon

Опис ​

Фоновий процес, що періодично запускається у низькопріоритетній робочій черзі для підрахунку завантаження процесора та оперативної пам'яті і публікувати тему cpuload.

У NuttX він також перевіряє використання стеку кожним процесом, і якщо воно падає нижче 300 байт, виводиться попередження, яке також буде показано у файлі логу.

Використання ​

load_mon <command> [arguments...]
 Commands:
   start         Start the background task

   stop

   status        print status info

logger ​

Джерело: modules/logger

Опис ​

Системний логгер, який реєструє конфігурований набір тем uORB та системних повідомлень printf (PX4_WARN і PX4_ERR) до файлів ULog. Вони можуть бути використані для оцінки продуктивності системи та польоту, налаштування, відтворення та аналізу збоїв.

Він підтримує 2 бекенди:

  • Файли: запис файлів ULog до файлової системи (SD-карта)
  • MAVLink: передача даних ULog через MAVLink клієнту (клієнт повинен це підтримувати)

Обидва бекенди можуть бути активовані та використовуватися одночасно.

Файловий бекенд підтримує 2 типи логів: повний (звичайний лог) і журнал місій. Журнал місії - це скорочений файл ulog, який можна використовувати, наприклад, для географічних міток або управління транспортним засобом. Його можна увімкнути та налаштувати за допомогою параметра SDLOG_MISSION. Звичайний журнал завжди є підмножиною журналу місій.

Реалізація ​

Реалізація використовує два потоки:

  • Основний потік, що працює з фіксованою швидкістю (або опитування на тему, якщо запущено з -p) і перевіряє оновлення даних
  • Потік запису, що записує дані у файл

Між ними знаходиться буфер запису з конфігурованим розміром (і ще один буфер фіксованого розміру для журналу місій). Він повинен бути великим, щоб уникнути втрати даних.

Приклади ​

Типове використання для початку ведення журналу негайно:

logger start -e -t

Або якщо вже працює:

logger on

Використання ​

logger <command> [arguments...]
 Commands:
   start
     [-m <val>]  Backend mode
                 values: file|mavlink|all, default: all
     [-x]        Enable/disable logging via Aux1 RC channel
     [-a]        Log 1st armed until shutdown
     [-e]        Enable logging right after start until disarm (otherwise only
                 when armed)
     [-f]        Log until shutdown (implies -e)
     [-t]        Use date/time for naming log directories and files
     [-r <val>]  Log rate in Hz, 0 means unlimited rate
                 default: 280
     [-b <val>]  Log buffer size in KiB
                 default: 12
     [-p <val>]  Poll on a topic instead of running with fixed rate (Log rate
                 and topic intervals are ignored if this is set)
                 values: <topic_name>
     [-c <val>]  Log rate factor (higher is faster)
                 default: 1.0

   on            start logging now, override arming (logger must be running)

   off           stop logging now, override arming (logger must be running)

   trigger_watchdog manually trigger the watchdog now

   stop

   status        print status info

mag_bias_estimator ​

Джерело: modules/mag_bias_estimator

Опис ​

Онлайн-оцінювач похибки магнітометра.

Використання ​

mag_bias_estimator <command> [arguments...]
 Commands:
   start         Start the background task

   stop

   status        print status info

manual_control ​

Джерело: modules/manual_control

Опис ​

Модуль споживає вхідні дані вручним керуванням, публікуючи одну установку керування вручну.

Використання ​

manual_control <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

netman ​

Джерело: systemcmds/netman

Опис Менеджер конфігурації мережі зберігає налаштування мережі в неволатильній пам'яті. При запуску update опція буде виконана. Якщо конфігурація мережі не існує. Значення за замовчуванням буде збережено в неплавучій пам'яті та система перезавантажена. ​

update ​

оновлення мережі автоматично виконується за допомогою скрипту запуску системи. Під час виконання параметра update буде перевірено наявність net.cfg в корені картки SD. Після цього він зберігає мережеві налаштування з net.cfg у неволатильну пам'ять, видаляє файл і перезавантажує систему.

save ​

Опція save збереже налаштування з необхідної пам'яті в файл з назвою net.cfg на файловій системі SD картки для редагування. Використовуйте це, щоб відредагувати налаштування. Збереження не негайно застосовує мережеві налаштування; користувач повинен перезавантажити стек польоту. Напротив, команда update запускається сценарієм запуску, зберігає налаштування в постійну пам'ять, та перезавантажує контролер польоту (який потім використовуватиме нові налаштування).

показати ​

Опція show відобразить мережеві налаштування в net.cfg на консолі.

Приклади $ netman save # Зберегти параметри на SD-картку. $ netman show # відображення поточних налаштувань. $ netman update -i eth0 # зробити оновлення ​

Використання ​

netman <command> [arguments...]
 Commands:
   show          Display the current persistent network settings to the console.

   update        Check SD card for net.cfg and update network persistent network
                 settings.

   save          Save the current network parameters to the SD card.
     [-i <val>]  Set the interface name
                 default: eth0

pwm_input ​

Джерело: drivers/pwm_input

Опис ​

Вимірює вхід PWM на AUX5 (або MAIN5) через таймер захоплення ISR та публікує через повідомлення uORB 'pwm_input'.

Usage ​

pwm_input <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

rc_update ​

Джерело: modules/rc_update

Description ​

Модуль rc_update обробляє відображення каналів RC: зчитує сирі вхідні канали (input_rc), потім застосовує калібрування, відображає канали RC на налаштовані канали та перемикачі режиму а потім публікує як rc_channels та manual_control_input.

Імплементація ​

Щоб зменшити затримку управління, модуль запланований на опублікування введення_управління.

Використання ​

rc_update <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

replay ​

Джерело: modules/replay

Опис ​

Цей модуль використовується для відтворення файлів ULog.

Існує 2 змінні середовища, які використовуються для конфігурації: replay, яка повинна бути встановлена на ім'я файлу ULog - це файл журналу, який має бути відтворений. Другий - це режим, вказаний через replay_mode:

  • replay_mode=ekf2: специфічний режим відтворення EKF2. Це можна використовувати лише з модулем ekf2, але дозволяє відтворювати процес якомога швидше.
  • Загальне в іншому випадку: це може бути використано для повторення будь-яких модулів, але відтворення буде здійснене з тією самою швидкістю, що і було записано в журнал.

Модуль зазвичай використовується разом з правилами видавця uORB, щоб вказати, які повідомлення потрібно відтворити. Модуль відтворення просто опублікує всі повідомлення, які знаходяться в журналі. Це також застосовує параметри з журналу.

Процедура відтворення документована на сторінці Система Широкомасштабного Відтворення.

Usage ​

replay <command> [arguments...]
 Commands:
   start         Start replay, using log file from ENV variable 'replay'

   trystart      Same as 'start', but silently exit if no log file given

   tryapplyparams Try to apply the parameters from the log file

   stop

   status        print status info

send_event ​

Джерело: modules/events

Description ​

Фоновий процес, що періодично виконується в черзі завдань LP для виконання рутинних завдань. Зараз він відповідає лише за сигнал тривоги на втрату RC.

Завдання можна почати через CLI або теми uORB (vehicle_command з MAVLink тощо).

Використання ​

send_event <command> [arguments...]
 Commands:
   start         Start the background task

   stop

   status        print status info

sensor_arispeed_sim ​

Джерело: modules/simulation/sensor_airspeed_sim

Опис ​

Використання ​

sensor_arispeed_sim <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

sensor_baro_sim ​

Джерело: modules/simulation/sensor_baro_sim

Опис ​

Застосування ​

sensor_baro_sim <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

sensor_gps_sim ​

Джерело: modules/simulation/sensor_gps_sim

Опис ​

Використання ​

sensor_gps_sim <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

sensor_mag_sim ​

Джерело: modules/simulation/sensor_mag_sim

Описання ​

Використання ​

sensor_mag_sim <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

sensors ​

Джерело: modules/sensors

Опис ​

Модуль сенсорів є центральним у всій системі. Він отримує вихід низького рівня від драйверів, перетворює його в більш придатну форму і публікує його для решти системи.

Надана функціональність включає в себе:

  • Прочитайте вивід від драйверів датчиків (SensorGyro, тощо). Якщо існують кілька екземплярів того самого типу, виконуйте голосування та обробку аварійної ситуації. Потім застосуйте обертання дошки та калібрування температури (якщо ввімкнено). І, нарешті, опублікуйте дані; одну з тем є SensorCombined, яка використовується багатьма частинами системи.
  • Переконайтеся, що драйвери сенсора отримують оновлені калібрувальні параметри (масштаб & зміщення), коли параметри змінюються або на запуску. Драйвери сенсора використовують інтерфейс ioctl для оновлення параметрів. Для того, щоб це працювало належним чином, драйвери сенсора повинні вже працювати, коли sensors запускається.
  • Виконайте перевірку узгодженості датчиків та опублікуйте тему SensorsStatusImu.

Implementation ​

Він запускається у власній темі і проводить опитування на поточну обрану тему гіроскопа.

Використання ​

sensors <command> [arguments...]
 Commands:
   start
     [-h]        Start in HIL mode

   stop

   status        print status info

tattu_can ​

Джерело: drivers/tattu_can

Опис ​

Драйвер для зчитування даних з розумної батареї Tattu 12S 16000mAh.

Usage ​

tattu_can <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

temperature_compensation ​

Джерело: modules/temperature_compensation

Description ​

Модуль компенсації температури дозволяє всім гіроскопам, акселерометрам та барометрам у системі бути температурно компенсованими. Модуль відстежує дані, які надходять від датчиків та оновлює пов'язану тему sensor_correction кожного разу, коли виявляється зміна температури. Модуль також може бути налаштований для виконання обчислення коефіцієнта наступного завантаження, що дозволяє обчислити калібрувальні коефіцієнти теплової калібрації під час циклу температури автомобіля.

Використання ​

temperature_compensation <command> [arguments...]
 Commands:
   start         Start the module, which monitors the sensors and updates the
                 sensor_correction topic

   calibrate     Run temperature calibration process
     [-a]        calibrate the accel
     [-g]        calibrate the gyro
     [-m]        calibrate the mag
     [-b]        calibrate the baro (if none of these is given, all will be
                 calibrated)

   stop

   status        print status info

tune_control ​

Джерело: systemcmds/tune_control

Опис ​

Інструмент командного рядка для керування & тестування (зовнішніх) melodies.

Мелодії використовуються для надання слухових сповіщень та попереджень (наприклад, коли система озброєна, отримує позицію блокування тощо). Інструмент вимагає, щоб був запущений драйвер, який може керувати темою управління tune_control uorb.

Інформацію про формат мелодії та попередньо визначені системні мелодії можна знайти тут: https://github.com/PX4/PX4-Autopilot/blob/release/1.15/src/lib/tunes/tune_definition.desc

Приклади ​

Грайте системний мелодію #2:

tune_control play -t 2

Використання ​

tune_control <command> [arguments...]
 Commands:
   play          Play system tune or single note.
     error       Play error tune
     [-t <val>]  Play predefined system tune
                 default: 1
     [-f <val>]  Frequency of note in Hz (0-22kHz)
     [-d <val>]  Duration of note in us
     [-s <val>]  Volume level (loudness) of the note (0-100)
                 default: 40
     [-m <val>]  Melody in string form
                 values: <string> - e.g. "MFT200e8a8a"

   libtest       Test library

   stop          Stop playback (use for repeated tunes)

uxrce_dds_client ​

Джерело: modules/uxrce_dds_client

Опис предмету ​

Клієнт UXRCE-DDS використовується для спілкування з агентом за допомогою тем uORB через послідовний або UDP.

Приклади ​

uxrce_dds_client start -t serial -d /dev/ttyS3 -b 921600
uxrce_dds_client start -t udp -h 127.0.0.1 -p 15555

Usage ​

uxrce_dds_client <command> [arguments...]
 Commands:
   start
     [-t <val>]  Transport protocol
                 values: serial|udp, default: udp
     [-d <val>]  serial device
                 values: <file:dev>
     [-b <val>]  Baudrate (can also be p:<param_name>)
                 default: 0
     [-h <val>]  Agent IP. If not provided, defaults to UXRCE_DDS_AG_IP
                 values: <IP>
     [-p <val>]  Agent listening port. If not provided, defaults to
                 UXRCE_DDS_PRT
     [-n <val>]  Client DDS namespace

   stop

   status        print status info

work_queue ​

Джерело: systemcmds/work_queue

Опис ​

Інструмент командного рядка для відображення статусу черги роботи.

Використання ​

work_queue <command> [arguments...]
 Commands:
   start

   stop

   status        print status info