upm  0.5.1
Sensor/Actuator repository for libmraa (v0.9.1)
 All Data Structures Files Functions Variables Enumerations Enumerator Macros Groups Pages
si114x.h
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2015 Intel Corporation.
4  *
5  * Thanks to Adafruit for some important clues
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining
8  * a copy of this software and associated documentation files (the
9  * "Software"), to deal in the Software without restriction, including
10  * without limitation the rights to use, copy, modify, merge, publish,
11  * distribute, sublicense, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to
13  * the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be
16  * included in all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25  */
26 #pragma once
27 
28 #include <string>
29 #include <mraa/i2c.h>
30 #include <mraa/gpio.h>
31 
32 #define SI114X_I2C_BUS 0
33 #define SI114X_DEFAULT_I2C_ADDR 0x60
34 #define SI114X_HW_KEY 0x17
35 
36 
37 namespace upm {
38 
73  class SI114X {
74  public:
75 
79  typedef enum { REG_PART_ID = 0x00,
80  REG_REV_ID = 0x01,
81  REG_SEQ_ID = 0x02,
82  REG_INT_CFG = 0x03,
83  REG_IRQ_ENABLE = 0x04,
84 
85  // these two are not documented in the datasheet,
86  // but are mentioned there, as well as in the
87  // Adafruit example
88  REG_IRQ_MODE1 = 0x05,
89  REG_IRQ_MODE2 = 0x06,
90 
91  REG_HW_KEY = 0x07,
92  REG_MEAS_RATE0 = 0x08,
93  REG_MEAS_RATE1 = 0x09,
94 
95  REG_PS_LED21 = 0x0f,
96  REG_PS_LED3 = 0x10,
97 
98  REG_UCOEF0 = 0x13,
99  REG_UCOEF1 = 0x14,
100  REG_UCOEF2 = 0x15,
101  REG_UCOEF3 = 0x16,
102  REG_PARAM_WR = 0x17,
103  REG_COMMAND = 0x18,
104 
105  REG_RESPONSE = 0x20,
106  REG_IRQ_STATUS = 0x21,
107  REG_ALS_VIS_DATA0 = 0x22,
108  REG_ALS_VIS_DATA1 = 0x23,
109  REG_ALS_IR_DATA0 = 0x24,
110  REG_ALS_IR_DATA1 = 0x25,
111  REG_PS1_DATA0 = 0x26,
112  REG_PS1_DATA1 = 0x27,
113  REG_PS2_DATA0 = 0x28,
114  REG_PS2_DATA1 = 0x29,
115  REG_PS3_DATA0 = 0x2a,
116  REG_PS3_DATA1 = 0x2b,
117  REG_AUX_UVINDEX0 = 0x2c,
118  REG_AUX_UVINDEX1 = 0x2d,
119  REG_PARAM_READ = 0x2e,
120 
121  REG_CHIP_STAT = 0x30,
122 
123  REG_ANA_IN_KEY0 = 0x3b,
124  REG_ANA_IN_KEY1 = 0x3c,
125  REG_ANA_IN_KEY2 = 0x3d,
126  REG_ANA_IN_KEY3 = 0x3e
127  } SI114X_REG_T;
128 
132  typedef enum { PARAM_I2C_ADDDR = 0x00,
133  PARAM_CHLIST = 0x01,
134  PARAM_PSLED12_SEL = 0x02,
135  PARAM_PSLED3_SEL = 0x03,
136 
137  PARAM_PS_ENCODING = 0x05,
138  PARAM_ALS_ENCODING = 0x06,
139  PARAM_PS1_ADCMUX = 0x07,
140  PARAM_PS2_ADCMUX = 0x08,
141  PARAM_PS3_ADCMUX = 0x09,
142  PARAM_PS_ADC_COUNT = 0x0a,
143  PARAM_PS_ADC_GAIN = 0x0b,
144  PARAM_PS_ADC_MISC = 0x0c,
145 
146  PARAM_ALS_IR_ADCMUX = 0x0e,
147  PARAM_AUX_ADCMUX = 0x0f,
148  PARAM_ALS_VIS_ADC_COUNT = 0x10,
149  PARAM_ALS_VIS_ADC_GAIN = 0x11,
150  PARAM_ALS_VIS_ADC_MISC = 0x12,
151 
152  PARAM_LED_REC = 0x1c,
153  PARAM_ALS_IR_ADC_COUNT = 0x1d,
154  PARAM_ALS_IR_ADX_GAIN = 0x1e,
155  PARAM_ALS_IR_ADC_MISC = 0x1f
156  } SI114X_PARAM_T;
157 
161  typedef enum { CMD_NOOP = 0x00, // clear RESPONSE reg
162  CMD_RESET = 0x01,
163  CMD_BUSADDR = 0x02,
164 
165  CMD_PS_FORCE = 0x05,
166  CMD_GET_CAL = 0x12,
167  CMD_ALS_FORCE = 0x06,
168  CMD_PSALS_FORCE = 0x07,
169 
170  CMD_PS_PAUSE = 0x09,
171  CMD_ALS_PAUSE = 0x0a,
172  CMD_PSALS_PAUSE = 0x0b,
173 
174  CMD_PS_AUTO = 0x0d,
175  CMD_ALS_AUTO = 0x0e,
176  CMD_PSALS_AUTO = 0x0f,
177 
178  CMD_PARAM_QUERY = 0x80, // OR'd with PARAM_T value
179  CMD_PARAM_SET = 0xa0 // OR'd with PARAM_T value
180  } SI114X_CMD_T;
181 
182 
186  typedef enum { CHLIST_EN_PS1 = 0x01, // proximity sense 1-3
187  CHLIST_EN_PS2 = 0x02,
188  CHLIST_EN_PS3 = 0x04,
189 
190  CHLIST_EN_ALS_VIS = 0x10, // ambient light sense
191  CHLIST_EN_ALS_IR = 0x20,
192  CHLIST_EN_AUX = 0x40, // AUX sense
193  CHLIST_EN_UV = 0x80 // UV sense
195 
199  typedef enum { ERR_NONE = 0x00, // no error if high nibble is 0
200  // lower nibble is a counter
201  ERR_INVALID_SET = 0x80, // invalid setting
202  ERR_PS1_ADC_OVER = 0x88, // overflows
203  ERR_PS2_ADC_OVER = 0x89,
204  ERR_PS3_ADC_OVER = 0x8a,
205  ERR_ALS_VIS_ADC_OVER = 0x8c,
206  ERR_ALS_IR_ADC_OVER = 0x8d,
207  ERR_AUX_ADC_OVER = 0x8e
208  } SI114X_ERR_T;
209 
210 
214  typedef enum { IRQEN_ALS_IE = 0x01,
215  IRQEN_PS1_IE = 0x04,
216  IRQEN_PS2_IE = 0x08,
217  IRQEN_PS3_IE = 0x10
219 
226  SI114X(int bus, uint8_t address = SI114X_DEFAULT_I2C_ADDR);
227 
231  ~SI114X();
232 
240  bool writeByte(uint8_t reg, uint8_t byte);
241 
248  uint8_t readByte(uint8_t reg);
249 
256  uint16_t readWord(uint8_t reg);
257 
262  void reset();
263 
276  void setUVCalibration(uint8_t uvcoeff0, uint8_t uvcoeff1, uint8_t uvcoeff2,
277  uint8_t uvcoeff3);
278 
285  void writeParam(SI114X_PARAM_T param, uint8_t value);
286 
293  uint8_t readParam(SI114X_PARAM_T param);
294 
298  void initialize();
299 
304  void update();
305 
311  float getUVIndex() { return m_uvIndex; };
312 
313  private:
314  mraa_i2c_context m_i2c;
315  uint8_t m_addr;
316  // UV calibration values
317  uint8_t m_uv_cal[4];
318  // updated by update()
319  float m_uvIndex;
320  };
321 }
322 
323 
bool writeByte(uint8_t reg, uint8_t byte)
Definition: si114x.cxx:78
float getUVIndex()
Definition: si114x.h:311
SI114X_CMD_T
Definition: si114x.h:161
SI114X_PARAM_T
Definition: si114x.h:132
uint16_t readWord(uint8_t reg)
Definition: si114x.cxx:97
void setUVCalibration(uint8_t uvcoeff0, uint8_t uvcoeff1, uint8_t uvcoeff2, uint8_t uvcoeff3)
Definition: si114x.cxx:102
void reset()
Definition: si114x.cxx:133
API for the SI1145 UV Light Sensor.
Definition: si114x.h:73
void writeParam(SI114X_PARAM_T param, uint8_t value)
Definition: si114x.cxx:112
~SI114X()
Definition: si114x.cxx:73
uint8_t readByte(uint8_t reg)
Definition: si114x.cxx:92
SI114X_CHLIST_BITS_T
Definition: si114x.h:186
SI114X_IRQEN_BITS_T
Definition: si114x.h:214
uint8_t readParam(SI114X_PARAM_T param)
Definition: si114x.cxx:125
SI114X(int bus, uint8_t address=SI114X_DEFAULT_I2C_ADDR)
Definition: si114x.cxx:39
SI114X_ERR_T
Definition: si114x.h:199
void initialize()
Definition: si114x.cxx:159
SI114X_REG_T
Definition: si114x.h:79
void update()
Definition: si114x.cxx:182