/**************************************************************************** * * Copyright (c) 2012-2017 PX4 Development Team. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name PX4 nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ /** * @file PreflightCheck.cpp * * Preflight check for main system components * * @author Lorenz Meier * @author Johan Jansen */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "PreflightCheck.h" #include "DevMgr.hpp" using namespace DriverFramework; namespace Commander { static int check_calibration(DevHandle &h, const char *param_template, int &devid) { bool calibration_found; /* new style: ask device for calibration state */ int ret = h.ioctl(SENSORIOCCALTEST, 0); calibration_found = (ret == OK); devid = h.ioctl(DEVIOCGDEVICEID, 0); char s[20]; int instance = 0; /* old style transition: check param values */ while (!calibration_found) { sprintf(s, param_template, instance); param_t parm = param_find(s); /* if the calibration param is not present, abort */ if (parm == PARAM_INVALID) { break; } /* if param get succeeds */ int32_t calibration_devid; if (!param_get(parm, &(calibration_devid))) { /* if the devid matches, exit early */ if (devid == calibration_devid) { calibration_found = true; break; } } instance++; } return !calibration_found; } static bool magnometerCheck(orb_advert_t *mavlink_log_pub, unsigned instance, bool optional, int &device_id, bool report_fail) { bool success = true; char s[30]; sprintf(s, "%s%u", MAG_BASE_DEVICE_PATH, instance); DevHandle h; DevMgr::getHandle(s, h); if (!h.isValid()) { if (!optional) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: NO MAG SENSOR #%u", instance); } } return false; } int ret = check_calibration(h, "CAL_MAG%u_ID", device_id); if (ret) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: MAG #%u UNCALIBRATED", instance); } success = false; goto out; } ret = h.ioctl(MAGIOCSELFTEST, 0); if (ret != OK) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: MAG #%u SELFTEST FAILED", instance); } success = false; goto out; } out: DevMgr::releaseHandle(h); return success; } static bool imuConsistencyCheck(orb_advert_t *mavlink_log_pub, bool report_status) { bool success = true; // start with a pass and change to a fail if any test fails float test_limit = 1.0f; // pass limit re-used for each test // Get sensor_preflight data if available and exit with a fail recorded if not int sensors_sub = orb_subscribe(ORB_ID(sensor_preflight)); sensor_preflight_s sensors = {}; if (orb_copy(ORB_ID(sensor_preflight), sensors_sub, &sensors) != PX4_OK) { goto out; } // Use the difference between IMU's to detect a bad calibration. // If a single IMU is fitted, the value being checked will be zero so this check will always pass. param_get(param_find("COM_ARM_IMU_ACC"), &test_limit); if (sensors.accel_inconsistency_m_s_s > test_limit) { if (report_status) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: ACCELS INCONSISTENT - CHECK CAL"); } success = false; goto out; } else if (sensors.accel_inconsistency_m_s_s > test_limit * 0.8f) { if (report_status) { mavlink_log_info(mavlink_log_pub, "PREFLIGHT ADVICE: ACCELS INCONSISTENT - CHECK CAL"); } } // Fail if gyro difference greater than 5 deg/sec and notify if greater than 2.5 deg/sec param_get(param_find("COM_ARM_IMU_GYR"), &test_limit); if (sensors.gyro_inconsistency_rad_s > test_limit) { if (report_status) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: GYROS INCONSISTENT - CHECK CAL"); } success = false; goto out; } else if (sensors.gyro_inconsistency_rad_s > test_limit * 0.5f) { if (report_status) { mavlink_log_info(mavlink_log_pub, "PREFLIGHT ADVICE: GYROS INCONSISTENT - CHECK CAL"); } } out: orb_unsubscribe(sensors_sub); return success; } // return false if the magnetomer measurements are inconsistent static bool magConsistencyCheck(orb_advert_t *mavlink_log_pub, bool report_status) { // get the sensor preflight data int sensors_sub = orb_subscribe(ORB_ID(sensor_preflight)); struct sensor_preflight_s sensors = {}; if (orb_copy(ORB_ID(sensor_preflight), sensors_sub, &sensors) != 0) { // can happen if not advertised (yet) return true; } orb_unsubscribe(sensors_sub); // Use the difference between sensors to detect a bad calibration, orientation or magnetic interference. // If a single sensor is fitted, the value being checked will be zero so this check will always pass. float test_limit; param_get(param_find("COM_ARM_MAG"), &test_limit); if (sensors.mag_inconsistency_ga > test_limit) { if (report_status) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: MAG SENSORS INCONSISTENT"); } return false; } return true; } static bool accelerometerCheck(orb_advert_t *mavlink_log_pub, unsigned instance, bool optional, bool dynamic, int &device_id, bool report_fail) { bool success = true; char s[30]; sprintf(s, "%s%u", ACCEL_BASE_DEVICE_PATH, instance); DevHandle h; DevMgr::getHandle(s, h); if (!h.isValid()) { if (!optional) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: NO ACCEL SENSOR #%u", instance); } } return false; } int ret = check_calibration(h, "CAL_ACC%u_ID", device_id); if (ret) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: ACCEL #%u UNCALIBRATED", instance); } success = false; goto out; } ret = h.ioctl(ACCELIOCSELFTEST, 0); if (ret != OK) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: ACCEL #%u TEST FAILED: %d", instance, ret); } success = false; goto out; } #ifdef __PX4_NUTTX if (dynamic) { /* check measurement result range */ struct accel_report acc; ret = h.read(&acc, sizeof(acc)); if (ret == sizeof(acc)) { /* evaluate values */ float accel_magnitude = sqrtf(acc.x * acc.x + acc.y * acc.y + acc.z * acc.z); if (accel_magnitude < 4.0f || accel_magnitude > 15.0f /* m/s^2 */) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: ACCEL RANGE, hold still on arming"); } /* this is frickin' fatal */ success = false; goto out; } } else { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: ACCEL READ"); } /* this is frickin' fatal */ success = false; goto out; } } #endif out: DevMgr::releaseHandle(h); return success; } static bool gyroCheck(orb_advert_t *mavlink_log_pub, unsigned instance, bool optional, int &device_id, bool report_fail) { bool success = true; char s[30]; sprintf(s, "%s%u", GYRO_BASE_DEVICE_PATH, instance); DevHandle h; DevMgr::getHandle(s, h); if (!h.isValid()) { if (!optional) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: NO GYRO SENSOR #%u", instance); } } return false; } int ret = check_calibration(h, "CAL_GYRO%u_ID", device_id); if (ret) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: GYRO #%u UNCALIBRATED", instance); } success = false; goto out; } ret = h.ioctl(GYROIOCSELFTEST, 0); if (ret != OK) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: GYRO #%u SELFTEST FAILED", instance); } success = false; goto out; } out: DevMgr::releaseHandle(h); return success; } static bool baroCheck(orb_advert_t *mavlink_log_pub, unsigned instance, bool optional, int &device_id, bool report_fail) { bool success = true; char s[30]; sprintf(s, "%s%u", BARO_BASE_DEVICE_PATH, instance); DevHandle h; DevMgr::getHandle(s, h); if (!h.isValid()) { if (!optional) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: NO BARO SENSOR #%u", instance); } } return false; } device_id = -1000; // TODO: There is no baro calibration yet, since no external baros exist // int ret = check_calibration(fd, "CAL_BARO%u_ID"); // if (ret) { // mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: BARO #%u UNCALIBRATED", instance); // success = false; // goto out; // } //out: DevMgr::releaseHandle(h); return success; } static bool airspeedCheck(orb_advert_t *mavlink_log_pub, bool optional, bool report_fail, bool prearm) { bool success = true; int fd_airspeed = orb_subscribe(ORB_ID(airspeed)); airspeed_s airspeed = {}; int fd_diffpres = orb_subscribe(ORB_ID(differential_pressure)); differential_pressure_s differential_pressure = {}; if ((orb_copy(ORB_ID(differential_pressure), fd_diffpres, &differential_pressure) != PX4_OK) || (hrt_elapsed_time(&differential_pressure.timestamp) > 1000000)) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: AIRSPEED SENSOR MISSING"); } success = false; goto out; } if ((orb_copy(ORB_ID(airspeed), fd_airspeed, &airspeed) != PX4_OK) || (hrt_elapsed_time(&airspeed.timestamp) > 1000000)) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: AIRSPEED SENSOR MISSING"); } success = false; goto out; } /* * Check if voter thinks the confidence is low. High-end sensors might have virtually zero noise * on the bench and trigger false positives of the voter. Therefore only fail this * for a pre-arm check, as then the cover is off and the natural airflow in the field * will ensure there is not zero noise. */ if (prearm && fabsf(airspeed.confidence) < 0.95f) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: AIRSPEED SENSOR STUCK"); } success = false; goto out; } /** * Check if differential pressure is off by more than 15Pa which equals ~5m/s when measuring no airspeed. * Negative and positive offsets are considered. Do not check anymore while arming because pitot cover * might have been removed. */ if (fabsf(differential_pressure.differential_pressure_filtered_pa) > 15.0f && !prearm) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: CHECK AIRSPEED CAL OR PITOT"); } success = false; goto out; } out: orb_unsubscribe(fd_airspeed); orb_unsubscribe(fd_diffpres); return success; } static bool gnssCheck(orb_advert_t *mavlink_log_pub, bool report_fail, bool &lock_detected) { bool success = true; lock_detected = false; int gpsSub = orb_subscribe(ORB_ID(vehicle_gps_position)); //Wait up to 2000ms to allow the driver to detect a GNSS receiver module px4_pollfd_struct_t fds[1]; fds[0].fd = gpsSub; fds[0].events = POLLIN; if (px4_poll(fds, 1, 2000) <= 0) { success = false; } else { struct vehicle_gps_position_s gps; if ((OK != orb_copy(ORB_ID(vehicle_gps_position), gpsSub, &gps)) || (hrt_elapsed_time(&gps.timestamp) > 1000000)) { success = false; } else if (gps.fix_type >= 3) { lock_detected = true; } } //Report failure to detect module if (!success) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: GPS RECEIVER MISSING"); } } orb_unsubscribe(gpsSub); return success; } static bool ekf2Check(orb_advert_t *mavlink_log_pub, bool optional, bool report_fail, bool enforce_gps_required) { bool success = true; // start with a pass and change to a fail if any test fails float test_limit = 1.0f; // pass limit re-used for each test // Get estimator status data if available and exit with a fail recorded if not int sub = orb_subscribe(ORB_ID(estimator_status)); estimator_status_s status = {}; if (orb_copy(ORB_ID(estimator_status), sub, &status) != PX4_OK) { goto out; } // Check if preflight check perfomred by estimator has failed if (status.pre_flt_fail) { success = false; goto out; } // check vertical position innovation test ratio param_get(param_find("COM_ARM_EKF_HGT"), &test_limit); if (status.hgt_test_ratio > test_limit) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: EKF HGT ERROR"); } success = false; goto out; } // check velocity innovation test ratio param_get(param_find("COM_ARM_EKF_VEL"), &test_limit); if (status.vel_test_ratio > test_limit) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: EKF VEL ERROR"); } success = false; goto out; } // check horizontal position innovation test ratio param_get(param_find("COM_ARM_EKF_POS"), &test_limit); if (status.pos_test_ratio > test_limit) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: EKF HORIZ POS ERROR"); } success = false; goto out; } // If GPS aiding is required, declare fault condition if the EKF is not using GPS if (enforce_gps_required) { bool ekf_gps_fusion = status.control_mode_flags & (1 << 2); if (!ekf_gps_fusion) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: EKF NOT USING GPS"); } success = false; goto out; } } // If GPS aiding is required, declare fault condition if the required GPS quality checks are failing if (enforce_gps_required) { if ((status.gps_check_fail_flags & ((1 << estimator_status_s::GPS_CHECK_FAIL_MIN_SAT_COUNT) + (1 << estimator_status_s::GPS_CHECK_FAIL_MIN_GDOP) + (1 << estimator_status_s::GPS_CHECK_FAIL_MAX_HORZ_ERR) + (1 << estimator_status_s::GPS_CHECK_FAIL_MAX_VERT_ERR))) > 0) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: GPS QUALITY CHECKS"); } success = false; goto out; } } // check magnetometer innovation test ratio param_get(param_find("COM_ARM_EKF_YAW"), &test_limit); if (status.mag_test_ratio > test_limit) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: EKF YAW ERROR"); } success = false; goto out; } // check accelerometer delta velocity bias estimates param_get(param_find("COM_ARM_EKF_AB"), &test_limit); if (fabsf(status.states[13]) > test_limit || fabsf(status.states[14]) > test_limit || fabsf(status.states[15]) > test_limit) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: EKF HIGH IMU ACCEL BIAS"); } success = false; goto out; } // check gyro delta angle bias estimates param_get(param_find("COM_ARM_EKF_GB"), &test_limit); if (fabsf(status.states[10]) > test_limit || fabsf(status.states[11]) > test_limit || fabsf(status.states[12]) > test_limit) { if (report_fail) { mavlink_log_critical(mavlink_log_pub, "PREFLIGHT FAIL: EKF HIGH IMU GYRO BIAS"); } success = false; goto out; } out: orb_unsubscribe(sub); return success; } bool preflightCheck(orb_advert_t *mavlink_log_pub, bool checkSensors, bool checkAirspeed, bool checkRC, bool checkGNSS, bool checkDynamic, bool isVTOL, bool reportFailures, bool prearm, hrt_abstime time_since_boot) { if (time_since_boot < 2000000) { // the airspeed driver filter doesn't deliver the actual value yet return true; } #ifdef __PX4_QURT // WARNING: Preflight checks are important and should be added back when // all the sensors are supported PX4_WARN("Preflight checks always pass on Snapdragon."); checkSensors = false; #elif defined(__PX4_POSIX_RPI) PX4_WARN("Preflight checks for mag, acc, gyro always pass on RPI"); checkSensors = false; #elif defined(__PX4_POSIX_BEBOP) PX4_WARN("Preflight checks always pass on Bebop."); checkSensors = false; #elif defined(__PX4_POSIX_OCPOC) PX4_WARN("Preflight checks always pass on OcPoC."); checkSensors = false; #endif bool failed = false; /* ---- MAG ---- */ if (checkSensors) { bool prime_found = false; int32_t prime_id = 0; param_get(param_find("CAL_MAG_PRIME"), &prime_id); /* check all sensors, but fail only for mandatory ones */ for (unsigned i = 0; i < max_optional_mag_count; i++) { bool required = (i < max_mandatory_mag_count); int device_id = -1; if (!magnometerCheck(mavlink_log_pub, i, !required, device_id, reportFailures) && required) { failed = true; } if (device_id == prime_id) { prime_found = true; } } /* check if the primary device is present */ if (!prime_found && prime_id != 0) { if (reportFailures) { mavlink_log_critical(mavlink_log_pub, "Warning: Primary compass not found"); } failed = true; } /* fail if mag sensors are inconsistent */ if (!magConsistencyCheck(mavlink_log_pub, reportFailures)) { failed = true; } } /* ---- ACCEL ---- */ if (checkSensors) { bool prime_found = false; int32_t prime_id = 0; param_get(param_find("CAL_ACC_PRIME"), &prime_id); /* check all sensors, but fail only for mandatory ones */ for (unsigned i = 0; i < max_optional_accel_count; i++) { bool required = (i < max_mandatory_accel_count); int device_id = -1; if (!accelerometerCheck(mavlink_log_pub, i, !required, checkDynamic, device_id, reportFailures) && required) { failed = true; } if (device_id == prime_id) { prime_found = true; } } /* check if the primary device is present */ if (!prime_found && prime_id != 0) { if (reportFailures) { mavlink_log_critical(mavlink_log_pub, "Warning: Primary accelerometer not found"); } failed = true; } } /* ---- GYRO ---- */ if (checkSensors) { bool prime_found = false; int32_t prime_id = 0; param_get(param_find("CAL_GYRO_PRIME"), &prime_id); /* check all sensors, but fail only for mandatory ones */ for (unsigned i = 0; i < max_optional_gyro_count; i++) { bool required = (i < max_mandatory_gyro_count); int device_id = -1; if (!gyroCheck(mavlink_log_pub, i, !required, device_id, reportFailures) && required) { failed = true; } if (device_id == prime_id) { prime_found = true; } } /* check if the primary device is present */ if (!prime_found && prime_id != 0) { if (reportFailures) { mavlink_log_critical(mavlink_log_pub, "Warning: Primary gyro not found"); } failed = true; } } /* ---- BARO ---- */ if (checkSensors) { bool prime_found = false; int32_t prime_id = 0; param_get(param_find("CAL_BARO_PRIME"), &prime_id); /* check all sensors, but fail only for mandatory ones */ for (unsigned i = 0; i < max_optional_baro_count; i++) { bool required = (i < max_mandatory_baro_count); int device_id = -1; if (!baroCheck(mavlink_log_pub, i, !required, device_id, reportFailures) && required) { failed = true; } if (device_id == prime_id) { prime_found = true; } } // TODO there is no logic in place to calibrate the primary baro yet // // check if the primary device is present if (!prime_found && prime_id != 0) { if (reportFailures) { mavlink_log_critical(mavlink_log_pub, "warning: primary barometer not operational"); } failed = true; } } /* ---- IMU CONSISTENCY ---- */ if (checkSensors) { if (!imuConsistencyCheck(mavlink_log_pub, reportFailures)) { failed = true; } } /* ---- AIRSPEED ---- */ if (checkAirspeed) { if (!airspeedCheck(mavlink_log_pub, true, reportFailures, prearm)) { failed = true; } } /* ---- RC CALIBRATION ---- */ if (checkRC) { if (rc_calibration_check(mavlink_log_pub, reportFailures, isVTOL) != OK) { if (reportFailures) { mavlink_log_critical(mavlink_log_pub, "RC calibration check failed"); } failed = true; } } /* ---- Global Navigation Satellite System receiver ---- */ static hrt_abstime _time_last_no_gps_lock = 0; if (checkGNSS) { bool lock_detected = false; if (!gnssCheck(mavlink_log_pub, reportFailures, lock_detected)) { failed = true; } if (!lock_detected) { _time_last_no_gps_lock = time_since_boot; } } /* ---- Navigation EKF ---- */ // only check EKF2 data if EKF2 is selected as the estimator and GNSS checking is enabled int32_t estimator_type; param_get(param_find("SYS_MC_EST_GROUP"), &estimator_type); if (estimator_type == 2 && checkGNSS) { // don't fail if not using GPS for the first 20s after gaining 3D lock because quality checks take time to pass bool enforce_gps_required = (_time_last_no_gps_lock > 20 * 1000000); if (!ekf2Check(mavlink_log_pub, true, reportFailures, enforce_gps_required)) { failed = true; } } /* Report status */ return !failed; } }