hall-speed.hpp

Go to the documentation of this file.

#ifndef HALL_SPEED_HPP_
#define HALL_SPEED_HPP_

#include "../config/hall-conf.hpp"
#if (HALL_SPEED_ENABLED == 1)

#include "hall-switch.hpp"

class HallSpeed: public HallSwitch
{           
    public:
        
         enum SpeedUnit_t
         {
            HERTZ   = 0,    
            RADS    = 1,    
            RPM     = 2     
         };
        typedef void (*CBackSpd_t)(double);

        class Timer;

                    HallSpeed   ();
                    HallSpeed   (GPIO        *output,
                                 Timer       *timer,
                                 uint8_t     polesNum = 1,
                                 SpeedUnit_t units    = HERTZ,
                                 CBackSpd_t  cBack    = NULL,
                                 GPIO        *power   = NULL);
                   ~HallSpeed   ();
        Error_t     init        ();
        Error_t     deinit      ();
        Error_t     enable      ();
        Error_t     disable     ();                         
        Error_t     updateSpeed ();
        double      getSpeed    ();

    protected:
        Timer       *timer;                  
        uint8_t     polesPair;               
        SpeedUnit_t sUnits;                  
        double      speed;                   
        static double const speedCoeff[3];

        void        callback        ();
        void        calculateSpeed  ();
};

#endif 
#endif