Contiki-NG
cc2538-sensors.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Zolertia - http://www.zolertia.com
3  * Copyright (c) 2015, University of Bristol - http://www.bristol.ac.uk
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its
16  * contributors may be used to endorse or promote products derived
17  * from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
30  * OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 /*---------------------------------------------------------------------------*/
33 /**
34  * \addtogroup cc2538
35  * @{
36  *
37  * \defgroup cc2538-sensors CC2538 Built-In Sensors
38  *
39  * Module controlling sensors on the CC2538 SoC (Tmp and VDD3)
40  * @{
41  *
42  * \file
43  * Generic header usable by all CC2538 sensor drivers
44  */
45 /*---------------------------------------------------------------------------*/
46 #ifndef CC2538_SENSORS_H_
47 #define CC2538_SENSORS_H_
48 /*---------------------------------------------------------------------------*/
49 #include "lib/sensors.h"
50 #include "dev/cc2538-temp-sensor.h"
51 #include "dev/vdd3-sensor.h"
52 /*---------------------------------------------------------------------------*/
53 /**
54  * \name CC2538 sensor constants
55  *
56  * These constants are used by various sensors on the CC2538. They can be used
57  * to differentiate between raw and converted readings, to configure ADC
58  * decimation rate (where applicable).
59  * @{
60  */
61 #define CC2538_SENSORS_VALUE_TYPE_RAW 0 /**< Request the raw reading */
62 #define CC2538_SENSORS_VALUE_TYPE_CONVERTED 1 /**< Request the converted reading */
63 
64 #define CC2538_SENSORS_ERROR 0x80000000 /**< Generic Error */
65 /** @} */
66 /*---------------------------------------------------------------------------*/
67 #endif /* CC2538_SENSORS_H_ */
68 /*---------------------------------------------------------------------------*/
69 /**
70  * @}
71  * @}
72  */
Header file for the CC2538 on-chip temperature Sensor Driver.
Header file for the CC2538 VDD3 Sensor Driver.