driver_cs1237.h

Go to the documentation of this file.

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



#ifndef CS1237_COMMAND_DATA_DELAY
    #define CS1237_COMMAND_DATA_DELAY        5        
#endif

typedef enum
{
    CS1237_BOOL_FALSE = 0x00,        
    CS1237_BOOL_TRUE  = 0x01,        
} cs1237_bool_t;

typedef enum
{
    CS1237_ADC_RATE_10HZ   = 0x00,        
    CS1237_ADC_RATE_40HZ   = 0x01,        
    CS1237_ADC_RATE_640HZ  = 0x02,        
    CS1237_ADC_RATE_1280HZ = 0x03,        
} cs1237_adc_rate_t;

typedef enum
{
    CS1237_PGA_1   = 0x00,        
    CS1237_PGA_2   = 0x01,        
    CS1237_PGA_64  = 0x02,        
    CS1237_PGA_128 = 0x03,        
} cs1237_pga_t;

typedef enum
{
    CS1237_CHANNEL_A             = 0x00,        
    CS1237_CHANNEL_TEMPERATURE   = 0x02,        
    CS1237_CHANNEL_SHORT_CIRCUIT = 0x03,        
} cs1237_channel_t;

typedef struct cs1237_handle_s
{
    uint8_t (*sclk_gpio_init)(void);                        
    uint8_t (*sclk_gpio_deinit)(void);                      
    uint8_t (*sclk_gpio_write)(uint8_t level);              
    uint8_t (*dout_gpio_init)(void);                        
    uint8_t (*dout_gpio_deinit)(void);                      
    uint8_t (*dout_gpio_write)(uint8_t level);              
    uint8_t (*dout_gpio_read)(uint8_t *level);              
    void (*delay_us)(uint32_t us);                          
    void (*delay_ms)(uint32_t ms);                          
    void (*debug_print)(const char *const fmt, ...);        
    uint8_t pga;                                            
    uint8_t channel;                                        
    int32_t temperature_raw;                                
    float temperature_deg;                                  
    float reference_voltage_v;                              
    uint8_t inited;                                         
} cs1237_handle_t;

typedef struct cs1237_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;           
} cs1237_info_t;



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

#define DRIVER_CS1237_LINK_SCLK_GPIO_INIT(HANDLE, FUC)             (HANDLE)->sclk_gpio_init = FUC

#define DRIVER_CS1237_LINK_SCLK_GPIO_DEINIT(HANDLE, FUC)           (HANDLE)->sclk_gpio_deinit = FUC

#define DRIVER_CS1237_LINK_SCLK_GPIO_WRITE(HANDLE, FUC)            (HANDLE)->sclk_gpio_write = FUC

#define DRIVER_CS1237_LINK_DOUT_GPIO_INIT(HANDLE, FUC)             (HANDLE)->dout_gpio_init = FUC

#define DRIVER_CS1237_LINK_DOUT_GPIO_DEINIT(HANDLE, FUC)           (HANDLE)->dout_gpio_deinit = FUC

#define DRIVER_CS1237_LINK_DOUT_GPIO_WRITE(HANDLE, FUC)            (HANDLE)->dout_gpio_write = FUC

#define DRIVER_CS1237_LINK_DOUT_GPIO_READ(HANDLE, FUC)             (HANDLE)->dout_gpio_read = FUC

#define DRIVER_CS1237_LINK_DELAY_US(HANDLE, FUC)                   (HANDLE)->delay_us = FUC

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

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



uint8_t cs1237_info(cs1237_info_t *info);

uint8_t cs1237_set_reference_voltage(cs1237_handle_t *handle, float volt);

uint8_t cs1237_get_reference_voltage(cs1237_handle_t *handle, float *volt);

uint8_t cs1237_set_temperature_calibration_point(cs1237_handle_t *handle, int32_t temperature_raw, float temperature_deg);

uint8_t cs1237_get_temperature_calibration_point(cs1237_handle_t *handle, int32_t *temperature_raw, float *temperature_deg);

uint8_t cs1237_init(cs1237_handle_t *handle);

uint8_t cs1237_deinit(cs1237_handle_t *handle);

uint8_t cs1237_read(cs1237_handle_t *handle, int32_t *raw, double *mv);

uint8_t cs1237_read_temperature(cs1237_handle_t *handle, int32_t *raw, float *degrees);

uint8_t cs1237_wake_up(cs1237_handle_t *handle);

uint8_t cs1237_power_down(cs1237_handle_t *handle);

uint8_t cs1237_set_reference_voltage_output(cs1237_handle_t *handle, cs1237_bool_t enable);

uint8_t cs1237_get_reference_voltage_output(cs1237_handle_t *handle, cs1237_bool_t *enable);

uint8_t cs1237_set_adc_rate(cs1237_handle_t *handle, cs1237_adc_rate_t rate);

uint8_t cs1237_get_adc_rate(cs1237_handle_t *handle, cs1237_adc_rate_t *rate);

uint8_t cs1237_set_pga(cs1237_handle_t *handle, cs1237_pga_t pga);

uint8_t cs1237_get_pga(cs1237_handle_t *handle, cs1237_pga_t *pga);

uint8_t cs1237_set_channel(cs1237_handle_t *handle, cs1237_channel_t channel);

uint8_t cs1237_get_channel(cs1237_handle_t *handle, cs1237_channel_t *channel);



uint8_t cs1237_set_command(cs1237_handle_t *handle, uint8_t command, uint8_t config);

uint8_t cs1237_get_command(cs1237_handle_t *handle, uint8_t command, uint8_t *config);

uint8_t cs1237_get_data(cs1237_handle_t *handle, int32_t *data);


 
#ifdef __cplusplus
}
#endif
 
#endif