driver_max31856.h

Go to the documentation of this file.

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



typedef enum
{
    MAX31856_BOOL_FALSE = 0x00,        
    MAX31856_BOOL_TRUE  = 0x01,        
} max31856_bool_t;

typedef enum
{
    MAX31856_OPEN_CIRCUIT_DETECTION_DISABLE = 0x00,        
    MAX31856_OPEN_CIRCUIT_DETECTION_MODE1   = 0x01,        
    MAX31856_OPEN_CIRCUIT_DETECTION_MODE2   = 0x02,        
    MAX31856_OPEN_CIRCUIT_DETECTION_MODE3   = 0x03,        
} max31856_open_circuit_detection_t;

typedef enum
{
    MAX31856_FAULT_MODE_COMPARATOR = 0x00,        
    MAX31856_FAULT_MODE_INTERRUPT  = 0x01,        
} max31856_fault_mode_t;

typedef enum
{
    MAX31856_NOISE_REJECTION_FILTER_60HZ = 0x00,        
    MAX31856_NOISE_REJECTION_FILTER_50HZ = 0x01,        
} max31856_noise_rejection_filter_t;

typedef enum
{
    MAX31856_SAMPLE_AVERAGE_1  = 0x00,        
    MAX31856_SAMPLE_AVERAGE_2  = 0x01,        
    MAX31856_SAMPLE_AVERAGE_4  = 0x02,        
    MAX31856_SAMPLE_AVERAGE_8  = 0x03,        
    MAX31856_SAMPLE_AVERAGE_16 = 0x04,        
} max31856_sample_average_t;

typedef enum
{
    MAX31856_THERMOCOUPLE_TYPE_B               = 0x00,        
    MAX31856_THERMOCOUPLE_TYPE_E               = 0x01,        
    MAX31856_THERMOCOUPLE_TYPE_J               = 0x02,        
    MAX31856_THERMOCOUPLE_TYPE_K               = 0x03,        
    MAX31856_THERMOCOUPLE_TYPE_N               = 0x04,        
    MAX31856_THERMOCOUPLE_TYPE_R               = 0x05,        
    MAX31856_THERMOCOUPLE_TYPE_S               = 0x06,        
    MAX31856_THERMOCOUPLE_TYPE_T               = 0x07,        
    MAX31856_THERMOCOUPLE_TYPE_VOLTAGE_GAIN_8  = 0x08,        
    MAX31856_THERMOCOUPLE_TYPE_VOLTAGE_GAIN_32 = 0x0C,        
} max31856_thermocouple_type_t;

typedef enum
{
    MAX31856_FAULT_MASK_CJHIGH = 5,        
    MAX31856_FAULT_MASK_CJLOW  = 4,        
    MAX31856_FAULT_MASK_TCHIGH = 3,        
    MAX31856_FAULT_MASK_TCLOW  = 2,        
    MAX31856_FAULT_MASK_OVUV   = 1,        
    MAX31856_FAULT_MASK_OPEN   = 0,        
} max31856_fault_mask_t;

typedef enum
{
    MAX31856_FAULT_STATUS_CJRANGE = (1 << 7),        
    MAX31856_FAULT_STATUS_TCRANGE = (1 << 6),        
    MAX31856_FAULT_STATUS_CJHIGH  = (1 << 5),        
    MAX31856_FAULT_STATUS_CJLOW   = (1 << 4),        
    MAX31856_FAULT_STATUS_TCHIGH  = (1 << 3),        
    MAX31856_FAULT_STATUS_TCLOW   = (1 << 2),        
    MAX31856_FAULT_STATUS_OVUV    = (1 << 1),        
    MAX31856_FAULT_STATUS_OPEN    = (1 << 0),        
} max31856_fault_status_t;

typedef struct max31856_handle_s
{
    uint8_t (*spi_init)(void);                                            
    uint8_t (*spi_deinit)(void);                                          
    uint8_t (*spi_read)(uint8_t reg, uint8_t *buf, uint16_t len);         
    uint8_t (*spi_write)(uint8_t reg, uint8_t *buf, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                                        
    void (*debug_print)(const char *const fmt, ...);                      
    void (*receive_callback)(uint8_t type);                               
    uint8_t inited;                                                       
} max31856_handle_t;

typedef struct max31856_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;           
} max31856_info_t;



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

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

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

#define DRIVER_MAX31856_LINK_SPI_READ(HANDLE, FUC)                (HANDLE)->spi_read = FUC

#define DRIVER_MAX31856_LINK_SPI_WRITE(HANDLE, FUC)               (HANDLE)->spi_write = FUC

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

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

#define DRIVER_MAX31856_LINK_RECEIVE_CALLBACK(HANDLE, FUC)        (HANDLE)->receive_callback = FUC



uint8_t max31856_info(max31856_info_t *info);

uint8_t max31856_irq_handler(max31856_handle_t *handle);

uint8_t max31856_init(max31856_handle_t *handle);

