driver_mlx90614.h

Go to the documentation of this file.

 
#ifndef DRIVER_MLX90614_H
#define DRIVER_MLX90614_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif
 
typedef enum
{
    MLX90614_ADDRESS_DEFAULT = 0xB4,        
} mlx90614_address_t;
 
typedef enum
{
    MLX90614_FLAG_EE_BUSY = (1 << 7),        
    MLX90614_FLAG_EE_DEAD = (1 << 5),        
    MLX90614_FLAG_INIT    = (1 << 4),        
} mlx90614_flag_t;
 
typedef enum
{
    MLX90614_MODE_TA_TOBJ1    = 0x00,        
    MLX90614_MODE_TA_TOBJ2    = 0x01,        
    MLX90614_MODE_TOBJ2       = 0x02,        
    MLX90614_MODE_TOBJ1_TOBJ2 = 0x03,        
} mlx90614_mode_t;
 
typedef enum
{
    MLX90614_GAIN_1    = 0x00,        
    MLX90614_GAIN_3    = 0x01,        
    MLX90614_GAIN_6    = 0x02,        
    MLX90614_GAIN_12P5 = 0x03,        
    MLX90614_GAIN_25   = 0x04,        
    MLX90614_GAIN_50   = 0x05,        
    MLX90614_GAIN_100  = 0x06,        
} mlx90614_gain_t;
 
typedef enum
{
    MLX90614_BOOL_FALSE = 0x00,        
    MLX90614_BOOL_TRUE  = 0x01,        
} mlx90614_bool_t;
 
typedef enum
{
    MLX90614_KT2_POSITIVE = 0x00,        
    MLX90614_KT2_NEGATIVE = 0x01,        
} mlx90614_kt2_t;
 
typedef enum
{
    MLX90614_KS_POSITIVE = 0x00,
    MLX90614_KS_NEGATIVE = 0x01,
} mlx90614_ks_t;
 
typedef enum
{
    MLX90614_IR_SENSOR_SINGLE = 0x00,        
    MLX90614_IR_SENSOR_DUAL   = 0x01,        
} mlx90614_ir_sensor_t;
 
typedef enum
{
    MLX90614_FIR_LENGTH_8    = 0x00,        
    MLX90614_FIR_LENGTH_16   = 0x01,        
    MLX90614_FIR_LENGTH_32   = 0x02,        
    MLX90614_FIR_LENGTH_64   = 0x03,        
    MLX90614_FIR_LENGTH_128  = 0x04,        
    MLX90614_FIR_LENGTH_256  = 0x05,        
    MLX90614_FIR_LENGTH_512  = 0x06,        
    MLX90614_FIR_LENGTH_1024 = 0x07,        
} mlx90614_fir_length_t;
 
typedef enum
{
    MLX90614_IIR_A1_0P5_B1_0P5     = 0x00,        
    MLX90614_IIR_A1_0P25_B1_0P75   = 0x01,        
    MLX90614_IIR_A1_0P166_B1_0P83  = 0x02,        
    MLX90614_IIR_A1_0P125_B1_0P875 = 0x03,        
    MLX90614_IIR_A1_1_B1_0         = 0x04,        
    MLX90614_IIR_A1_0P8_B1_0P2     = 0x05,        
    MLX90614_IIR_A1_0P666_B1_0P333 = 0x06,        
    MLX90614_IIR_A1_0P571_B1_0P428 = 0x07,        
} mlx90614_iir_t;
 
typedef struct mlx90614_handle_s
{
    uint8_t iic_addr;                                                                   
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    uint8_t (*scl_write)(uint8_t v);                                                    
    uint8_t (*sda_write)(uint8_t v);                                                    
    uint8_t inited;                                                                     
} mlx90614_handle_t;
 
typedef struct mlx90614_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;           
} mlx90614_info_t;
 
#define DRIVER_MLX90614_LINK_INIT(HANDLE, STRUCTURE)         memset(HANDLE, 0, sizeof(STRUCTURE))
 
#define DRIVER_MLX90614_LINK_IIC_INIT(HANDLE, FUC)           (HANDLE)->iic_init = FUC
 
#define DRIVER_MLX90614_LINK_IIC_DEINIT(HANDLE, FUC)         (HANDLE)->iic_deinit = FUC
 
#define DRIVER_MLX90614_LINK_IIC_READ(HANDLE, FUC)           (HANDLE)->iic_read = FUC
 
#define DRIVER_MLX90614_LINK_IIC_WRITE(HANDLE, FUC)          (HANDLE)->iic_write = FUC
 
#define DRIVER_MLX90614_LINK_SCL_WRITE(HANDLE, FUC)          (HANDLE)->scl_write = FUC
 
#define DRIVER_MLX90614_LINK_SDA_WRITE(HANDLE, FUC)          (HANDLE)->sda_write = FUC
 
#define DRIVER_MLX90614_LINK_DELAY_MS(HANDLE, FUC)           (HANDLE)->delay_ms = FUC
 
