ISL29020 light sensor

Device driver for the ISL29020 light sensor. More...

Detailed Description

Files

file  isl29020.h
 Device driver interface for the ISL29020 light sensor.
 

Data Structures

struct  isl29020_t
 Device descriptor for ISL29020 sensors. More...
 
struct  isl29020_params_t
 Data structure holding the full set of configuration parameters. More...
 

Macros

#define ISL29020_DEFAULT_ADDRESS   0x44
 The sensors default I2C address.
 

Enumerations

enum  isl29020_mode_t { ISL29020_MODE_AMBIENT = 0, ISL29020_MODE_IR = 1 }
 Possible modes for the ISL29020 sensor. More...
 
enum  isl29020_range_t { ISL29020_RANGE_1K = 0, ISL29020_RANGE_4K = 1, ISL29020_RANGE_16K = 2, ISL29020_RANGE_64K = 3 }
 Possible range values for the ISL29020 sensor. More...
 

Functions

int isl29020_init (isl29020_t *dev, i2c_t i2c, uint8_t address, isl29020_range_t range, isl29020_mode_t mode)
 Initialize a new ISL29020 device. More...
 
int isl29020_read (isl29020_t *dev)
 Read a lighting value from the sensor, the result is given in lux. More...
 
int isl29020_enable (isl29020_t *dev)
 Enable the given sensor. More...
 
int isl29020_disable (isl29020_t *dev)
 Disable the given sensor. More...
 

Enumeration Type Documentation

Enumerator
ISL29020_MODE_AMBIENT 

set sensor to detect ambient light

ISL29020_MODE_IR 

set sensor to detect infrared light

Definition at line 48 of file isl29020.h.

Enumerator
ISL29020_RANGE_1K 

set range to 0-1000 lux

ISL29020_RANGE_4K 

set range to 0-4000 lux

ISL29020_RANGE_16K 

set range to 0-16000 lux

ISL29020_RANGE_64K 

set range to 0-64000 lux

Definition at line 56 of file isl29020.h.

Function Documentation

int isl29020_disable ( isl29020_t dev)
Parameters
[in]devdevice descriptor of an ISL29020 device
Returns
0 on success
-1 on error
int isl29020_enable ( isl29020_t dev)
Parameters
[in]devdevice descriptor of an ISL29020 device
Returns
0 on success
-1 on error
int isl29020_init ( isl29020_t dev,
i2c_t  i2c,
uint8_t  address,
isl29020_range_t  range,
isl29020_mode_t  mode 
)
Parameters
[in]devdevice descriptor of an ISL29020 device
[in]i2cI2C device the sensor is connected to
[in]addressI2C address of the sensor
[in]rangemeasurement range
[in]modeconfigure if sensor reacts to ambient or infrared light
Returns
0 on success
-1 on error
int isl29020_read ( isl29020_t dev)
Parameters
[in]devdevice descriptor of an ISL29020 device
Returns
the measured brightness in lux
-1 on error