uint8_t max31856_deinit(max31856_handle_t *handle);

uint8_t max31856_single_read(max31856_handle_t *handle, int32_t *raw, double *deg);

uint8_t max31856_continuous_read(max31856_handle_t *handle, int32_t *raw, double *deg);

uint8_t max31856_start_continuous_read(max31856_handle_t *handle);

uint8_t max31856_stop_continuous_read(max31856_handle_t *handle);

uint8_t max31856_read_cold_junction_temperature(max31856_handle_t *handle, int16_t *raw, double *deg);

uint8_t max31856_set_open_circuit_detection(max31856_handle_t *handle, max31856_open_circuit_detection_t detection);

uint8_t max31856_get_open_circuit_detection(max31856_handle_t *handle, max31856_open_circuit_detection_t *detection);

uint8_t max31856_set_cold_junction_sensor(max31856_handle_t *handle, max31856_bool_t enable);

uint8_t max31856_get_cold_junction_sensor(max31856_handle_t *handle, max31856_bool_t *enable);

uint8_t max31856_set_fault_mode(max31856_handle_t *handle, max31856_fault_mode_t mode);

uint8_t max31856_get_fault_mode(max31856_handle_t *handle, max31856_fault_mode_t *mode);

uint8_t max31856_clear_fault(max31856_handle_t *handle);

uint8_t max31856_set_noise_rejection_filter(max31856_handle_t *handle, max31856_noise_rejection_filter_t filter);

uint8_t max31856_get_noise_rejection_filter(max31856_handle_t *handle, max31856_noise_rejection_filter_t *filter);

uint8_t max31856_set_sample_average(max31856_handle_t *handle, max31856_sample_average_t average);

uint8_t max31856_get_sample_average(max31856_handle_t *handle, max31856_sample_average_t *average);

uint8_t max31856_set_thermocouple_type(max31856_handle_t *handle, max31856_thermocouple_type_t type);

uint8_t max31856_get_thermocouple_type(max31856_handle_t *handle, max31856_thermocouple_type_t *type);

uint8_t max31856_set_fault_mask(max31856_handle_t *handle, max31856_fault_mask_t mask, max31856_bool_t enable);

uint8_t max31856_get_fault_mask(max31856_handle_t *handle, max31856_fault_mask_t mask, max31856_bool_t *enable);

uint8_t max31856_set_cold_junction_high_fault_threshold(max31856_handle_t *handle, int8_t threshold);

uint8_t max31856_get_cold_junction_high_fault_threshold(max31856_handle_t *handle, int8_t *threshold);

uint8_t max31856_set_cold_junction_low_fault_threshold(max31856_handle_t *handle, int8_t threshold);

uint8_t max31856_get_cold_junction_low_fault_threshold(max31856_handle_t *handle, int8_t *threshold);

uint8_t max31856_set_temperature_high_fault_threshold(max31856_handle_t *handle, int16_t threshold);

uint8_t max31856_get_temperature_high_fault_threshold(max31856_handle_t *handle, int16_t *threshold);

uint8_t max31856_set_temperature_low_fault_threshold(max31856_handle_t *handle, int16_t threshold);

uint8_t max31856_get_temperature_low_fault_threshold(max31856_handle_t *handle, int16_t *threshold);

uint8_t max31856_set_cold_junction_temperature_offset(max31856_handle_t *handle, int8_t offset);

uint8_t max31856_get_cold_junction_temperature_offset(max31856_handle_t *handle, int8_t *offset);

uint8_t max31856_set_cold_junction_temperature(max31856_handle_t *handle, int16_t temperature);

uint8_t max31856_get_cold_junction_temperature(max31856_handle_t *handle, int16_t *temperature);

uint8_t max31856_get_fault_status(max31856_handle_t *handle, uint8_t *status);

uint8_t max31856_cold_junction_fault_threshold_convert_to_register(max31856_handle_t *handle, float deg, int8_t *reg);

uint8_t max31856_cold_junction_fault_threshold_convert_to_data(max31856_handle_t *handle, int8_t reg, float *deg);

uint8_t max31856_temperature_fault_threshold_convert_to_register(max31856_handle_t *handle, float deg, int16_t *reg);

uint8_t max31856_temperature_fault_threshold_convert_to_data(max31856_handle_t *handle, int16_t reg, float *deg);

uint8_t max31856_cold_junction_temperature_offset_convert_to_register(max31856_handle_t *handle, float deg, int8_t *reg);

uint8_t max31856_cold_junction_temperature_offset_convert_to_data(max31856_handle_t *handle, int8_t reg, float *deg);

uint8_t max31856_cold_junction_temperature_convert_to_register(max31856_handle_t *handle, float deg, int16_t *reg);

uint8_t max31856_cold_junction_temperature_convert_to_data(max31856_handle_t *handle, int16_t reg, float *deg);



uint8_t max31856_set_reg(max31856_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t max31856_get_reg(max31856_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif