ambient9 2.0.0.0
ambient9.h File Reference

This file contains API for Ambient 9 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  ambient9_t
 Click ctx object definition. More...
 
struct  ambient9_cfg_t
 Click configuration structure definition. More...
 

Macros

#define AMBIENT9_MAP_MIKROBUS(cfg, mikrobus)
 
#define AMBIENT9_RETVAL   uint8_t
 
#define AMBIENT9_OK   0x00
 
#define AMBIENT9_INIT_ERROR   0xFF
 
#define AMBIENT9_SLAVE_ADDR   0x53
 
#define AMBIENT9_REG_MAIN_CTRL   0x00
 
#define AMBIENT9_REG_PS_LED   0x01
 
#define AMBIENT9_REG_PS_PULSES   0x02
 
#define AMBIENT9_REG_PS_MEAS_RATE   0x03
 
#define AMBIENT9_REG_ALS_MEAS_RATE   0x04
 
#define AMBIENT9_REG_ALS_GAIN   0x05
 
#define AMBIENT9_REG_PART_ID   0x06
 
#define AMBIENT9_REG_MAIN_STATUS   0x07
 
#define AMBIENT9_REG_PS_DATA_0   0x08
 
#define AMBIENT9_REG_PS_DATA_1   0x09
 
#define AMBIENT9_REG_LS_CLEAR_DATA_0   0x0A
 
#define AMBIENT9_REG_LS_CLEAR_DATA_1   0x0B
 
#define AMBIENT9_REG_LS_CLEAR_DATA_2   0x0C
 
#define AMBIENT9_REG_ALS_DATA_0   0x0D
 
#define AMBIENT9_REG_ALS_DATA_1   0x0E
 
#define AMBIENT9_REG_ALS_DATA_2   0x0F
 
#define AMBIENT9_REG_INT_CFG   0x19
 
#define AMBIENT9_REG_INT_PST   0x1A
 
#define AMBIENT9_REG_PS_THRES_UP_0   0x1B
 
#define AMBIENT9_REG_PS_THRES_UP_1   0x1C
 
#define AMBIENT9_REG_PS_THRES_LOW_0   0x1D
 
#define AMBIENT9_REG_PS_THRES_LOW_1   0x1E
 
#define AMBIENT9_REG_PS_CAN_DIG_0   0x1F
 
#define AMBIENT9_REG_PS_CAN_DIG_1   0x20
 
#define AMBIENT9_REG_PS_CAN_ANA_DURATION   0x21
 
#define AMBIENT9_REG_PS_CAN_ANA_CURRENT   0x22
 
#define AMBIENT9_REG_PS_AV_HYST   0x23
 
#define AMBIENT9_REG_ALS_THRES_UP_0   0x24
 
#define AMBIENT9_REG_ALS_THRES_UP_1   0x25
 
#define AMBIENT9_REG_ALS_THRES_UP_2   0x26
 
#define AMBIENT9_REG_ALS_THRES_LOW_0   0x27
 
#define AMBIENT9_REG_ALS_THRES_LOW_1   0x28
 
#define AMBIENT9_REG_ALS_THRES_LOW_2   0x29
 
#define AMBIENT9_REG_ALS_THRES_VAR   0x2A
 
#define AMBIENT9_PART_ID_VAL   0x03
 
#define AMBIENT9_POWER_ON   0x20
 
#define AMBIENT9_ALS   0xAA
 
#define AMBIENT9_PROXY   0xBB
 

Functions

void ambient9_cfg_setup (ambient9_cfg_t *cfg)
 Config Object Initialization function.
 
AMBIENT9_RETVAL ambient9_init (ambient9_t *ctx, ambient9_cfg_t *cfg)
 Initialization function.
 
void ambient9_generic_write (ambient9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void ambient9_generic_read (ambient9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function.
 
uint8_t ambient9_get_int_status (ambient9_t *ctx)
 Generic function for getting int pin status.
 
uint32_t ambient9_als_data (ambient9_t *ctx)
 Generic function for reading ALS data from sensor.
 
uint16_t ambient9_proxy_data (ambient9_t *ctx)
 Generic function for reading proximity data from sensor.
 
void ambient9_enable_data (ambient9_t *ctx, uint8_t als_ps)
 Function for enabeling sensor for ALS or proximity.
 

Detailed Description

This file contains API for Ambient 9 Click driver.