Contiki-NG
arch
platform
simplelink
cc13xx-cc26xx
sensortag
hdc-1000-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-hdc-sensor SensorTag HDC1000 - Temperature and
35
* Humidity 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. Once the sensor has taken
42
* readings, it will automatically go back to low power mode.
43
*
44
* Once the sensor is stable, the driver will retrieve readings from the sensor
45
* and latch them. It will then generate a sensors_changed event.
46
*
47
* The user can then retrieve readings by calling .value() and by passing
48
* either HDC_1000_SENSOR_TYPE_TEMP or HDC_1000_SENSOR_TYPE_HUMID as the
49
* argument. Multiple calls to value() will not trigger new readings, they will
50
* simply return the most recent latched values.
51
*
52
* The user can query the sensor's status by calling status().
53
*
54
* To get a fresh reading, the user must trigger a new reading cycle by calling
55
* SENSORS_ACTIVATE().
56
* @{
57
*
58
* \file
59
* Header file for the Sensortag HDC1000 sensor.
60
* \author
61
* Edvard Pettersen <e.pettersen@ti.com>
62
*/
63
/*---------------------------------------------------------------------------*/
64
#ifndef HDC_1000_SENSOR_H
65
#define HDC_1000_SENSOR_H
66
/*---------------------------------------------------------------------------*/
67
#include "contiki.h"
68
#include "lib/sensors.h"
69
/*---------------------------------------------------------------------------*/
70
#include "
board-conf.h
"
71
/*---------------------------------------------------------------------------*/
72
#if BOARD_SENSORS_ENABLE
73
#if (TI_I2C_CONF_ENABLE == 0) || (TI_I2C_CONF_I2C0_ENABLE == 0)
74
#error "The HDC-1000 requires the I2C driver (TI_I2C_CONF_ENABLE = 1)"
75
#endif
76
#endif
77
/*---------------------------------------------------------------------------*/
78
typedef
enum
{
79
HDC_1000_SENSOR_TYPE_TEMP,
80
HDC_1000_SENSOR_TYPE_HUMID
81
} HDC_1000_SENSOR_TYPE;
82
/*---------------------------------------------------------------------------*/
83
/**
84
* \name HDC1000 driver states
85
* @{
86
*/
87
typedef
enum
{
88
HDC_1000_SENSOR_STATUS_DISABLED
,
/**< Not initialised */
89
HDC_1000_SENSOR_STATUS_INITIALISED
,
/**< Initialised but idle */
90
HDC_1000_SENSOR_STATUS_TAKING_READINGS
,
/**< Readings in progress */
91
HDC_1000_SENSOR_STATUS_I2C_ERROR
,
/**< I2C transaction failed */
92
HDC_1000_SENSOR_STATUS_READINGS_READY
/**< Both readings ready */
93
}
HDC_1000_SENSOR_STATUS
;
94
/** @} */
95
/*---------------------------------------------------------------------------*/
96
#define HDC_1000_READING_ERROR -1
97
/*---------------------------------------------------------------------------*/
98
extern
const
struct
sensors_sensor hdc_1000_sensor;
99
/*---------------------------------------------------------------------------*/
100
#endif
/* HDC_1000_SENSOR_H */
101
/*---------------------------------------------------------------------------*/
102
/**
103
* @}
104
* @}
105
*/
HDC_1000_SENSOR_STATUS_TAKING_READINGS
Readings in progress.
Definition:
hdc-1000-sensor.h:90
HDC_1000_SENSOR_STATUS_I2C_ERROR
I2C transaction failed.
Definition:
hdc-1000-sensor.h:91
HDC_1000_SENSOR_STATUS_DISABLED
Not initialised.
Definition:
hdc-1000-sensor.h:88
HDC_1000_SENSOR_STATUS_READINGS_READY
Both readings ready.
Definition:
hdc-1000-sensor.h:92
HDC_1000_SENSOR_STATUS_INITIALISED
Initialised but idle.
Definition:
hdc-1000-sensor.h:89
board-conf.h
Header file with definitions related to the sensors on the Sensortags.
HDC_1000_SENSOR_STATUS
HDC_1000_SENSOR_STATUS
Definition:
hdc-1000-sensor.h:87
Generated on Sat May 30 2020 17:03:40 for Contiki-NG by
1.8.13