uv3.h File Reference

This file contains API for UV 3 Click driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	uv3_t
	Click ctx object definition. More...
struct	uv3_cfg_t
	Click configuration structure definition. More...

Macros
#define	UV3_MAP_MIKROBUS(cfg, mikrobus)
#define	UV3_RETVAL   uint8_t
#define	UV3_OK   0x00
#define	UV3_INIT_ERROR   0xFF
#define	UV3_I2C_ADDR_DEFAULT   0x38
#define	UV3_ADDR_ARA   0x0C
#define	UV3_ADDR_CMD   0x38
#define	UV3_ADDR_DATA_LSB   0x38
#define	UV3_ADDR_DATA_MSB   0x39
#define	UV3_CMD_DEFAULT   0x02
#define	UV3_CMD_SD   0x01
#define	UV3_CMD_IT_0_5T   0x00
#define	UV3_CMD_IT_1T   0x04
#define	UV3_CMD_IT_2T   0x08
#define	UV3_CMD_IT_4T   0x0C
#define	UV3_RAD_LOW   0x01
#define	UV3_RAD_MODERATE   0x02
#define	UV3_RAD_HIGH   0x03
#define	UV3_RAD_VERY_HIGH   0x04
#define	UV3_RAD_EXTREME   0x05

Functions
void	uv3_cfg_setup (uv3_cfg_t *cfg)
	Config Object Initialization function.
UV3_RETVAL	uv3_init (uv3_t *ctx, uv3_cfg_t *cfg)
	Initialization function.
void	uv3_default_cfg (uv3_t *ctx)
	Click Default Configuration function.
void	uv3_write_command (uv3_t *ctx, uint8_t slave_addr, uint8_t command)
	Write function.
uint8_t	uv3_read_byte (uv3_t *ctx, uint8_t slave_addr)
	Read function.
void	uv3_clear_ack (uv3_t *ctx)
	Read ARA to clear interrupt function.
void	uv3_enable_sensor (uv3_t *ctx)
	Enable sensor function.
void	uv3_disable_mode (uv3_t *ctx)
	Disable sensor function.
void	uv3_set_integration_time (uv3_t *ctx, uint8_t int_data)
	Set integration time function.
uint16_t	uv3_read_measurements (uv3_t *ctx)
	Get UV data measurements function.
uint8_t	uv3_risk_level (uint16_t uv_data)
	Calculate UV risk level function.
uint8_t	uv3_get_interrupt (uv3_t *ctx)
	Get state of interrupt pin function.

Detailed Description

This file contains API for UV 3 Click driver.