hall-switch.hpp

Go to the documentation of this file.

#ifndef HALL_SWITCH_HPP_
#define HALL_SWITCH_HPP_

#include <stdlib.h>
#include <stdint.h>


class HallSwitch
{
    public:

        enum Error_t
        {
            OK           =  0,      
            INTF_ERROR   = -1,      
            CONF_ERROR   = -2,      
        };
        enum PowerMode_t
        {
            MAIN         = 1,    
            SWITCH       = 2,    
        };
        enum Status_t
        {
            UNINITED    = 0,         
            INITED      = 1,         
            POWER_ON    = 2,         
            POWER_OFF   = 3,         
        };
        enum MeasMode_t
        {
            POLLING     = 1,    
            INTERRUPT   = 2,    
        };
        enum Result_t
        {
            B_FIELD_UNDEF = -1,     
            B_FIELD_OFF   =  0,     
            B_FIELD_ON    =  1,     
        };
        typedef void (*CBack_t)(Result_t);

        class GPIO;

        class Interrupt;

                    HallSwitch   ();
                    HallSwitch   (GPIO        *output,
                                  CBack_t     cBack   = NULL,
                                  GPIO        *power  = NULL);
                   ~HallSwitch   ();
        Error_t     init         ();
        Error_t     deinit       ();
        Error_t     enable       ();
        Error_t     disable      ();
        Status_t    getStatus    ();
        Error_t     updateBField ();
        Result_t    getBField    ();

    protected:

        Status_t    status;             
        GPIO        *output;            
        Result_t    bfieldVal;          
        CBack_t     cBack;              
        MeasMode_t  measMode;           
        GPIO        *power;             
        PowerMode_t powerMode;          
        virtual void callback   ();
      
};

#endif