ambient20.h File Reference

This file contains API for Ambient 20 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	ambient20_t
	Ambient 20 Click context object. More...
struct	ambient20_cfg_t
	Ambient 20 Click configuration object. More...

Macros
#define	AMBIENT20_SYSTEM_CONTROL_REG   0x40
	Ambient 20 description register.
#define	AMBIENT20_MODE_CONTROL1_REG   0x41
#define	AMBIENT20_MODE_CONTROL2_REG   0x42
#define	AMBIENT20_MODE_CONTROL3_REG   0x43
#define	AMBIENT20_DATA0_LSB_REG   0x50
#define	AMBIENT20_DATA0_MSB_REG   0x51
#define	AMBIENT20_DATA1_LSB_REG   0x52
#define	AMBIENT20_DATA1_MSB_REG   0x53
#define	AMBIENT20_MANUFACTURER_ID_REG   0x92
#define	AMBIENT20_GAIN_X1   0x02
	Ambient 20 description setting.
#define	AMBIENT20_GAIN_X32   0x0A
#define	AMBIENT20_GAIN_X256   0x0C
#define	AMBIENT20_100mS_MODE   0x00
#define	AMBIENT20_55mS_MODE   0x01
#define	AMBIENT20_VALID_MASK   0x80
#define	AMBIENT20_ENABLE   0x01
#define	AMBIENT20_DISABLE   0x00
#define	AMBIENT20_MANUFACTURER_ID   0xE0
#define	AMBIENT20_PART_ID   0x12
#define	AMBIENT20_PART_ID_MASK   0x3F
#define	AMBIENT20_DATA0_CONVERSION_COEF   0.169491525
	Ambient 20 data conversion coefficients.
#define	AMBIENT20_DATA1_CONVERSION_COEF   0.689655172
#define	AMBIENT20_DEVICE_ADDRESS   0x38
	Ambient 20 device address setting.
#define	AMBIENT20_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	ambient20_return_value_t { AMBIENT20_OK = 0 , AMBIENT20_ERROR = -1 }
	Ambient 20 Click return value data. More...

Functions
void	ambient20_cfg_setup (ambient20_cfg_t *cfg)
	Ambient 20 configuration object setup function.
err_t	ambient20_init (ambient20_t *ctx, ambient20_cfg_t *cfg)
	Ambient 20 initialization function.
err_t	ambient20_default_cfg (ambient20_t *ctx)
	Ambient 20 default configuration function.
err_t	ambient20_generic_write (ambient20_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	Ambient 20 I2C writing function.
err_t	ambient20_generic_read (ambient20_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
	Ambient 20 I2C reading function.
err_t	ambient20_sw_reset (ambient20_t *ctx)
	Ambient 20 software reset function.
err_t	ambient20_get_manufacturer_id (ambient20_t *ctx, uint8_t *manufacturer_id)
	Ambient 20 read manufacturer id function.
err_t	ambient20_get_part_id (ambient20_t *ctx, uint8_t *part_id)
	Ambient 20 read part id function.
err_t	ambient20_enable_wait_mode (ambient20_t *ctx)
	Ambient 20 enable wait mode function.
err_t	ambient20_disable_wait_mode (ambient20_t *ctx)
	Ambient 20 disable wait mode function.
err_t	ambient20_set_meas_mode (ambient20_t *ctx, uint8_t meas_mode)
	Ambient 20 set measurement mode function.
err_t	ambient20_set_gain (ambient20_t *ctx, uint8_t data0_gain, uint8_t data1_gain)
	Ambient 20 set data gain function.
err_t	ambient20_enable_meas (ambient20_t *ctx)
	Ambient 20 enable measurements function.
err_t	ambient20_disable_meas (ambient20_t *ctx)
	Ambient 20 disable measurements function.
err_t	ambient20_check_valid (ambient20_t *ctx)
	Ambient 20 check valid bit function.
err_t	ambient20_read_data0 (ambient20_t *ctx, uint16_t *data0_out)
	Ambient 20 read data0 function.
err_t	ambient20_read_data1 (ambient20_t *ctx, uint16_t *data1_out)
	Ambient 20 read data1 function.
err_t	ambient20_get_data_lux (ambient20_t *ctx, float *data0_out, float *data1_out)
	Ambient 20 read light function.

Detailed Description

This file contains API for Ambient 20 Click Driver.

Enumeration Type Documentation

ambient20_return_value_t

enum ambient20_return_value_t

Ambient 20 Click return value data.

Predefined enum values for driver return values.

Enumerator
AMBIENT20_OK
AMBIENT20_ERROR