driver_pcf8591.h

Go to the documentation of this file.

 
#ifndef DRIVER_PCF8591_H
#define DRIVER_PCF8591_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    PCF8591_ADDRESS_A000 = 0,        
    PCF8591_ADDRESS_A001 = 1,        
    PCF8591_ADDRESS_A010 = 2,        
    PCF8591_ADDRESS_A011 = 3,        
    PCF8591_ADDRESS_A100 = 4,        
    PCF8591_ADDRESS_A101 = 5,        
    PCF8591_ADDRESS_A110 = 6,        
    PCF8591_ADDRESS_A111 = 7,        
} pcf8591_address_t;

typedef enum
{
    PCF8591_BOOL_FALSE = 0x00,        
    PCF8591_BOOL_TRUE  = 0x01,        
} pcf8591_bool_t;

typedef enum  
{
    PCF8591_CHANNEL_0 = 0x00,        
    PCF8591_CHANNEL_1 = 0x01,        
    PCF8591_CHANNEL_2 = 0x02,        
    PCF8591_CHANNEL_3 = 0x03,        
} pcf8591_channel_t;

typedef enum  
{
    PCF8591_MODE_AIN0123_GND                         = 0x00,        
    PCF8591_MODE_AIN012_AIN3                         = 0x01,        
    PCF8591_MODE_AIN0_GND_AND_AIN1_GND_AND_AIN2_AIN3 = 0x02,        
    PCF8591_MODE_AIN0_AIN1_AND_ANI2_AIN3             = 0x03,        
} pcf8591_mode_t;

typedef struct pcf8591_handle_s
{
    uint8_t iic_addr;                                                          
    uint8_t (*iic_init)(void);                                                 
    uint8_t (*iic_deinit)(void);                                               
    uint8_t (*iic_read_cmd)(uint8_t addr, uint8_t *buf, uint16_t len);         
    uint8_t (*iic_write_cmd)(uint8_t addr, uint8_t *buf, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                                             
    void (*debug_print)(const char *const fmt, ...);                           
    uint8_t inited;                                                            
    uint8_t conf;                                                              
    float ref_voltage;                                                         
} pcf8591_handle_t;

typedef struct pcf8591_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} pcf8591_info_t;



#define DRIVER_PCF8591_LINK_INIT(HANDLE, STRUCTURE)           memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_PCF8591_LINK_IIC_INIT(HANDLE, FUC)            (HANDLE)->iic_init = FUC

#define DRIVER_PCF8591_LINK_IIC_DEINIT(HANDLE, FUC)          (HANDLE)->iic_deinit = FUC

#define DRIVER_PCF8591_LINK_IIC_READ_COMMAND(HANDLE, FUC)    (HANDLE)->iic_read_cmd = FUC

#define DRIVER_PCF8591_LINK_IIC_WRITE_COMMAND(HANDLE, FUC)   (HANDLE)->iic_write_cmd = FUC

#define DRIVER_PCF8591_LINK_DELAY_MS(HANDLE, FUC)            (HANDLE)->delay_ms = FUC

#define DRIVER_PCF8591_LINK_DEBUG_PRINT(HANDLE, FUC)         (HANDLE)->debug_print = FUC



uint8_t pcf8591_info(pcf8591_info_t *info);

uint8_t pcf8591_set_addr_pin(pcf8591_handle_t *handle, pcf8591_address_t addr_pin);

uint8_t pcf8591_get_addr_pin(pcf8591_handle_t *handle, pcf8591_address_t *addr_pin);

uint8_t pcf8591_init(pcf8591_handle_t *handle);

uint8_t pcf8591_deinit(pcf8591_handle_t *handle);

uint8_t pcf8591_read(pcf8591_handle_t *handle, int16_t *raw, float *adc);

uint8_t pcf8591_multiple_read(pcf8591_handle_t *handle, int16_t *raw, float *adc, uint8_t *len);

uint8_t pcf8591_write(pcf8591_handle_t *handle, uint8_t data);

uint8_t pcf8591_dac_convert_to_register(pcf8591_handle_t *handle, float dac, uint8_t *reg);

uint8_t pcf8591_set_reference_voltage(pcf8591_handle_t *handle, float ref_voltage);

uint8_t pcf8591_get_reference_voltage(pcf8591_handle_t *handle, float *ref_voltage);

uint8_t pcf8591_set_channel(pcf8591_handle_t *handle, pcf8591_channel_t channel);

uint8_t pcf8591_get_channel(pcf8591_handle_t *handle, pcf8591_channel_t *channel);

uint8_t pcf8591_set_mode(pcf8591_handle_t *handle, pcf8591_mode_t mode);

uint8_t pcf8591_get_mode(pcf8591_handle_t *handle, pcf8591_mode_t *mode);

uint8_t pcf8591_set_auto_increment(pcf8591_handle_t *handle, pcf8591_bool_t enable);

uint8_t pcf8591_get_auto_increment(pcf8591_handle_t *handle, pcf8591_bool_t *enable);



uint8_t pcf8591_set_reg(pcf8591_handle_t *handle, uint8_t *buf, uint16_t len);

uint8_t pcf8591_get_reg(pcf8591_handle_t *handle, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif