Contiki-NG
arch
platform
cc26x0-cc13x0
sensortag
opt-3001-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-opt-sensor SensorTag 2.0 Light 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 reading and conversion are complete, the driver will generate a
44
* sensors_changed event.
45
*
46
* We use single-shot readings. In this mode, the hardware automatically goes
47
* back to its shutdown mode after the conversion is finished. However, it will
48
* still respond to I2C operations, so the last conversion can still be read
49
* out.
50
*
51
* In order to take a new reading, the caller has to use SENSORS_ACTIVATE
52
* again.
53
* @{
54
*
55
* \file
56
* Header file for the Sensortag Opt3001 light sensor
57
*/
58
/*---------------------------------------------------------------------------*/
59
#ifndef OPT_3001_SENSOR_H_
60
#define OPT_3001_SENSOR_H_
61
/*---------------------------------------------------------------------------*/
62
#include "lib/sensors.h"
63
/*---------------------------------------------------------------------------*/
64
extern
const
struct
sensors_sensor opt_3001_sensor;
65
/*---------------------------------------------------------------------------*/
66
#endif
/* OPT_3001_SENSOR_H_ */
67
/*---------------------------------------------------------------------------*/
68
/**
69
* @}
70
* @}
71
*/
Generated on Tue Jul 13 2021 15:12:12 for Contiki-NG by
1.8.13