-
Notifications
You must be signed in to change notification settings - Fork 0
/
sensor.light.veml7700.spin
385 lines (311 loc) · 12.6 KB
/
sensor.light.veml7700.spin
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
{
----------------------------------------------------------------------------------------------------
Filename: sensor.light.veml7700.spin
Description: Driver for the VEML7700 ALS/Lux sensor
Author: Jesse Burt
Started: Jan 25, 2023
Updated: Jun 7, 2024
Copyright (c) 2024 - See end of file for terms of use.
----------------------------------------------------------------------------------------------------
}
CON
{ default I/O configuration - these can be overridden by the parent object }
SCL = 28
SDA = 29
I2C_FREQ = 100_000
SLAVE_WR = core.SLAVE_ADDR
SLAVE_RD = core.SLAVE_ADDR|1
DEF_SCL = 28
DEF_SDA = 29
DEF_HZ = 100_000
I2C_MAX_FREQ = core.I2C_MAX_FREQ
ADC_MAX = core.ADC_MAX
VAR
long _lux_res, _lux_max
long _als_gain, _als_itime
OBJ
{ decide: Bytecode I2C engine, or PASM? Default is PASM if BC isn't specified }
#ifdef VEML7700_I2C_BC
i2c: "com.i2c.nocog" ' BC I2C engine
#else
i2c: "com.i2c" ' PASM I2C engine
#endif
core: "core.con.veml7700.spin" ' hw-specific low-level const's
time: "time" ' basic timing functions
PUB null()
' This is not a top-level object
PUB start(): status
' Start using default I/O settings
return startx(SCL, SDA, I2C_FREQ)
PUB startx(SCL_PIN, SDA_PIN, I2C_HZ): status
' Start using custom IO pins and I2C bus frequency
if ( lookdown(SCL_PIN: 0..31) and lookdown(SDA_PIN: 0..31) )
if ( status := i2c.init(SCL_PIN, SDA_PIN, I2C_HZ) )
time.usleep(core.T_POR) ' wait for device startup
if ( present() ) ' test device bus presence
return
' if this point is reached, something above failed
' Re-check I/O pin assignments, bus speed, connections, power
' Lastly - make sure you have at least one free core/cog
return FALSE
PUB stop()
' Stop the driver
i2c.deinit()
PUB defaults()
' Set factory defaults
als_gain(1_000) ' 1x gain
als_integr_time(25) ' 25ms integration time
powered(false)
PUB preset_active()
' Like default settings, but enable sensor power
defaults()
powered(true)
PUB present(): ack | tmp
' Check for device presence
i2c.start()
tmp := i2c.write(SLAVE_WR)
i2c.stop()
return (tmp == i2c.ACK)
PUB als_data(): als_adc
' Read Ambient Light Sensor data
' Returns:
readreg(core.ALS, 2, @als_adc)
PUB als_gain(gain): curr_gain
' Set sensor gain factor
' Valid values: 1_000 (1x), 2_000 (2x), 125 (1/8), 250 (1/4)
' Any other value polls the chip and returns the current setting
curr_gain := 0
readreg(core.ALS_CONF_0, 2, @curr_gain)
case gain
1_000, 2_000, 125, 250:
_als_gain := gain
gain := lookdownz(gain: 1_000, 2_000, 125, 250) << core.ALS_GAIN
gain := ((curr_gain & core.ALS_GAIN_MASK) | gain)
writereg(core.ALS_CONF_0, 2, @gain)
other:
curr_gain := ((curr_gain >> core.ALS_GAIN) & core.ALS_GAIN_BITS)
return lookupz(curr_gain: 1_000, 2_000, 125, 250)
update_lux_res()
PUB als_integr_time(itime): curr_itime
' Set sensor integration time, in milliseconds
' Valid values: 25, 50, 100, 200, 400, 800
' Any other value polls the chip and returns the current setting
curr_itime := 0
readreg(core.ALS_CONF_0, 2, @curr_itime)
case itime
100, 200, 400, 800:
_als_itime := itime
itime := lookdownz(itime: 100, 200, 400, 800) << core.ALS_IT
25:
_als_itime := itime
itime := %1100 << core.ALS_IT
50:
_als_itime := itime
itime := %1000 << core.ALS_IT
other:
curr_itime := (curr_itime >> core.ALS_IT) & core.ALS_IT_BITS
if (curr_itime < %1000)
return lookupz(curr_itime: 100, 200, 400, 800)
elseif (curr_itime == %1000)
return 50
elseif (curr_itime == %1100)
return 25
itime := ((curr_itime & core.ALS_IT_MASK) | itime)
writereg(core.ALS_CONF_0, 2, @itime)
update_lux_res()
PUB int_duration(dur): curr_dur
' Set number of consecutive measurements outside set threshold necessary to generate an interrupt
' Valid values: 1, 2, 4, 8
' Any other value polls the chip and returns the current setting
curr_dur := 0
readreg(core.ALS_CONF_0, 2, @curr_dur)
case dur
1, 2, 4, 8:
dur := lookdownz(dur: 1, 2, 4, 8) << core.ALS_PERS
dur := ((curr_dir & core.ALS_PERS_MASK) | dur)
writereg(core.ALS_CONF_0, 2, @dur)
other:
curr_dur := ((curr_dir >> core.ALS_PERS) & core.ALS_PERS_BITS)
return lookupz(curr_dur: 1, 2, 4, 8)
PUB int_ena(state): curr_state
' Enable interrupts
' Valid values: TRUE (-1 or 1), FALSE (0)
' Any other value polls the chip and returns the current setting
curr_state := 0
readreg(core.ALS_CONF_0, 2, @curr_state)
case ||(state)
0, 1:
state := ( (curr_state & core.ALS_SD_MASK) | ((state & 1) << core.ALS_INT_EN) )
writereg(core.ALS_CONF_0, 2, @state)
other:
return (((curr_state >> core.ALS_INT_EN) & 1) == 1)
PUB int_hi_thresh(): thresh
' Get currently set high interrupt threshold
thresh := 0
readreg(core.ALS_WH, 2, @thresh)
PUB int_lo_thresh(): thresh
' Get currently set low interrupt threshold
thresh := 0
readreg(core.ALS_WL, 2, @thresh)
PUB int_set_hi_thresh(thresh)
' Set interrupt high threshold
' Valid values: 0..65535 (clamped to range)
thresh := 0 #> thresh <# 65535
writereg(core.ALS_WH, 2, @thresh)
PUB int_set_lo_thresh(thresh)
' Set interrupt low threshold
' Valid values: 0..65535 (clamped to range)
thresh := 0 #> thresh <# 65535
writereg(core.ALS_WL, 2, @thresh)
PUB interrupt(): int_src
' Read interrupt flags
' Bits
' 15: low threshold exceeded
' 14: high threshold exceeded
int_src := 0
readreg(core.ALS_INT, 2, @int_src)
PUB lux(): l
' Return lux from live measurement
return ( als_data() * _lux_res )
PUB lux_maximum(): lm
' Get the maximum possible lux reading, given the current gain and integration time settings
return _lux_max
PUB power_save_ena(state): curr_state
' Enable power saving mode
' Valid values: TRUE (-1 or 1), FALSE (0)
' Any other value polls the chip and returns the current setting
curr_state := 0
readreg(core.PWR_SAVING, 2, @curr_state)
case ||(state)
0, 1:
state := ((curr_state & core.PSM_EN_MASK) | state)
writereg(core.PSM_EN_MASK, 2, @state)
other:
return ((curr_state & 1) == 1)
PUB power_save_mode(mode): curr_mode
' Set power saving mode
' Valid values: 1..4
' Any other value polls the chip and returns the current setting
' mode als_integr_time() refresh time (ms) current (uA) resolution (lx/bit)
' ---- ----------------- ----------------- ------------ -------------------
' 1 100 600 8 0.0288
' 2 100 1100 5 0.0288
' 3 100 2100 3 0.0288
' 4 100 4100 2 0.0288
' 1 200 700 13 0.0144
' 2 200 1200 8 0.0144
' 3 200 2200 5 0.0144
' 4 200 4200 3 0.0144
' 1 400 900 20 0.0072
' 2 400 1400 13 0.0072
' 3 400 2400 8 0.0072
' 4 400 4400 5 0.0072
' 1 800 1300 28 0.0036
' 2 800 1800 20 0.0036
' 3 800 2800 13 0.0036
' 4 800 4800 8 0.0036
curr_mode := 0
readreg(core.PWR_SAVING, 2, @curr_mode)
case mode
1..4:
mode := ((curr_mode & core.PSM_MASK) | (mode-1))
writereg(core.PWR_SAVING, 2, @mode)
other:
return ((curr_mode >> core.PSM) & core.PSM_BITS)
PUB powered(state): curr_state
' Enable sensor power
' Valid values: TRUE (-1 or 1), FALSE (0)
' Any other value polls the chip and returns the current setting
curr_state := 0
readreg(core.ALS_CONF_0, 2, @curr_state)
case ||(state)
0, 1:
{ ALS_SD is worded as a 'shut down' field, so 0 = power on, 1 = power off;
flip the bit here before writing it back to the sensor }
state := ((curr_state & core.ALS_SD_MASK) | ( (state ^ 1) & 1))
writereg(core.ALS_CONF_0, 2, @state)
other:
return ((curr_state & 1) == 1)
PUB update_lux_res()
' Update lux resolution (lux per ADC LSB)
case _als_gain
2_000:
case _als_itime
800: _lux_res := 0_0036
400: _lux_res := 0_0072
200: _lux_res := 0_0144
100: _lux_res := 0_0288
50: _lux_res := 0_0576
25: _lux_res := 0_1152
1_000:
case _als_itime
800: _lux_res := 0_0072
400: _lux_res := 0_0144
200: _lux_res := 0_0288
100: _lux_res := 0_0576
50: _lux_res := 0_1152
25: _lux_res := 0_2304
0_250:
case _als_itime
800: _lux_res := 0_0288
400: _lux_res := 0_0576
200: _lux_res := 0_1152
100: _lux_res := 0_2304
50: _lux_res := 0_4608
25: _lux_res := 0_9216
0_125:
case _als_itime
800: _lux_res := 0_0576
400: _lux_res := 0_1152
200: _lux_res := 0_2304
100: _lux_res := 0_4608
50: _lux_res := 0_9216
25: _lux_res := 1_8432
_lux_max := (_lux_res * ADC_MAX)
PUB white_data(): white_adc
' Read ambient light sensor data - wide spectral response
' Returns: ADC counts
white_adc := 0
readreg(core.WHITE, 2, @white_adc)
PRI readreg(reg_nr, nr_bytes, ptr_buff) | cmd_pkt
' Read nr_bytes from the device into ptr_buff
case reg_nr ' validate register num
$00..$06:
cmd_pkt.byte[0] := SLAVE_WR
cmd_pkt.byte[1] := reg_nr
i2c.start()
i2c.wrblock_lsbf(@cmd_pkt, 2)
i2c.start()
i2c.wr_byte(SLAVE_RD)
i2c.rdblock_lsbf(ptr_buff, nr_bytes, i2c.NAK)
i2c.stop()
other: ' invalid reg_nr
return
PRI writereg(reg_nr, nr_bytes, ptr_buff) | cmd_pkt
' Write nr_bytes to the device from ptr_buff
case reg_nr
$00..$02:
cmd_pkt.byte[0] := SLAVE_WR
cmd_pkt.byte[1] := reg_nr
i2c.start()
i2c.wrblock_lsbf(@cmd_pkt, 2)
i2c.wrblock_lsbf(ptr_buff, nr_bytes)
i2c.stop()
other:
return
DAT
{
Copyright 2024 Jesse Burt
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
}