Hmc5883l.h

Go to the documentation of this file.

 
#ifndef HMC5883L_H
#define HMC5883L_H
 
#include <Arduino.h>
#include <Wire.h>
 
#include <General_compass.h>

class Hmc5883l : public General_compass {
    private:
        const uint32_t port;

        uint8_t i2c_address;

        static const uint8_t DEFAULT_I2C_ADDRESS;

        static const uint32_t I2C_FREQ;

        unsigned long prev_getdata_millis;

        double raw_to_uT (const int16_t raw);
    
    public:
        Hmc5883l (const uint32_t init_port);

        bool begin (const uint8_t init_i2c_address = DEFAULT_I2C_ADDRESS);

        bool begin (const Compass_cal_vals_t compass_cal_values, const uint8_t init_i2c_address = DEFAULT_I2C_ADDRESS);
 
        // low-level functions

        bool update ();

        uint32_t id ();

        bool is_mag_present ();
};
 
#endif // #ifndef HMC5883L_H