AP_SurfaceDistance: Start library for tracking the floor/roof distance

libraries/AP_SurfaceDistance/AP_SurfaceDistance.cpp

@@ -0,0 +1,184 @@
+#include "AP_SurfaceDistance.h"
+
+#include <AP_RangeFinder/AP_RangeFinder.h>
+
+#ifndef RANGEFINDER_TIMEOUT_MS
+ # define RANGEFINDER_TIMEOUT_MS 1000        // rangefinder filter reset if no updates from sensor in 1 second
+#endif
+
+#if AP_RANGEFINDER_ENABLED
+
+#include <AP_AHRS/AP_AHRS.h>
+#include <AP_Logger/AP_Logger.h>
+
+#ifndef RANGEFINDER_TILT_CORRECTION         // by disable tilt correction for use of range finder data by EKF
+ # define RANGEFINDER_TILT_CORRECTION 1
+#endif
+
+#ifndef RANGEFINDER_GLITCH_NUM_SAMPLES
+ # define RANGEFINDER_GLITCH_NUM_SAMPLES  3   // number of rangefinder glitches in a row to take new reading
+#endif
+
+#ifndef RANGEFINDER_GLITCH_ALT_CM
+ # define RANGEFINDER_GLITCH_ALT_CM  200      // amount of rangefinder change to be considered a glitch
+#endif
+
+#ifndef RANGEFINDER_HEALTH_MAX
+ # define RANGEFINDER_HEALTH_MAX 3          // number of good reads that indicates a healthy rangefinder
+#endif
+
+void AP_SurfaceDistance::update()
+{
+    const RangeFinder *rangefinder = RangeFinder::get_singleton();
+    if (rangefinder == nullptr) {
+        alt_healthy = false;
+        return;
+    }
+
+#if RANGEFINDER_TILT_CORRECTION == 1
+    const float tilt_correction = MAX(0.707f, AP::ahrs().get_rotation_body_to_ned().c.z);
+#else
+    const float tilt_correction = 1.0f;
+#endif
+
+    const uint32_t now = AP_HAL::millis();
+
+    // Assemble assistance bitmask, definition is used to generate log documentation
+    enum class Surface_Distance_Status {
+        Enabled         = 1U<<0, // true if rangefinder has been set to enable by vehicle
+        Unhealthy       = 1U<<1, // true if rangefinder is considered unhealthy
+        Stale_Data      = 1U<<3, // true if the last healthy rangefinder reading is no longer valid
+        Glitch_Detected = 1U<<4, // true if a measurement glitch detected
+    };
+
+    // reset status and add to the bitmask as we progress through the update
+    status = 0;
+
+    // update enabled status
+    if (enabled) {
+        status |= (uint8_t)Surface_Distance_Status::Enabled;
+    }
+
+    // update health
+    alt_healthy = (rangefinder->status_orient(rotation) == RangeFinder::Status::Good) &&
+                            (rangefinder->range_valid_count_orient(rotation) >= RANGEFINDER_HEALTH_MAX);
+    if (!alt_healthy) {
+        status |= (uint8_t)Surface_Distance_Status::Unhealthy;
+    }
+
+    // tilt corrected but unfiltered, not glitch protected alt
+    alt_cm = tilt_correction * rangefinder->distance_cm_orient(rotation);
+
+    // remember inertial alt to allow us to interpolate rangefinder
+    inertial_alt_cm = inertial_nav.get_position_z_up_cm();
+
+    // glitch handling.  rangefinder readings more than RANGEFINDER_GLITCH_ALT_CM from the last good reading
+    // are considered a glitch and glitch_count becomes non-zero
+    // glitches clear after RANGEFINDER_GLITCH_NUM_SAMPLES samples in a row.
+    // glitch_cleared_ms is set so surface tracking (or other consumers) can trigger a target reset
+    const int32_t glitch_cm = alt_cm - alt_cm_glitch_protected;
+    bool reset_terrain_offset = false;
+    if (glitch_cm >= RANGEFINDER_GLITCH_ALT_CM) {
+        glitch_count = MAX(glitch_count+1, 1);
+        status |= (uint8_t)Surface_Distance_Status::Glitch_Detected;
+    } else if (glitch_cm <= -RANGEFINDER_GLITCH_ALT_CM) {
+        glitch_count = MIN(glitch_count-1, -1);
+        status |= (uint8_t)Surface_Distance_Status::Glitch_Detected;
+    } else {
+        glitch_count = 0;
+        alt_cm_glitch_protected = alt_cm;
+    }
+    if (abs(glitch_count) >= RANGEFINDER_GLITCH_NUM_SAMPLES) {
+        // clear glitch and record time so consumers (i.e. surface tracking) can reset their target altitudes
+        glitch_count = 0;
+        alt_cm_glitch_protected = alt_cm;
+        glitch_cleared_ms = now;
+        reset_terrain_offset = true;
+    }
+
+    // filter rangefinder altitude
+    const bool timed_out = now - last_healthy_ms > RANGEFINDER_TIMEOUT_MS;
+    if (alt_healthy) {
+        if (timed_out) {
+            // reset filter if we haven't used it within the last second
+            alt_cm_filt.reset(alt_cm);
+            reset_terrain_offset = true;
+            status |= (uint8_t)Surface_Distance_Status::Stale_Data;
+        } else {
+            // TODO: When we apply this library in plane we will need for the filter freq to be set-able
+            alt_cm_filt.apply(alt_cm, 0.05);
+        }
+        last_healthy_ms = now;
+    }
+
+    // handle reset of terrain offset
+    if (reset_terrain_offset) {
+        if (rotation == ROTATION_PITCH_90) {
+            // upward facing
+            terrain_offset_cm = inertial_alt_cm + alt_cm;
+        } else {
+            // assume downward facing
+            terrain_offset_cm = inertial_alt_cm - alt_cm;
+        }
+    }
+#if HAL_LOGGING_ENABLED
+    Log_Write();
+#endif
+}
+
+/*
+  get inertially interpolated rangefinder height. Inertial height is
+  recorded whenever we update the rangefinder height, then we use the
+  difference between the inertial height at that time and the current
+  inertial height to give us interpolation of height from rangefinder
+ */
+bool AP_SurfaceDistance::get_rangefinder_height_interpolated_cm(int32_t& ret) const
+{
+    if (!enabled_and_healthy()) {
+        return false;
+    }
+    ret = alt_cm_filt.get();
+    ret += inertial_nav.get_position_z_up_cm() - inertial_alt_cm;
+    return true;
+}
+
+#if HAL_LOGGING_ENABLED
+void AP_SurfaceDistance::Log_Write(void) const
+{
+    // @LoggerMessage: SURF
+    // @Vehicles: Copter
+    // @Description: Surface distance measurement
+    // @Field: TimeUS: Time since system startup
+    // @Field: I: Instance
+    // @FieldBitmaskEnum: St: Surface_Distance_Status
+    // @Field: D: Raw Distance
+    // @Field: FD: Filtered Distance
+    // @Field: TO: Terrain Offset
+
+    //Write to data flash log
+    AP::logger().WriteStreaming("SURF",
+                                "TimeUS,I,St,D,FD,TO",
+                                "s#-mmm",//units multipliers format
+                                "F--BBB",
+                                "QfBhhf",
+                                AP_HAL::micros64(),
+                                instance,
+                                status,
+                                alt_cm,
+                                alt_cm_filt.get(),
+                                terrain_offset_cm
+                                );
+}
+#endif  // HAL_LOGGING_ENABLED
+
+#endif // AP_RANGEFINDER_ENABLED
+
+bool AP_SurfaceDistance::data_stale(void) const
+{
+    return (AP_HAL::millis() - last_healthy_ms) > RANGEFINDER_TIMEOUT_MS;
+}
+
+bool AP_SurfaceDistance::enabled_and_healthy(void) const
+{
+    return enabled && alt_healthy;
+}

