rover_qmc5883l.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2017 FH Dortmund and others
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Description:
 *     RoverQMC5883L API - Interfaces for Rover QMC5883L bearing sensor application development
 *     Header file
 *
 * Contributors:
 *    M.Ozcelikors <mozcelikors@gmail.com>, created RoverQMC5883L class 04.12.2017
 *
 */

#ifndef ROVERAPI_ROVER_QMC5883L_HPP_
#define ROVERAPI_ROVER_QMC5883L_HPP_

#include <roverapi/rover_sensor.hpp>

namespace rover
{
    class RoverQMC5883L : public RoverSensor
    {
        private:
            /* Definitions related to compass sensor */
            int QMC5883L_ADDRESS;

            int CALIBRATION_DURATION;

            float DECLINATION_ANGLE;

            mutable unsigned int calibration_start;

            int ROVERQMC5883L_SETUP_;

            int16_t xMinRaw;

            int16_t xMaxRaw;

            int16_t yMinRaw;

            int16_t yMaxRaw;

            int i2c_qmc588l_fd;

        public:
            explicit RoverQMC5883L ();

            ~RoverQMC5883L();

            void initialize (void);

            float read (void);

            void calibrate (void) const;

            void setQMC5883LAddress (const int address);

            void setQMC5883LCalibrationPeriod(const int period);

            void setQMC5883LDeclinationAngle (const float angle);

            int getQMC5883LAddress (void);

            int getQMC5883LCalibrationPeriod (void);

            float getQMC5883LDeclinationAngle (void);

        private:

            template<typename T>
            inline T MINIMUM_ (const T& a, const T& b);

            template<typename T>
            inline T MAXIMUM_ (const T& a, const T& b);

    };
}



#endif /* ROVERAPI_ROVER_QMC5883L_HPP_ */