Contiki-NG
bmp-280-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-bmp-sensor SensorTag Pressure Sensor
35  *
36  * Due to the time required for the sensor to startup, this driver is meant to
37  * be used in an asynchronous fashion. The caller must first activate the
38  * sensor by calling SENSORS_ACTIVATE(). This will trigger the sensor's startup
39  * sequence, but the call will not wait for it to complete so that the CPU can
40  * perform other tasks or drop to a low power mode.
41  *
42  * Once the sensor is stable, the driver will generate a sensors_changed event.
43  *
44  * We take readings in "Forced" mode. In this mode, the BMP will take a single
45  * measurement and it will then automatically go to sleep.
46  *
47  * SENSORS_ACTIVATE must be called again to trigger a new reading cycle
48  * @{
49  *
50  * \file
51  * Header file for the Sensortag BMP280 Altimeter / Pressure Sensor
52  * \author
53  * Edvard Pettersen <e.pettersen@ti.com>
54  */
55 /*---------------------------------------------------------------------------*/
56 #ifndef BMP_280_SENSOR_H_
57 #define BMP_280_SENSOR_H_
58 /*---------------------------------------------------------------------------*/
59 #include "contiki.h"
60 #include "lib/sensors.h"
61 /*---------------------------------------------------------------------------*/
62 #include "board-conf.h"
63 /*---------------------------------------------------------------------------*/
64 /* The BMP-280 driver uses the I2C0 peripheral to access the senssor */
65 #if BOARD_SENSORS_ENABLE
66 #if (TI_I2C_CONF_ENABLE == 0) || (TI_I2C_CONF_I2C0_ENABLE == 0)
67 #error "The BMP280 requires the I2C driver (TI_I2C_CONF_ENABLE = 1)"
68 #endif
69 #endif
70 /*---------------------------------------------------------------------------*/
71 typedef enum {
72  BMP_280_SENSOR_TYPE_TEMP,
73  BMP_280_SENSOR_TYPE_PRESS
74 } BMP_280_SENSOR_TYPE;
75 /*---------------------------------------------------------------------------*/
76 #define BMP_280_READING_ERROR -1
77 /*---------------------------------------------------------------------------*/
78 extern const struct sensors_sensor bmp_280_sensor;
79 /*---------------------------------------------------------------------------*/
80 #endif /* BMP_280_SENSOR_H_ */
81 /*---------------------------------------------------------------------------*/
82 /**
83  * @}
84  * @}
85  */
Header file with definitions related to the sensors on the Sensortags.
const struct sensors_sensor bmp_280_sensor
Exports a global symbol to be used by the sensor API.