upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
ims_defs.h
1 /*
2  * Author: Noel Eck <noel.eck@intel.com>
3  * Copyright (c) 2015 Intel Corporation.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
25 #pragma once
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 #define IMS_ADDRESS_DEFAULT 0x20
32 
33  /* @brief Moisture sensor I2C READ commands */
34 typedef enum _IMS_RD_COMMAND {
35  /* Read capacitance (moisture) register */
36  IMS_GET_CAPACITANCE = 0x00, /* (r) 2 */
37  /* Read I2C address register */
38  IMS_GET_ADDRESS = 0x02, /* (r) 1 */
39  /* Read light register (requires write to IMS_MEASURE_LIGHT) */
40  IMS_GET_LIGHT = 0x04, /* (r) 2 */
41  /* Read temperature register */
42  IMS_GET_TEMPERATURE = 0x05, /* (r) 2 */
43  /* Read version register */
44  IMS_GET_VERSION = 0x07, /* (r) 1 */
45  /* Read busy register (0 = ready, 1 = sampling) */
46  IMS_GET_BUSY = 0x09, /* (r) 1 */
47 } IMS_RD_COMMAND;
48 
49  /* @brief Moisture sensor I2C WRITE commands */
50 typedef enum {
51  /* Write I2C address register (latched w/IMS_RESET) */
52  IMS_SET_ADDRESS = 0x01, /* (w) 1 */
53  /* Initiate light measurement */
54  IMS_MEASURE_LIGHT = 0x03, /* (w) 0 */
55  /* Reset device */
56  IMS_RESET = 0x06, /* (w) 0 */
57  /* Sleep microcontroller, wake on any I2C request */
58  IMS_SLEEP = 0x08, /* (w) 0 */
59 } IMS_WR_COMMAND;
60 
61 
62 #ifdef __cplusplus
63 }
64 #endif