hubolib.h

Go to the documentation of this file.

#ifndef HUBOLIB_H
    #define HUBOLIB_H

    
#include <vector>
#include <string>

namespace HuboLib
{
    // ************************************************************************************************
    // Definitions
    // ************************************************************************************************

    #ifndef MAX_MCP3x08_CHANNELS
        #define MAX_MCP3x08_CHANNELS (8)
    #endif

    #ifndef MAX_MCP23017_SLAVES
        #define MAX_MCP23017_SLAVES (7)
    #endif

    #ifndef __int64
        #define __int64 long long
    #endif

    typedef void (*T_pfn_CycleTickCallback)     (unsigned long* pADChannelValues, unsigned char* pDigitalInputValues, unsigned char* pDigitalOutputValues);

    typedef void (*T_pfn_ChannelDelayCallback)  (__int64 cycleCount, __int64 t_Overrun_ms);

    typedef void (*T_pfn_DIChangedCallback)     (unsigned char  changedDigitalInputValues, unsigned char digitalInputValues);





    // ************************************************************************************************
    // Hubo initialization
    // ************************************************************************************************

    bool            Initialize                       ();

    void            Uninitialize                     ();

    bool            Initialize_MCP23017              ();

    bool            Wait_For_MCP23017_Buffered_Values();

    bool            Initialize_MCP23017_Slaves      ();
    
    bool            Wait_For_MCP23017_Slaves_Buffered_Values();

    bool            Initialize_MCP3x08              ();

    bool            Wait_For_MCP3x08_Buffered_Values();




    // ************************************************************************************************
    // Timing and monitoring support
    // ************************************************************************************************

    bool            Set_Cycle_Time                  (long cycleTime);

    bool            Register_CycleTickCallback      (T_pfn_CycleTickCallback    pFnCycleTickCallback);

    bool            Unregister_CycleTickCallback        (T_pfn_CycleTickCallback    pFnCycleTickCallback);
    
    bool            Register_ChannelDelayCallback   (T_pfn_ChannelDelayCallback pFnChannelDelayCallback);

    bool            Unregister_ChannelDelayCallback (T_pfn_ChannelDelayCallback pFnChannelDelayCallback);




    // ************************************************************************************************
    // Digital output support
    // ************************************************************************************************

    bool            Set_DO_Channels                 (unsigned char  value);

    bool            Set_Slave_DO_Channels           (int slaveNo, unsigned char  value);

    bool            Set_DO_Channel                  (int channel, bool bValue);

    bool            Set_Slave_DO_Channel            (int slaveNo, int channel, bool bValue);

    bool            Get_DO_Channels                 (unsigned char& value);

    bool            Get_Slave_DO_Channels           (int slaveNo, unsigned char& value);

    bool            Readback_DO_Channels            (unsigned char& value);

    bool            Readback_Slave_DO_Channels      (int slaveNo, unsigned char& value);





    // ************************************************************************************************
    // Digital input support
    // ************************************************************************************************

    bool            Get_DI_Channels                 (unsigned char& value);

    bool            Get_DI_Channels_Raw             (unsigned char& values);

    bool            Get_Slave_DI_Channels           (int slaveNo, unsigned char& value);

    bool            Get_DI_Channel                  (int channel,  bool& bValue);

    bool            Get_Slave_DI_Channel            (int slaveNo, int channel,  bool& bValue);


    bool            Register_DIChangedCallback      (T_pfn_DIChangedCallback pFnDIChangedCallback);

    bool            Unregister_DIChangedCallback    (T_pfn_DIChangedCallback pFnDIChangedCallback);




    
    // ************************************************************************************************
    // Analog input support
    // ************************************************************************************************

    void            Set_VRef                        (double volt);

    double          Get_VRef                        ();

    double          Get_VRef_Raw                    ();

    bool            Set_MCP3x08_Oversampling        (unsigned short overSampling[MAX_MCP3x08_CHANNELS]);

    bool            Get_AI_Channel                  (int channel, unsigned long& count, double& volt);

    bool    Get_AI_Channel_Raw              (int channel, unsigned short& value);



    // ************************************************************************************************
    // Miscellaneous 
    // ************************************************************************************************

    void            VersionInfo                     ();

    double          Get_MCP9701_Temperature         (double volt);

    double          Get_MCP9700_Temperature         (double volt);

    bool            GetSlaveDeviceList              (std::vector<int>& slaveAddressList);

    unsigned long long  GetTime_MicroSeconds        ();

    void            Delay_MicroSeconds              (unsigned long delay_micros);




    // ************************************************************************************************
    // 1wire support 
    // ************************************************************************************************

    bool            Get_1w_Devices                  (std::vector<std::string>& deviceList);

    bool            Is_DS18x20_Devices              (const char* pSensorID);

    bool            Get_DS18x20_Temperature         (const char* pSensorID, double& temperature, bool& bCRC, long& t_duration_ms);




    // ************************************************************************************************
    // Deprecated functions
    // ************************************************************************************************

    // Used for testing purposes only.
    // Measures 2000 analog values while switching relays at the same time. 
    // Min and max values are printed out afterwards.
    void            Test_AD_Board                   ();

} // namespace HuboLib




namespace BCM2835
{

    // ************************************************************************************************
    // BCM2835 GPIO 
    // ************************************************************************************************

    enum FunctionSelectType
    {
        Input       = 0x00,   
        Output      = 0x01,   
        Alternate0  = 0x04,   
        Alternate1  = 0x05,   
        Alternate2  = 0x06,   
        Alternate3  = 0x07,   
        Alternate4  = 0x03,   
        Alternate5  = 0x02,   
        FSEL_MASK   = 0x07    
    };

    enum PullUpDownType
    {
        PUD_OFF     = 0x00,   
        PUD_DOWN    = 0x01,   
        PUD_UP      = 0x02    
    };

    bool            IsGPIOInitialized               ();

    void            FunctionSelectPin               (unsigned char pin, FunctionSelectType mode);
    
    void            WritePin                        (unsigned char pin, unsigned char value);

    void            SetPin                          (unsigned char pin);

    void            ClearPin                        (unsigned char pin);

    void            SetPullUpDown                   (unsigned char pin, PullUpDownType pud);

    unsigned short  ReadPin                         (unsigned short pin);

} // namespace BCM2835
        
#endif // HUBOLIB_H