driver_uvis25.h

Go to the documentation of this file.

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



typedef enum
{
    UVIS25_BOOL_FALSE = 0x00,        
    UVIS25_BOOL_TRUE  = 0x01,        
} uvis25_bool_t;

typedef enum
{
    UVIS25_SPI_WIRE_4 = 0x00,        
    UVIS25_SPI_WIRE_3 = 0x01,        
} uvis25_spi_wire_t;

typedef enum
{
    UVIS25_INTERFACE_IIC = 0x00,        
    UVIS25_INTERFACE_SPI = 0x01,        
} uvis25_interface_t;

typedef enum
{
    UVIS25_BOOT_NORMAL_MODE           = 0x00,        
    UVIS25_BOOT_REBOOT_MEMORY_CONTENT = 0x01,        
} uvis25_boot_mode_t;



typedef enum
{
    UVIS25_INTERRUPT_ACTIVE_LEVEL_HIGHER = 0x00,        
    UVIS25_INTERRUPT_ACTIVE_LEVEL_LOWER  = 0x01,        
} uvis25_interrupt_active_level_t;

typedef enum
{
    UVIS25_INTERRUPT_PIN_TYPE_PUSH_PULL  = 0x00,        
    UVIS25_INTERRUPT_PIN_TYPE_OPEN_DRAIN = 0x01,        
} uvis25_interrupt_pin_type_t;

typedef enum
{
    UVIS25_INTERRUPT_TYPE_DATA_READY        = 0x00,        
    UVIS25_INTERRUPT_TYPE_UV_INDEX_HIGH     = 0x01,        
    UVIS25_INTERRUPT_TYPE_UV_INDEX_LOW      = 0x02,        
    UVIS25_INTERRUPT_TYPE_UV_INDEX_HIGH_LOW = 0x03,        
} uvis25_interrupt_type_t;

typedef enum
{
    UVIS25_INTERRUPT_ACTIVE = 0x00,        
    UVIS25_INTERRUPT_HIGHER = 0x01,        
    UVIS25_INTERRUPT_LOWER  = 0x02,        
} uvis25_interrupt_t;



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

typedef struct uvis25_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;           
} uvis25_info_t;



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

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

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

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

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

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

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

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

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

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

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

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



uint8_t uvis25_info(uvis25_info_t *info);

uint8_t uvis25_init(uvis25_handle_t *handle);

uint8_t uvis25_deinit(uvis25_handle_t *handle);

uint8_t uvis25_single_read(uvis25_handle_t *handle, uint8_t *raw, float *uv);

uint8_t uvis25_start_continuous_read(uvis25_handle_t *handle);

uint8_t uvis25_stop_continuous_read(uvis25_handle_t *handle);

uint8_t uvis25_continuous_read(uvis25_handle_t *handle, uint8_t *raw, float *uv);

uint8_t uvis25_set_interface(uvis25_handle_t *handle, uvis25_interface_t interface);

uint8_t uvis25_get_interface(uvis25_handle_t *handle, uvis25_interface_t *interface);

uint8_t uvis25_irq_handler(uvis25_handle_t *handle);

uint8_t uvis25_set_block_data_update(uvis25_handle_t *handle, uvis25_bool_t enable);

uint8_t uvis25_get_block_data_update(uvis25_handle_t *handle, uvis25_bool_t *enable);

uint8_t uvis25_set_boot(uvis25_handle_t *handle, uvis25_boot_mode_t mode);

uint8_t uvis25_get_boot(uvis25_handle_t *handle, uvis25_boot_mode_t *mode);

uint8_t uvis25_set_iic(uvis25_handle_t *handle, uvis25_bool_t enable);

uint8_t uvis25_set_iic(uvis25_handle_t *handle, uvis25_bool_t enable);

uint8_t uvis25_get_iic(uvis25_handle_t *handle, uvis25_bool_t *enable);

uint8_t uvis25_get_iic(uvis25_handle_t *handle, uvis25_bool_t *enable);

uint8_t uvis25_set_spi_wire(uvis25_handle_t *handle, uvis25_spi_wire_t wire);

uint8_t uvis25_get_spi_wire(uvis25_handle_t *handle, uvis25_spi_wire_t *wire);



uint8_t uvis25_set_interrupt_active_level(uvis25_handle_t *handle, uvis25_interrupt_active_level_t level);

uint8_t uvis25_get_interrupt_active_level(uvis25_handle_t *handle, uvis25_interrupt_active_level_t *level);

uint8_t uvis25_set_interrupt_pin_type(uvis25_handle_t *handle, uvis25_interrupt_pin_type_t pin_type);

uint8_t uvis25_get_interrupt_pin_type(uvis25_handle_t *handle, uvis25_interrupt_pin_type_t *pin_type);

uint8_t uvis25_set_interrupt_type(uvis25_handle_t *handle, uvis25_interrupt_type_t type);

uint8_t uvis25_get_interrupt_type(uvis25_handle_t *handle, uvis25_interrupt_type_t *type);

uint8_t uvis25_set_interrupt(uvis25_handle_t *handle, uvis25_bool_t enable);

uint8_t uvis25_get_interrupt(uvis25_handle_t *handle, uvis25_bool_t *enable);

uint8_t uvis25_set_latch_interrupt(uvis25_handle_t *handle, uvis25_bool_t enable);

uint8_t uvis25_get_latch_interrupt(uvis25_handle_t *handle, uvis25_bool_t *enable);

uint8_t uvis25_set_interrupt_low_threshold(uvis25_handle_t *handle, uvis25_bool_t enable);

uint8_t uvis25_get_interrupt_low_threshold(uvis25_handle_t *handle, uvis25_bool_t *enable);

uint8_t uvis25_set_interrupt_high_threshold(uvis25_handle_t *handle, uvis25_bool_t enable);

uint8_t uvis25_get_interrupt_high_threshold(uvis25_handle_t *handle, uvis25_bool_t *enable);

uint8_t uvis25_set_threshold(uvis25_handle_t *handle, uint8_t threshold);

uint8_t uvis25_get_threshold(uvis25_handle_t *handle, uint8_t *threshold);

uint8_t uvis25_threshold_convert_to_register(uvis25_handle_t *handle, float uv, uint8_t *reg);

uint8_t uvis25_threshold_convert_to_data(uvis25_handle_t *handle, uint8_t reg, float *uv);



uint8_t uvis25_set_reg(uvis25_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t uvis25_get_reg(uvis25_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif