driver_tcs34725.h

Go to the documentation of this file.

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



typedef enum
{
    TCS34725_BOOL_FALSE = 0x00,        
    TCS34725_BOOL_TRUE  = 0x01,        
} tcs34725_bool_t;

typedef enum
{
    TCS34725_INTEGRATION_TIME_2P4MS = 0xFF,        
    TCS34725_INTEGRATION_TIME_24MS  = 0xF6,        
    TCS34725_INTEGRATION_TIME_50MS  = 0xEB,        
    TCS34725_INTEGRATION_TIME_101MS = 0xD5,        
    TCS34725_INTEGRATION_TIME_154MS = 0xC0,        
    TCS34725_INTEGRATION_TIME_700MS = 0x00,        
} tcs34725_integration_time_t;

typedef enum
{
    TCS34725_GAIN_1X  = 0x00,        
    TCS34725_GAIN_4X  = 0x01,        
    TCS34725_GAIN_16X = 0x02,        
    TCS34725_GAIN_60X = 0x03,        
} tcs34725_gain_t;    

typedef enum
{
    TCS34725_WAIT_TIME_2P4MS  = 0x0FF,        
    TCS34725_WAIT_TIME_204MS  = 0x0AB,        
    TCS34725_WAIT_TIME_614MS  = 0x000,        
    TCS34725_WAIT_TIME_29MS   = 0x1FF,        
    TCS34725_WAIT_TIME_2450MS = 0x1AB,        
    TCS34725_WAIT_TIME_7400MS = 0x100,        
} tcs34725_wait_time_t;



typedef enum  
{
    TCS34725_INTERRUPT_MODE_EVERY_RGBC_CYCLE                  = 0x00,        
    TCS34725_INTERRUPT_MODE_1_CLEAR_CHANNEL_OUT_OF_THRESHOLD  = 0x01,        
    TCS34725_INTERRUPT_MODE_2_CLEAR_CHANNEL_OUT_OF_THRESHOLD  = 0x02,        
    TCS34725_INTERRUPT_MODE_3_CLEAR_CHANNEL_OUT_OF_THRESHOLD  = 0x03,        
    TCS34725_INTERRUPT_MODE_5_CLEAR_CHANNEL_OUT_OF_THRESHOLD  = 0x04,        
    TCS34725_INTERRUPT_MODE_10_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x05,        
    TCS34725_INTERRUPT_MODE_15_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x06,        
    TCS34725_INTERRUPT_MODE_20_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x07,        
    TCS34725_INTERRUPT_MODE_25_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x08,        
    TCS34725_INTERRUPT_MODE_30_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x09,        
    TCS34725_INTERRUPT_MODE_35_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0A,        
    TCS34725_INTERRUPT_MODE_40_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0B,        
    TCS34725_INTERRUPT_MODE_45_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0C,        
    TCS34725_INTERRUPT_MODE_50_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0D,        
    TCS34725_INTERRUPT_MODE_55_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0E,        
    TCS34725_INTERRUPT_MODE_60_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0F,        
} tcs34725_interrupt_mode_t;



typedef struct tcs34725_handle_s
{
    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;                                                                    
} tcs34725_handle_t;

typedef struct tcs34725_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;           
} tcs34725_info_t;



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

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

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

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

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

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

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



uint8_t tcs34725_info(tcs34725_info_t *info);

uint8_t tcs34725_init(tcs34725_handle_t *handle);

uint8_t tcs34725_deinit(tcs34725_handle_t *handle);

uint8_t tcs34725_read_rgbc(tcs34725_handle_t *handle, uint16_t *red, uint16_t *green, uint16_t *blue, uint16_t *clear);

uint8_t tcs34725_read_rgb(tcs34725_handle_t *handle, uint16_t *red, uint16_t *green, uint16_t *blue);

uint8_t tcs34725_read_c(tcs34725_handle_t *handle, uint16_t *clear);

uint8_t tcs34725_set_wait(tcs34725_handle_t *handle, tcs34725_bool_t enable);

uint8_t tcs34725_get_wait(tcs34725_handle_t *handle, tcs34725_bool_t *enable);

uint8_t tcs34725_set_rgbc(tcs34725_handle_t *handle, tcs34725_bool_t enable);

uint8_t tcs34725_get_rgbc(tcs34725_handle_t *handle, tcs34725_bool_t *enable);

uint8_t tcs34725_set_power_on(tcs34725_handle_t *handle, tcs34725_bool_t enable);

uint8_t tcs34725_get_power_on(tcs34725_handle_t *handle, tcs34725_bool_t *enable);

uint8_t tcs34725_set_rgbc_integration_time(tcs34725_handle_t *handle, tcs34725_integration_time_t t);

uint8_t tcs34725_get_rgbc_integration_time(tcs34725_handle_t *handle, tcs34725_integration_time_t *t);

uint8_t tcs34725_set_wait_time(tcs34725_handle_t *handle, tcs34725_wait_time_t t);

uint8_t tcs34725_get_wait_time(tcs34725_handle_t *handle, tcs34725_wait_time_t *t);

uint8_t tcs34725_set_gain(tcs34725_handle_t *handle, tcs34725_gain_t gain);

uint8_t tcs34725_get_gain(tcs34725_handle_t *handle, tcs34725_gain_t *gain);



uint8_t tcs34725_set_rgbc_interrupt(tcs34725_handle_t *handle, tcs34725_bool_t enable);

uint8_t tcs34725_get_rgbc_interrupt(tcs34725_handle_t *handle, tcs34725_bool_t *enable);

uint8_t tcs34725_set_interrupt_mode(tcs34725_handle_t *handle, tcs34725_interrupt_mode_t mode);

uint8_t tcs34725_get_interrupt_mode(tcs34725_handle_t *handle, tcs34725_interrupt_mode_t *mode);

uint8_t tcs34725_set_rgbc_clear_low_interrupt_threshold(tcs34725_handle_t *handle, uint16_t threshold);

uint8_t tcs34725_get_rgbc_clear_low_interrupt_threshold(tcs34725_handle_t *handle, uint16_t *threshold);

uint8_t tcs34725_set_rgbc_clear_high_interrupt_threshold(tcs34725_handle_t *handle, uint16_t threshold);

uint8_t tcs34725_get_rgbc_clear_high_interrupt_threshold(tcs34725_handle_t *handle, uint16_t *threshold);



uint8_t tcs34725_set_reg(tcs34725_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t tcs34725_get_reg(tcs34725_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif