Contiki-NG
opt-3001-sensor.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018, Texas Instruments Incorporated - http://www.ti.com/
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holder nor the names of its
14  * contributors may be used to endorse or promote products derived
15  * from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 /**
31  * \addtogroup sensortag-peripherals
32  * @{
33  *
34  * \defgroup sensortag-opt-sensor SensorTag Optical Sensor
35  *
36  * Due to the time required for the sensor to startup, this driver is
37  * meant to be used in an asynchronous fashion. The caller must first
38  * activate the sensor by calling SENSORS_ACTIVATE(). This will trigger
39  * the sensor's startup sequence, but the call will not wait for it to
40  * complete so that the CPU can perform other tasks or drop to a low
41  * power mode.
42  *
43  * Once the reading and conversion are complete, the driver will
44  * generate a sensors_changed event.
45  *
46  * We use single-shot readings. In this mode, the hardware
47  * automatically goes back to its shutdown mode after the conversion
48  * is finished. However, it will still respond to I2C operations, so
49  * the last conversion can still be read out.
50  *
51  * In order to take a new reading, the caller has to use
52  * SENSORS_ACTIVATE again.
53  * @{
54  *
55  * \file
56  * Header file for the Sensortag OPT-3001 light sensor.
57  * \author
58  * Edvard Pettersen <e.pettersen@ti.com>
59  */
60 /*---------------------------------------------------------------------------*/
61 #ifndef OPT_3001_SENSOR_H_
62 #define OPT_3001_SENSOR_H_
63 /*---------------------------------------------------------------------------*/
64 #include "contiki.h"
65 /*---------------------------------------------------------------------------*/
66 #include "board-conf.h"
67 /*---------------------------------------------------------------------------*/
68 #if BOARD_SENSORS_ENABLE
69 #if (TI_I2C_CONF_ENABLE == 0) || (TI_I2C_CONF_I2C0_ENABLE == 0)
70 #error "The OPT-3001 requires the I2C driver (TI_I2C_CONF_ENABLE = 1)"
71 #endif
72 #endif
73 /*---------------------------------------------------------------------------*/
74 #define OPT_3001_READING_ERROR -1
75 /*---------------------------------------------------------------------------*/
76 typedef enum {
77  OPT_3001_STATUS_DISABLED,
78  OPT_3001_STATUS_STANDBY,
79  OPT_3001_STATUS_BOOTING,
80  OPT_3001_STATUS_ACTIVE,
81  OPT_3001_STATUS_DATA_READY,
82  OPT_3001_STATUS_I2C_ERROR,
83 } OPT_3001_STATUS;
84 /*---------------------------------------------------------------------------*/
85 extern const struct sensors_sensor opt_3001_sensor;
86 /*---------------------------------------------------------------------------*/
87 #endif /* OPT_3001_SENSOR_H_ */
88 /*---------------------------------------------------------------------------*/
89 /**
90  * @}
91  * @}
92  */
Header file with definitions related to the sensors on the Sensortags.