driver_ads1118.h

Go to the documentation of this file.

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



typedef enum
{
    ADS1118_BOOL_FALSE = 0x00,        
    ADS1118_BOOL_TRUE  = 0x01,        
} ads1118_bool_t;

typedef enum
{
    ADS1118_RANGE_6P144V = 0x00,        
    ADS1118_RANGE_4P096V = 0x01,        
    ADS1118_RANGE_2P048V = 0x02,        
    ADS1118_RANGE_1P024V = 0x03,        
    ADS1118_RANGE_0P512V = 0x04,        
    ADS1118_RANGE_0P256V = 0x05,        
} ads1118_range_t;

typedef enum
{
    ADS1118_RATE_8SPS   = 0x00,        
    ADS1118_RATE_16SPS  = 0x01,        
    ADS1118_RATE_32SPS  = 0x02,        
    ADS1118_RATE_64SPS  = 0x03,        
    ADS1118_RATE_128SPS = 0x04,        
    ADS1118_RATE_250SPS = 0x05,        
    ADS1118_RATE_475SPS = 0x06,        
    ADS1118_RATE_860SPS = 0x07,        
} ads1118_rate_t;

typedef enum
{
    ADS1118_CHANNEL_AIN0_AIN1 = 0x00,        
    ADS1118_CHANNEL_AIN0_AIN3 = 0x01,        
    ADS1118_CHANNEL_AIN1_AIN3 = 0x02,        
    ADS1118_CHANNEL_AIN2_AIN3 = 0x03,        
    ADS1118_CHANNEL_AIN0_GND  = 0x04,        
    ADS1118_CHANNEL_AIN1_GND  = 0x05,        
    ADS1118_CHANNEL_AIN2_GND  = 0x06,        
    ADS1118_CHANNEL_AIN3_GND  = 0x07,        
} ads1118_channel_t;

typedef enum
{
    ADS1118_MODE_ADC         = 0x00,        
    ADS1118_MODE_TEMPERATURE = 0x01,        
} ads1118_mode_t;

typedef struct ads1118_handle_s
{
    uint8_t (*spi_init)(void);                                              
    uint8_t (*spi_deinit)(void);                                            
    uint8_t (*spi_transmit)(uint8_t *tx, uint8_t *rx, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                                          
    void (*debug_print)(const char *const fmt, ...);                        
    uint8_t inited;                                                         
} ads1118_handle_t;

typedef struct ads1118_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;           
} ads1118_info_t;



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

#define DRIVER_ADS1118_LINK_SPI_INIT(HANDLE, FUC)               (HANDLE)->spi_init = FUC

#define DRIVER_ADS1118_LINK_SPI_DEINIT(HANDLE, FUC)             (HANDLE)->spi_deinit = FUC

#define DRIVER_ADS1118_LINK_SPI_TRANSMIT(HANDLE, FUC)           (HANDLE)->spi_transmit = FUC

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

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



uint8_t ads1118_info(ads1118_info_t *info);

uint8_t ads1118_init(ads1118_handle_t *handle);

uint8_t ads1118_deinit(ads1118_handle_t *handle);

uint8_t ads1118_single_read(ads1118_handle_t *handle, int16_t *raw, float *v);

uint8_t ads1118_continuous_read(ads1118_handle_t *handle, int16_t *raw, float *v);

uint8_t ads1118_start_continuous_read(ads1118_handle_t *handle);

uint8_t ads1118_stop_continuous_read(ads1118_handle_t *handle);

uint8_t ads1118_temperature_convert(ads1118_handle_t *handle, int16_t raw, float *deg);

uint8_t ads1118_set_channel(ads1118_handle_t *handle, ads1118_channel_t channel);

uint8_t ads1118_get_channel(ads1118_handle_t *handle, ads1118_channel_t *channel);

uint8_t ads1118_set_range(ads1118_handle_t *handle, ads1118_range_t range);

uint8_t ads1118_get_range(ads1118_handle_t *handle, ads1118_range_t *range);

uint8_t ads1118_set_rate(ads1118_handle_t *handle, ads1118_rate_t rate);

uint8_t ads1118_get_rate(ads1118_handle_t *handle, ads1118_rate_t *rate);

uint8_t ads1118_set_mode(ads1118_handle_t *handle, ads1118_mode_t mode);

uint8_t ads1118_get_mode(ads1118_handle_t *handle, ads1118_mode_t *mode);

uint8_t ads1118_set_dout_pull_up(ads1118_handle_t *handle, ads1118_bool_t enable);

uint8_t ads1118_get_dout_pull_up(ads1118_handle_t *handle, ads1118_bool_t *enable);



uint8_t ads1118_transmit(ads1118_handle_t *handle, uint8_t *tx, uint8_t *rx, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif