Contiki-NG
tmp-007-sensor.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014, 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 /**
32  * \addtogroup sensortag-cc26xx-peripherals
33  * @{
34  *
35  * \defgroup sensortag-cc26xx-tmp-sensor SensorTag 2.0 IR thermophile sensor
36  *
37  * Due to the time required for the sensor to startup, this driver is meant to
38  * be used in an asynchronous fashion. The caller must first activate the
39  * sensor by calling SENSORS_ACTIVATE(). This will trigger the sensor's startup
40  * sequence, but the call will not wait for it to complete so that the CPU can
41  * perform other tasks or drop to a low power mode.
42  *
43  * Once the sensor is stable, the driver will generate a sensors_changed event.
44  *
45  * The caller should then use value(TMP_007_SENSOR_TYPE_ALL) to read sensor
46  * values and latch them. Once completed successfully, individual readings can
47  * be retrieved with calls to value(TMP_007_SENSOR_TYPE_OBJECT) or
48  * value(TMP_007_SENSOR_TYPE_AMBIENT).
49  *
50  * Once required readings have been taken, the caller has two options:
51  * - Turn the sensor off by calling SENSORS_DEACTIVATE, but in order to take
52  * subsequent readings SENSORS_ACTIVATE must be called again
53  * - Leave the sensor on. In this scenario, the caller can simply keep calling
54  * value(TMP_007_SENSOR_TYPE_ALL) to read and latch new values. However
55  * keeping the sensor on will consume more energy
56  * @{
57  *
58  * \file
59  * Header file for the Sensortag TI TMP007 infrared thermophile sensor
60  */
61 /*---------------------------------------------------------------------------*/
62 #ifndef TMP_007_SENSOR_H_
63 #define TMP_007_SENSOR_H_
64 /*---------------------------------------------------------------------------*/
65 #define TMP_007_SENSOR_TYPE_OBJECT 1
66 #define TMP_007_SENSOR_TYPE_AMBIENT 2
67 #define TMP_007_SENSOR_TYPE_ALL 3
68 /*---------------------------------------------------------------------------*/
69 extern const struct sensors_sensor tmp_007_sensor;
70 /*---------------------------------------------------------------------------*/
71 #endif /* TMP_007_SENSOR_H_ */
72 /*---------------------------------------------------------------------------*/
73 /**
74  * @}
75  * @}
76  */