AP_Proximity_RangeFinder.h

Go to the documentation of this file.

#pragma once

#include "AP_Proximity.h"
#include "AP_Proximity_Backend.h"

#define PROXIMITY_RANGEFIDER_TIMEOUT_MS 200 // requests timeout after 0.2 seconds

class AP_Proximity_RangeFinder : public AP_Proximity_Backend
{

public:
    // constructor
    AP_Proximity_RangeFinder(AP_Proximity &_frontend, AP_Proximity::Proximity_State &_state);

    // update state
    void update(void);

    // get maximum and minimum distances (in meters) of sensor
    float distance_max() const { return _distance_max; }
    float distance_min() const { return _distance_min; }

    // get distance upwards in meters. returns true on success
    bool get_upward_distance(float &distance) const;

private:

    // horizontal distance support
    uint32_t _last_update_ms;   // system time of last RangeFinder reading
    float _distance_max;        // max range of sensor in meters
    float _distance_min;        // min range of sensor in meters

    // upward distance support
    uint32_t _last_upward_update_ms;    // system time of last update distance
    float _distance_upward;             // upward distance in meters, negative if the last reading was out of range
};