PX4-Autopilot/docs/en/debug/failure_injection.md
Hamish Willee 88d623bedb
Move PX4 Guide source into /docs (#24490)
* 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>
2025-03-13 16:08:27 +11:00

3.5 KiB

System Failure Injection

System failure injection allows you to induce different types of sensor and system failures, either programmatically using the MAVSDK failure plugin, or "manually" via a PX4 console like the MAVLink shell. This enables easier testing of safety failsafe behaviour, and more generally, of how PX4 behaves when systems and sensors stop working correctly.

Failure injection is disabled by default, and can be enabled using the SYS_FAILURE_EN parameter.

:::warning Failure injection still in development. At time of writing (PX4 v1.14):

  • It can only be used in simulation (support for both failure injection in real flight is planned).
  • It requires support in the simulator. It is supported in Gazebo Classic
  • Many failure types are not broadly implemented. In those cases the command will return with an "unsupported" message.

:::

Failure System Command

Failures can be injected using the failure system command from any PX4 console/shell, specifying both the target and type of the failure.

Syntax

The full syntax of the failure command is:

failure <component> <failure_type> [-i <instance_number>]

where:

  • component:
    • Sensors:
      • gyro: Gyro.
      • accel: Accelerometer.
      • mag: Magnetometer
      • baro: Barometer
      • gps: GPS
      • optical_flow: Optical flow.
      • vio: Visual inertial odometry.
      • distance_sensor: Distance sensor (rangefinder).
      • airspeed: Airspeed sensor.
    • Systems:
      • battery: Battery.
      • motor: Motor.
      • servo: Servo.
      • avoidance: Avoidance.
      • rc_signal: RC Signal.
      • mavlink_signal: MAVLink signal (data telemetry).
  • failure_type:
    • ok: Publish as normal (Disable failure injection).
    • off: Stop publishing.
    • stuck: Report same value every time (could indicate a malfunctioning sensor).
    • garbage: Publish random noise. This looks like reading uninitialized memory.
    • wrong: Publish invalid values (that still look reasonable/aren't "garbage").
    • slow: Publish at a reduced rate.
    • delayed: Publish valid data with a significant delay.
    • intermittent: Publish intermittently.
  • instance number (optional): Instance number of affected sensor. 0 (default) indicates all sensors of specified type.

Example

To simulate losing RC signal without having to turn off your RC controller:

  1. Enable the parameter SYS_FAILURE_EN.

  2. Enter the following commands on the MAVLink console or SITL pxh shell:

    # Fail RC (turn publishing off)
    failure rc_signal off
    
    # Restart RC publishing
    failure rc_signal ok
    

MAVSDK Failure Plugin

The MAVSDK failure plugin can be used to programmatically inject failures. It is used in PX4 Integration Testing to simulate failure cases (for example, see PX4-Autopilot/test/mavsdk_tests/autopilot_tester.cpp).

The plugin API is a direct mapping of the failure command shown above, with a few additional error signals related to the connection.