#define DRIVER_MLX90614_LINK_DEBUG_PRINT(HANDLE, FUC)        (HANDLE)->debug_print = FUC
 
uint8_t mlx90614_info(mlx90614_info_t *info);
 
uint8_t mlx90614_set_addr(mlx90614_handle_t *handle, uint8_t addr);
 
uint8_t mlx90614_get_addr(mlx90614_handle_t *handle, uint8_t *addr);
 
uint8_t mlx90614_init(mlx90614_handle_t *handle);
 
uint8_t mlx90614_deinit(mlx90614_handle_t *handle);
 
uint8_t mlx90614_read_object1(mlx90614_handle_t *handle, uint16_t *raw, float *celsius);
 
uint8_t mlx90614_read_object2(mlx90614_handle_t *handle, uint16_t *raw, float *celsius);
 
uint8_t mlx90614_read_raw_ir_channel(mlx90614_handle_t *handle, uint16_t *channel_1, uint16_t *channel_2);
 
uint8_t mlx90614_read_ambient(mlx90614_handle_t *handle, uint16_t *raw, float *celsius);
 
uint8_t mlx90614_write_addr(mlx90614_handle_t *handle, uint8_t addr);
 
uint8_t mlx90614_read_addr(mlx90614_handle_t *handle, uint8_t *addr);
 
uint8_t mlx90614_set_fir_length(mlx90614_handle_t *handle, mlx90614_fir_length_t len);
 
uint8_t mlx90614_get_fir_length(mlx90614_handle_t *handle, mlx90614_fir_length_t *len);
 
uint8_t mlx90614_set_iir(mlx90614_handle_t *handle, mlx90614_iir_t iir);
 
uint8_t mlx90614_get_iir(mlx90614_handle_t *handle, mlx90614_iir_t *iir);
 
uint8_t mlx90614_set_mode(mlx90614_handle_t *handle, mlx90614_mode_t mode);
 
uint8_t mlx90614_get_mode(mlx90614_handle_t *handle, mlx90614_mode_t *mode);
 
uint8_t mlx90614_set_ir_sensor(mlx90614_handle_t *handle, mlx90614_ir_sensor_t sensor);
 
uint8_t mlx90614_get_ir_sensor(mlx90614_handle_t *handle, mlx90614_ir_sensor_t *sensor);
 
uint8_t mlx90614_set_ks(mlx90614_handle_t *handle, mlx90614_ks_t ks);
 
uint8_t mlx90614_get_ks(mlx90614_handle_t *handle, mlx90614_ks_t *ks);
 
uint8_t mlx90614_set_kt2(mlx90614_handle_t *handle, mlx90614_kt2_t kt2);
 
uint8_t mlx90614_get_kt2(mlx90614_handle_t *handle, mlx90614_kt2_t *kt2);
 
uint8_t mlx90614_set_gain(mlx90614_handle_t *handle, mlx90614_gain_t gain);
 
uint8_t mlx90614_get_gain(mlx90614_handle_t *handle, mlx90614_gain_t *gain);
 
uint8_t mlx90614_set_sensor_test(mlx90614_handle_t *handle, mlx90614_bool_t enable);
 
uint8_t mlx90614_get_sensor_test(mlx90614_handle_t *handle, mlx90614_bool_t *enable);
 
uint8_t mlx90614_set_repeat_sensor_test(mlx90614_handle_t *handle, mlx90614_bool_t enable);
 
uint8_t mlx90614_get_repeat_sensor_test(mlx90614_handle_t *handle, mlx90614_bool_t *enable);
 
uint8_t mlx90614_set_emissivity_correction_coefficient(mlx90614_handle_t *handle, uint16_t value);
 
uint8_t mlx90614_get_emissivity_correction_coefficient(mlx90614_handle_t *handle, uint16_t *value);
 
uint8_t mlx90614_emissivity_correction_coefficient_convert_to_register(mlx90614_handle_t *handle, double s, uint16_t *reg);
 
uint8_t mlx90614_emissivity_correction_coefficient_convert_to_data(mlx90614_handle_t *handle, uint16_t reg, double *s);
 
uint8_t mlx90614_get_id(mlx90614_handle_t *handle, uint16_t id[4]);
 
uint8_t mlx90614_enter_sleep_mode(mlx90614_handle_t *handle);
 
uint8_t mlx90614_exit_sleep_mode(mlx90614_handle_t *handle);
 
uint8_t mlx90614_get_flag(mlx90614_handle_t *handle, uint16_t *flag);
 
uint8_t mlx90614_pwm_to_smbus(mlx90614_handle_t *handle);
 
uint8_t mlx90614_set_reg(mlx90614_handle_t *handle, uint8_t reg, uint16_t data);
 
uint8_t mlx90614_get_reg(mlx90614_handle_t *handle, uint8_t reg, uint16_t *data);
 
#ifdef __cplusplus
}
#endif
 
#endif