driver_opt300x.h

Go to the documentation of this file.

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



typedef enum
{
    OPT3001 = 0x01,        
    OPT3002 = 0x02,        
    OPT3004 = 0x04,        
    OPT3005 = 0x05,        
    OPT3006 = 0x06,        
    OPT3007 = 0x07,        
} opt300x_t;

typedef enum
{
    OPT300X_ADDRESS_GND = 0x88,        
    OPT300X_ADDRESS_VCC = 0x8A,        
    OPT300X_ADDRESS_SDA = 0x8C,        
    OPT300X_ADDRESS_SCL = 0x8E,        
} opt300x_address_t;

typedef enum
{
    OPT300X_BOOL_FALSE = 0x00,        
    OPT300X_BOOL_TRUE  = 0x01,        
} opt300x_bool_t;

typedef enum
{
    OPT300X_CONVERSION_TIME_100_MS = 0x00,        
    OPT300X_CONVERSION_TIME_800_MS = 0x01,        
} opt300x_conversion_time_t;

typedef enum
{
    OPT300X_INTERRUPT_POLARITY_LOW  = 0x00,        
    OPT300X_INTERRUPT_POLARITY_HIGH = 0x01,        
} opt300x_interrupt_polarity_t;

typedef enum
{
    OPT300X_FAULT_COUNT_ONE   = 0x00,        
    OPT300X_FAULT_COUNT_TWO   = 0x01,        
    OPT300X_FAULT_COUNT_FOUR  = 0x02,        
    OPT300X_FAULT_COUNT_EIGHT = 0x03,        
} opt300x_fault_count_t;

typedef enum
{
    OPT300X_RANGE_40P95_LUX    = 0x00,        
    OPT300X_RANGE_81P90_LUX    = 0x01,        
    OPT300X_RANGE_163P80_LUX   = 0x02,        
    OPT300X_RANGE_327P60_LUX   = 0x03,        
    OPT300X_RANGE_655P20_LUX   = 0x04,        
    OPT300X_RANGE_1310P40_LUX  = 0x05,        
    OPT300X_RANGE_2620P80_LUX  = 0x06,        
    OPT300X_RANGE_5241P60_LUX  = 0x07,        
    OPT300X_RANGE_10483P20_LUX = 0x08,        
    OPT300X_RANGE_20966P40_LUX = 0x09,        
    OPT300X_RANGE_41932P80_LUX = 0x0A,        
    OPT300X_RANGE_83865P60_LUX = 0x0B,        
    OPT300X_RANGE_AUTO         = 0x0C,        
} opt300x_range_t;

typedef enum
{
    OPT3002_RANGE_4914_NW_CM2     = 0x00,        
    OPT3002_RANGE_9828_NW_CM2     = 0x00,        
    OPT3002_RANGE_19656_NW_CM2    = 0x00,        
    OPT3002_RANGE_39312_NW_CM2    = 0x00,        
    OPT3002_RANGE_78624_NW_CM2    = 0x00,        
    OPT3002_RANGE_157248_NW_CM2   = 0x00,        
    OPT3002_RANGE_314496_NW_CM2   = 0x00,        
    OPT3002_RANGE_628992_NW_CM2   = 0x00,        
    OPT3002_RANGE_1257984_NW_CM2  = 0x00,        
    OPT3002_RANGE_2515968_NW_CM2  = 0x00,        
    OPT3002_RANGE_5031936_NW_CM2  = 0x00,        
    OPT3002_RANGE_10063872_NW_CM2 = 0x00,        
    OPT3002_RANGE_AUTO            = 0x0C,        
} opt3002_range_t;

typedef enum
{
    OPT3005_RANGE_81P90_LUX     = 0x00,        
    OPT3005_RANGE_163P80_LUX    = 0x01,        
    OPT3005_RANGE_327P60_LUX    = 0x02,        
    OPT3005_RANGE_655P20_LUX    = 0x03,        
    OPT3005_RANGE_1310P40_LUX   = 0x04,        
    OPT3005_RANGE_2620P80_LUX   = 0x05,        
    OPT3005_RANGE_5241P60_LUX   = 0x06,        
    OPT3005_RANGE_10483P20_LUX  = 0x07,        
    OPT3005_RANGE_20966P40_LUX  = 0x08,        
    OPT3005_RANGE_41932P80_LUX  = 0x09,        
    OPT3005_RANGE_83865P60_LUX  = 0x0A,        
    OPT3005_RANGE_167731P20_LUX = 0x0B,        
    OPT3005_RANGE_AUTO          = 0x0C,        
} opt3005_range_t;

