tsl2561.h
2.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
* Copyright (C) 2016 Inria
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup drivers_tsl2561 TSL2561 illuminance sensor
* @ingroup drivers_sensors
* @brief Device driver interface for the illuminance TSL2561 sensor
* @{
*
* @file
* @brief Device driver interface for the illuminance TSL2561 sensor.
*
* @author Alexandre Abadie <alexandre.abadie@inria.fr>
*/
#ifndef TSL2561_H
#define TSL2561_H
#include "saul.h"
#include "periph/i2c.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @name TSL2561 I2C addresses
* @{
*/
#define TSL2561_ADDR_LOW (0x29)
#define TSL2561_ADDR_FLOAT (0x39)
#define TSL2561_ADDR_HIGH (0x49)
/** @} */
/**
* @name TSL2561 integration times
* @{
*/
#define TSL2561_INTEGRATIONTIME_13MS (0x00) /* 13.7ms */
#define TSL2561_INTEGRATIONTIME_101MS (0x01) /* 101ms */
#define TSL2561_INTEGRATIONTIME_402MS (0x02) /* 402ms */
#define TSL2561_INTEGRATIONTIME_NA (0x03) /* N/A */
/** @} */
/**
* @name TSL2561 gains
* @{
*/
#define TSL2561_GAIN_1X (0x00)
#define TSL2561_GAIN_16X (0x10)
/** @} */
/**
* @name TSL2561 driver initialization return codes
* @{
*/
#define TSL2561_OK (0)
#define TSL2561_NOI2C (-1)
#define TSL2561_BADDEV (-2)
/** @} */
/**
* @brief Device descriptor for the TSL2561 sensor
*/
typedef struct {
i2c_t i2c_dev; /**< I2C device which is used */
uint8_t addr; /**< address on I2C bus */
uint8_t gain; /**< gain */
uint8_t integration; /**< integration time */
} tsl2561_t;
/**
* @brief Device initialization parameters
*/
typedef tsl2561_t tsl2561_params_t;
/**
* @brief Initialize the given TSL2561 device
*
* @param[out] dev Initialized device descriptor of BMP180 device
* @param[in] i2c I2C bus the sensor is connected to
* @param[in] addr I2C address of the sensor on the I2C bus
* @param[in] gain TSL2561 gain
* @param[in] integration TSL2561 integration time
*
* @return 0 on success
* @return -1 if given I2C is not available
* @return -2 if not a TSL2561 sensor
*/
int tsl2561_init(tsl2561_t *dev, i2c_t i2c, uint8_t addr,
uint8_t gain, uint8_t integration);
/**
* @brief Read illuminance value from the given TSL2561 device, returned in lx.
*
* @param[in] dev Device descriptor of TSL2561 device to read from
*
* @return Illuminance in Lux (lx)
*/
uint16_t tsl2561_read_illuminance(const tsl2561_t *dev);
#ifdef __cplusplus
}
#endif
#endif /* TSL2561_H */
/** @} */