driver_tsl2561.h

Go to the documentation of this file.

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



typedef enum
{
    TSL2561_ADDRESS_GND   = 0x52,        
    TSL2561_ADDRESS_FLOAT = 0x72,        
    TSL2561_ADDRESS_VCC   = 0x92,        
} tsl2561_address_t;

typedef enum
{
    TSL2561_BOOL_FALSE = 0x00,        
    TSL2561_BOOL_TRUE  = 0x01,        
} tsl2561_bool_t;

typedef enum
{
    TSL2561_GAIN_1  = 0x00,        
    TSL2561_GAIN_16 = 0x01,        
} tsl2561_gain_t;

typedef enum
{
    TSL2561_INTEGRATION_TIME_13MS  = 0x00,        
    TSL2561_INTEGRATION_TIME_101MS = 0x01,        
    TSL2561_INTEGRATION_TIME_402MS = 0x02,        
} tsl2561_integration_time_t;



typedef enum
{
    TSL2561_INTERRUPT_MODE_EVERY_ADC_CYCLE                  = 0x00,        
    TSL2561_INTERRUPT_MODE_ANY_VALUE_OUT_OF_THRESHOLD_RANGE = 0x01,        
    TSL2561_INTERRUPT_MODE_2_INTEGRATION_TIME_OUT_OF_RANGE  = 0x02,        
    TSL2561_INTERRUPT_MODE_3_INTEGRATION_TIME_OUT_OF_RANGE  = 0x03,        
    TSL2561_INTERRUPT_MODE_4_INTEGRATION_TIME_OUT_OF_RANGE  = 0x04,        
    TSL2561_INTERRUPT_MODE_5_INTEGRATION_TIME_OUT_OF_RANGE  = 0x05,        
    TSL2561_INTERRUPT_MODE_6_INTEGRATION_TIME_OUT_OF_RANGE  = 0x06,        
    TSL2561_INTERRUPT_MODE_7_INTEGRATION_TIME_OUT_OF_RANGE  = 0x07,        
    TSL2561_INTERRUPT_MODE_8_INTEGRATION_TIME_OUT_OF_RANGE  = 0x08,        
    TSL2561_INTERRUPT_MODE_9_INTEGRATION_TIME_OUT_OF_RANGE  = 0x09,        
    TSL2561_INTERRUPT_MODE_10_INTEGRATION_TIME_OUT_OF_RANGE = 0x0A,        
    TSL2561_INTERRUPT_MODE_11_INTEGRATION_TIME_OUT_OF_RANGE = 0x0B,        
    TSL2561_INTERRUPT_MODE_12_INTEGRATION_TIME_OUT_OF_RANGE = 0x0C,        
    TSL2561_INTERRUPT_MODE_13_INTEGRATION_TIME_OUT_OF_RANGE = 0x0D,        
    TSL2561_INTERRUPT_MODE_14_INTEGRATION_TIME_OUT_OF_RANGE = 0x0E,        
    TSL2561_INTERRUPT_MODE_15_INTEGRATION_TIME_OUT_OF_RANGE = 0x0F,        
} tsl2561_interrupt_mode_t;



typedef struct tsl2561_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 inited;                                                                     
} tsl2561_handle_t;

typedef struct tsl2561_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;           
} tsl2561_info_t;



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

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

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

#define DRIVER_TSL2561_LINK_IIC_READ(HANDLE, FUC)    (HANDLE)->iic_read = FUC

#define DRIVER_TSL2561_LINK_IIC_WRITE(HANDLE, FUC)   (HANDLE)->iic_write = FUC

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

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



uint8_t tsl2561_info(tsl2561_info_t *info);

uint8_t tsl2561_set_addr_pin(tsl2561_handle_t *handle, tsl2561_address_t addr_pin);

uint8_t tsl2561_get_addr_pin(tsl2561_handle_t *handle, tsl2561_address_t *addr_pin);

uint8_t tsl2561_init(tsl2561_handle_t *handle);

uint8_t tsl2561_deinit(tsl2561_handle_t *handle);

uint8_t tsl2561_read(tsl2561_handle_t *handle, uint16_t *channel_0_raw, uint16_t *channel_1_raw, uint32_t *lux);

uint8_t tsl2561_power_down(tsl2561_handle_t *handle);

uint8_t tsl2561_wake_up(tsl2561_handle_t *handle);

uint8_t tsl2561_set_gain(tsl2561_handle_t *handle, tsl2561_gain_t gain);

uint8_t tsl2561_get_gain(tsl2561_handle_t *handle, tsl2561_gain_t *gain);

uint8_t tsl2561_set_integration_time(tsl2561_handle_t *handle, tsl2561_integration_time_t t);

uint8_t tsl2561_get_integration_time(tsl2561_handle_t *handle, tsl2561_integration_time_t *t);



uint8_t tsl2561_set_interrupt_mode(tsl2561_handle_t *handle, tsl2561_interrupt_mode_t mode);

uint8_t tsl2561_get_interrupt_mode(tsl2561_handle_t *handle, tsl2561_interrupt_mode_t *mode);

uint8_t tsl2561_set_interrupt(tsl2561_handle_t *handle, tsl2561_bool_t enable);

uint8_t tsl2561_get_interrupt(tsl2561_handle_t *handle, tsl2561_bool_t *enable);

uint8_t tsl2561_set_interrupt_high_threshold(tsl2561_handle_t *handle, uint16_t ch0_raw);

uint8_t tsl2561_get_interrupt_high_threshold(tsl2561_handle_t *handle, uint16_t *ch0_raw);

uint8_t tsl2561_set_interrupt_low_threshold(tsl2561_handle_t *handle, uint16_t ch0_raw);

uint8_t tsl2561_get_interrupt_low_threshold(tsl2561_handle_t *handle, uint16_t *ch0_raw);



uint8_t tsl2561_set_reg(tsl2561_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t tsl2561_get_reg(tsl2561_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif