Contiki-NG
Loading...
Searching...
No Matches
hdc-1000-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-hdc-sensor SensorTag 2.0 TI HDC1000 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 TI HDC1000 sensor
60 */
61/*---------------------------------------------------------------------------*/
62#ifndef HDC_1000_SENSOR_H
63#define HDC_1000_SENSOR_H
64/*---------------------------------------------------------------------------*/
65#include "lib/sensors.h"
66/*---------------------------------------------------------------------------*/
67#define HDC_1000_SENSOR_TYPE_TEMP 1
68#define HDC_1000_SENSOR_TYPE_HUMID 2
69/*---------------------------------------------------------------------------*/
70/**
71 * \name HDC1000 driver states
72 * @{
73 */
74#define HDC_1000_SENSOR_STATUS_DISABLED 0 /**< Not initialised */
75#define HDC_1000_SENSOR_STATUS_INITIALISED 1 /**< Initialised but idle */
76#define HDC_1000_SENSOR_STATUS_TAKING_READINGS 2 /**< Readings in progress */
77#define HDC_1000_SENSOR_STATUS_READINGS_READY 3 /**< Both readings ready */
78/** @} */
79/*---------------------------------------------------------------------------*/
80extern const struct sensors_sensor hdc_1000_sensor;
81/*---------------------------------------------------------------------------*/
82#endif /* HDC_1000_SENSOR_H */
83/*---------------------------------------------------------------------------*/
84/**
85 * @}
86 * @}
87 */