typedef enum
{
    OPT300X_INTERRUPT_HIGH_LIMIT = 0x00,        
    OPT300X_INTERRUPT_LOW_LIMIT  = 0x01,        
} opt300x_interrupt_t;

typedef struct opt300x_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 (*receive_callback)(uint8_t type);                                             
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    uint8_t type;                                                                       
    uint8_t inited;                                                                     
} opt300x_handle_t;

typedef struct opt300x_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;           
} opt300x_info_t;



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

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

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

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

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

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

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

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



uint8_t opt300x_info(opt300x_info_t *info);

uint8_t opt300x_set_type(opt300x_handle_t *handle, opt300x_t type);

uint8_t opt300x_get_type(opt300x_handle_t *handle, opt300x_t *type);

uint8_t opt300x_set_addr_pin(opt300x_handle_t *handle, opt300x_address_t addr_pin);

uint8_t opt300x_get_addr_pin(opt300x_handle_t *handle, opt300x_address_t *addr_pin);

uint8_t opt300x_irq_handler(opt300x_handle_t *handle);

uint8_t opt300x_init(opt300x_handle_t *handle);

uint8_t opt300x_deinit(opt300x_handle_t *handle);

uint8_t opt300x_start_continuous_read(opt300x_handle_t *handle);

uint8_t opt300x_stop_continuous_read(opt300x_handle_t *handle);

uint8_t opt300x_continuous_read(opt300x_handle_t *handle, uint16_t *raw, float *lux);

uint8_t opt3002_continuous_read(opt300x_handle_t *handle, uint16_t *raw, float *nw_cm2);

uint8_t opt300x_single_read(opt300x_handle_t *handle, uint16_t *raw, float *lux);

uint8_t opt3002_single_read(opt300x_handle_t *handle, uint16_t *raw, float *nw_cm2);

uint8_t opt300x_set_low_limit(opt300x_handle_t *handle, uint16_t limit);

uint8_t opt300x_get_low_limit(opt300x_handle_t *handle, uint16_t *limit);

uint8_t opt300x_set_high_limit(opt300x_handle_t *handle, uint16_t limit);

uint8_t opt300x_get_high_limit(opt300x_handle_t *handle, uint16_t *limit);

uint8_t opt300x_limit_convert_to_register(opt300x_handle_t *handle, float lux, uint16_t *reg);

uint8_t opt300x_limit_convert_to_data(opt300x_handle_t *handle, uint16_t reg, float *lux);

uint8_t opt3002_limit_convert_to_register(opt300x_handle_t *handle, float nw_cm2, uint16_t *reg);

uint8_t opt3002_limit_convert_to_data(opt300x_handle_t *handle, uint16_t reg, float *nw_cm2);

uint8_t opt300x_set_range(opt300x_handle_t *handle, opt300x_range_t range);

uint8_t opt300x_get_range(opt300x_handle_t *handle, opt300x_range_t *range);

uint8_t opt3002_set_range(opt300x_handle_t *handle, opt3002_range_t range);

uint8_t opt3002_get_range(opt300x_handle_t *handle, opt3002_range_t *range);

uint8_t opt3005_set_range(opt300x_handle_t *handle, opt3005_range_t range);

uint8_t opt3005_get_range(opt300x_handle_t *handle, opt3005_range_t *range);

uint8_t opt300x_set_conversion_time(opt300x_handle_t *handle, opt300x_conversion_time_t t);

uint8_t opt300x_get_conversion_time(opt300x_handle_t *handle, opt300x_conversion_time_t *t);

uint8_t opt300x_set_interrupt_latch(opt300x_handle_t *handle, opt300x_bool_t enable);

uint8_t opt300x_get_interrupt_latch(opt300x_handle_t *handle, opt300x_bool_t *enable);

uint8_t opt300x_set_interrupt_pin_polarity(opt300x_handle_t *handle, opt300x_interrupt_polarity_t polarity);

uint8_t opt300x_get_interrupt_pin_polarity(opt300x_handle_t *handle, opt300x_interrupt_polarity_t *polarity);

uint8_t opt300x_set_mask_exponent(opt300x_handle_t *handle, opt300x_bool_t enable);

uint8_t opt300x_get_mask_exponent(opt300x_handle_t *handle, opt300x_bool_t *enable);

uint8_t opt300x_set_fault_count(opt300x_handle_t *handle, opt300x_fault_count_t count);

uint8_t opt300x_get_fault_count(opt300x_handle_t *handle, opt300x_fault_count_t *count);



uint8_t opt300x_set_reg(opt300x_handle_t *handle, uint8_t reg, uint16_t data);

uint8_t opt300x_get_reg(opt300x_handle_t *handle, uint8_t reg, uint16_t *data);


 
#ifdef __cplusplus
}
#endif
 
#endif