SRF08.h

Go to the documentation of this file.

 
#ifndef SRF08_h
#define SRF08_h
 
// includes
#include <inttypes.h>
#include <Arduino.h>
#include <Wire.h>
 
// defines
#define _SRF08_STD_ADDRESS 112  
#define _SRF08_LIB_VERSION 101  
 
 
class SRF08{
// Begin PUBLIC ------------------------------------------------------------------
    public:
 
        // constructors
        SRF08();                    // Main constructor of the SRF08 class.
        SRF08(uint8_t address);     // Constructor of the SRF08 class with non standard i2c address.
        ~SRF08();                   // Main destructor  of the SRF08 class.
 
        // init function
        void init();                // Initialize the SRF08 Sensor.
 
        // functions
        bool startRangeReading();           // Starts a new measurement with the SRF08 sensor if possible.
        void startRangeReadingUNSAFE();     // Starts a new measurement with the SRF08 sensor if possible but without blocking features.
        bool readRange();                   // Reads the current range measurement from the SRF08 sensor if possible.
        void readRangeUNSAFE();             // Reads the current range measurement from the SRF08 sensor if possible but without minimum processing delay.
        bool checkIfReadyForReading();      // Checks if the SRF08 is ready to start a new range measurement.
        int16_t getDistance();              // Get the last measured distance of the SRF08 sensor.
        uint32_t getTimeOfLastReading();    // Get the system time at which the SRF08 sensor started the last range measurement.
        uint16_t get_version();             // Get the version of the library.
 
// End PUBLIC --------------------------------------------------------------------
 
// Begin PRIVATE -----------------------------------------------------------------        
    private:
 
        // variables
        uint8_t _addressSRF08;
        int16_t _distance;
        bool _isReadyForReading;
        uint32_t _timeOfLastReading;
        uint16_t _prosessDelay;
 
// End PRIVATE -------------------------------------------------------------------
};
 
#endif