isl29125.h
Go to the documentation of this file.
1 /*
2  * Copyright 2015 Ludwig Knüpfer
3  * Copyright 2017 HAW Hamburg
4  *
5  * This file is subject to the terms and conditions of the GNU Lesser
6  * General Public License v2.1. See the file LICENSE in the top level
7  * directory for more details.
8  */
9 
10 #pragma once
11 
50 #include <stdint.h>
51 
52 #include "periph/i2c.h"
53 #include "periph/gpio.h"
54 #include "color.h"
55 
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59 
63 typedef struct {
64  float red;
65  float green;
66  float blue;
68 
73 typedef enum {
77  ISL29125_MODE_R = 0x02,
78  ISL29125_MODE_G = 0x01,
79  ISL29125_MODE_B = 0x03,
81  ISL29125_MODE_GB = 0x07
83 
87 typedef enum {
89  ISL29125_RANGE_10K = 0x08
91 
96 typedef enum {
100 
104 typedef struct {
106  gpio_t gpio;
111 
115 typedef struct {
117 } isl29125_t;
118 
122 typedef enum {
128 
132 typedef enum {
136  ISL29125_INTERRUPT_PERSIST_8 = (0x03 << 2)
138 
142 typedef enum {
146 
156 int isl29125_init(isl29125_t *dev, const isl29125_params_t *params);
157 
174  isl29125_interrupt_persist_t interrupt_persist,
175  isl29125_interrupt_conven_t interrupt_conven,
176  uint16_t lower_threshold, uint16_t higher_threshold,
177  gpio_cb_t cb, void *arg);
178 
186 
194 
202 
211 
212 #ifdef __cplusplus
213 }
214 #endif
215 
Headers for the color handling module.
Low-level GPIO peripheral driver interface definitions.
isl29125_interrupt_status_t
Configuration-3 Register 0x03 B1:0.
Definition: isl29125.h:122
int isl29125_init(isl29125_t *dev, const isl29125_params_t *params)
Initialize a new ISL29125 device.
isl29125_resolution_t
Supported color resolutions of the ISL29125 sensor's AD conversion.
Definition: isl29125.h:96
isl29125_interrupt_conven_t
Configuration-3 Register 0x03 B4.
Definition: isl29125.h:142
void isl29125_read_rgb_color(const isl29125_t *dev, color_rgb_t *dest)
Read color values from device.
isl29125_mode_t
Supported operation modes of the ISL29125 sensor's AD conversion.
Definition: isl29125.h:73
int isl29125_read_irq_status(const isl29125_t *dev)
Read isl29125 interrupt status.
void isl29125_set_mode(const isl29125_t *dev, isl29125_mode_t mode)
Set the device's operation mode.
isl29125_range_t
Supported RGB sensing range values of the ISL29125 sensor.
Definition: isl29125.h:87
int isl29125_init_int(isl29125_t *dev, isl29125_interrupt_status_t interrupt_status, isl29125_interrupt_persist_t interrupt_persist, isl29125_interrupt_conven_t interrupt_conven, uint16_t lower_threshold, uint16_t higher_threshold, gpio_cb_t cb, void *arg)
Initialize interrupts.
isl29125_interrupt_persist_t
Configuration-3 Register 0x03 B3:2.
Definition: isl29125.h:132
void isl29125_read_rgb_lux(const isl29125_t *dev, isl29125_rgb_t *dest)
Read RGB values from device.
@ ISL29125_INTERRUPT_STATUS_GREEN
GREEN interrupt.
Definition: isl29125.h:124
@ ISL29125_INTERRUPT_STATUS_BLUE
BLUE interrupt.
Definition: isl29125.h:126
@ ISL29125_INTERRUPT_STATUS_NONE
No interrupt.
Definition: isl29125.h:123
@ ISL29125_INTERRUPT_STATUS_RED
RED interrupt.
Definition: isl29125.h:125
@ ISL29125_RESOLUTION_16
resolution: 16 bit
Definition: isl29125.h:98
@ ISL29125_RESOLUTION_12
resolution: 12 bit
Definition: isl29125.h:97
@ ISL29125_INTERRUPT_CONV_DIS
RGB Conversion done to ~INT Control disable.
Definition: isl29125.h:143
@ ISL29125_INTERRUPT_CONV_EN
RGB Conversion done to ~INT Control enable.
Definition: isl29125.h:144
@ ISL29125_MODE_DOWN
ADC powered down.
Definition: isl29125.h:74
@ ISL29125_MODE_B
blue conversion only
Definition: isl29125.h:79
@ ISL29125_MODE_STANDBY
AD conversion not performed.
Definition: isl29125.h:75
@ ISL29125_MODE_G
green conversion only
Definition: isl29125.h:78
@ ISL29125_MODE_RGB
RGB conversion.
Definition: isl29125.h:76
@ ISL29125_MODE_R
red conversion only
Definition: isl29125.h:77
@ ISL29125_MODE_GB
green and blue conversion only
Definition: isl29125.h:81
@ ISL29125_MODE_RG
red and green conversion only
Definition: isl29125.h:80
@ ISL29125_RANGE_375
range: 5.7m - 375 lux
Definition: isl29125.h:88
@ ISL29125_RANGE_10K
range: 0.152 - 10,000 lux
Definition: isl29125.h:89
@ ISL29125_INTERRUPT_PERSIST_1
Int.
Definition: isl29125.h:133
@ ISL29125_INTERRUPT_PERSIST_4
Int.
Definition: isl29125.h:135
@ ISL29125_INTERRUPT_PERSIST_2
Int.
Definition: isl29125.h:134
@ ISL29125_INTERRUPT_PERSIST_8
Int.
Definition: isl29125.h:136
void(* gpio_cb_t)(void *arg)
Signature of event callback functions triggered from interrupts.
Definition: gpio.h:146
uint_fast8_t i2c_t
Default i2c_t type definition.
Definition: i2c.h:144
Low-level I2C peripheral driver interface definition.
Data-structure describing a RGB color.
Definition: color.h:34
Device parameters for ISL29125 sensors.
Definition: isl29125.h:104
gpio_t gpio
GPIO pin for interrupt/sync mode.
Definition: isl29125.h:106
isl29125_resolution_t res
AD conversion resolution.
Definition: isl29125.h:109
isl29125_range_t range
measurement range
Definition: isl29125.h:107
isl29125_mode_t mode
AD conversion mode.
Definition: isl29125.h:108
i2c_t i2c
I2C device the sensor is connected to.
Definition: isl29125.h:105
Data type for storing lux RGB sensor readings.
Definition: isl29125.h:63
float red
red lux value
Definition: isl29125.h:64
float blue
blue lux value
Definition: isl29125.h:66
float green
green lux value
Definition: isl29125.h:65
Device descriptor for ISL29125 sensors.
Definition: isl29125.h:115
isl29125_params_t params
device parameters
Definition: isl29125.h:116