SensorOpt3001.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2017, Texas Instruments Incorporated
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  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
44 #ifndef SENSOR_OPT3001_H
45 #define SENSOR_OPT3001_H
46 
47 #ifdef __cplusplus
48 extern "C"
49 {
50 #endif
51 
52 /*********************************************************************
53  * INCLUDES
54  */
55 #include "stdint.h"
56 #include "stdbool.h"
57 
58 /*********************************************************************
59  * CONSTANTS
60  */
61 
62 /*********************************************************************
63  * TYPEDEFS
64  */
65 
66 /*********************************************************************
67  * FUNCTIONS
68  */
69 
75 bool SensorOpt3001_init(void);
76 
82 void SensorOpt3001_enable(bool enable);
83 
89 bool SensorOpt3001_test(void);
90 
98 bool SensorOpt3001_read(uint16_t *rawData);
99 
108 float SensorOpt3001_convert(uint16_t rawData);
109 
110 
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif /* SENSOR_OPT3001_H */
bool SensorOpt3001_test(void)
Run a sensor self-test.
float SensorOpt3001_convert(uint16_t rawData)
Convert raw data to LUX.
void SensorOpt3001_enable(bool enable)
Enable/disable measurement cycle.
bool SensorOpt3001_init(void)
Initialize the temperature sensor driver.
bool SensorOpt3001_read(uint16_t *rawData)
Read the result register.
Copyright 2018, Texas Instruments Incorporated