libraries/AP_SurfaceDistance/AP_SurfaceDistance.h

@@ -0,0 +1,43 @@
+#pragma once
+
+#include <AP_Math/AP_Math.h>
+#include <Filter/LowPassFilter.h>
+#include <AP_InertialNav/AP_InertialNav.h>
+
+class AP_SurfaceDistance {
+public:
+    AP_SurfaceDistance(Rotation rot, const AP_InertialNav& inav, uint8_t i) : rotation(rot), inertial_nav(inav), instance(i) {};
+
+    void update();
+
+    // check if the last healthy range finder reading is too old to be considered valid
+    bool data_stale(void) const;
+
+    // helper to check that rangefinder was last reported as enabled and healthy
+    bool enabled_and_healthy(void) const;
+
+    // get inertially interpolated rangefinder height
+    bool get_rangefinder_height_interpolated_cm(int32_t& ret) const;
+
+    bool enabled;                          // Not to be confused with rangefinder enabled, this state is to be set by the vehicle.
+    bool alt_healthy;                      // true if we can trust the altitude from the rangefinder
+    int16_t alt_cm;                        // tilt compensated altitude (in cm) from rangefinder
+    float inertial_alt_cm;                 // inertial alt at time of last rangefinder sample
+    LowPassFilterFloat alt_cm_filt {0.5};  // altitude filter
+    int16_t alt_cm_glitch_protected;       // last glitch protected altitude
+    int8_t glitch_count;                   // non-zero number indicates rangefinder is glitching
+    uint32_t glitch_cleared_ms;            // system time glitch cleared
+    float terrain_offset_cm;               // filtered terrain offset (e.g. terrain's height above EKF origin)
+
+private:
+#if HAL_LOGGING_ENABLED
+    void Log_Write(void) const;
+#endif
+
+    const uint8_t instance;
+    uint8_t status;
+    uint32_t last_healthy_ms;
+
+    const AP_InertialNav& inertial_nav;
+    const Rotation rotation;
+};