proximity12  2.0.0.0
proximity12.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef PROXIMITY12_H
29 #define PROXIMITY12_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define PROXIMITY12_REG_AILT 0x2E
60 #define PROXIMITY12_REG_AIHT 0x31
61 #define PROXIMITY12_REG_PILT0 0x34
62 #define PROXIMITY12_REG_PIHT0 0x36
63 #define PROXIMITY12_REG_PILT1 0x38
64 #define PROXIMITY12_REG_PIHT1 0x3A
65 #define PROXIMITY12_REG_PILTR 0x3C
66 #define PROXIMITY12_REG_PIHTR 0x3E
67 #define PROXIMITY12_REG_FD_CFG0 0x40
68 #define PROXIMITY12_REG_FD_CFG1 0x41
69 #define PROXIMITY12_REG_FD_CFG2 0x42
70 #define PROXIMITY12_REG_FD_CFG3 0x43
71 #define PROXIMITY12_REG_FD_CFG4 0x44
72 #define PROXIMITY12_REG_FD_CFG5 0x45
73 #define PROXIMITY12_REG_FD_CFG6 0x46
74 #define PROXIMITY12_REG_FD_CFG7 0x47
75 #define PROXIMITY12_REG_FD_CFG8 0x48
76 #define PROXIMITY12_REG_SYNC_DELAY 0x4F
77 #define PROXIMITY12_REG_VSYNC_CFG0 0x53
78 #define PROXIMITY12_REG_VSYNC_CFG1 0x54
79 #define PROXIMITY12_REG_VSYNC_CFG2 0x56
80 #define PROXIMITY12_REG_VSYNC_CFG3 0x57
81 #define PROXIMITY12_REG_CALIB 0x69
82 #define PROXIMITY12_REG_CALIBCFG0 0x6A
83 #define PROXIMITY12_REG_CALIBCFG1 0x6B
84 #define PROXIMITY12_REG_CALIBCFG2 0x6C
85 #define PROXIMITY12_REG_CALIBSTAT 0x6D
86 #define PROXIMITY12_REG_ENABLE 0x80
87 #define PROXIMITY12_REG_MEAS_MODE0 0x81
88 #define PROXIMITY12_REG_MEAS_MODE1 0x82
89 #define PROXIMITY12_REG_TRIGGER_MODE 0x83
90 #define PROXIMITY12_REG_ATIME 0x84
91 #define PROXIMITY12_REG_ASTEP 0x85
92 #define PROXIMITY12_REG_PTIME 0x87
93 #define PROXIMITY12_REG_WTIPE 0x88
94 #define PROXIMITY12_REG_MOD_GAIN_0_1 0x89
95 #define PROXIMITY12_REG_MOD_GAIN_2_3 0x8A
96 #define PROXIMITY12_REG_MOD_GAIN_4_5 0x8B
97 #define PROXIMITY12_REG_MOD_GAIN_6_7 0x8C
98 #define PROXIMITY12_REG_AGC_ENABLE 0x8D
99 #define PROXIMITY12_REG_AUXID 0x90
100 #define PROXIMITY12_REG_REVID 0x91
101 #define PROXIMITY12_REG_ID 0x92
102 #define PROXIMITY12_REG_CFG0 0x93
103 #define PROXIMITY12_REG_CFG3 0x96
104 #define PROXIMITY12_REG_CFG4 0x97
105 #define PROXIMITY12_REG_PERS 0x9A
106 #define PROXIMITY12_REG_CFG8 0x9B
107 #define PROXIMITY12_REG_CFG9 0x9C
108 #define PROXIMITY12_REG_CFG10 0x9D
109 #define PROXIMITY12_REG_CFG11 0x9E
110 #define PROXIMITY12_REG_CFG12 0x9F
111 #define PROXIMITY12_REG_AZ_CONFIG 0xA4
112 #define PROXIMITY12_REG_CFG20 0xA7
113 #define PROXIMITY12_REG_PCFG1 0xAA
114 #define PROXIMITY12_REG_PCFG2 0xAB
115 #define PROXIMITY12_REG_PCFG3 0xAC
116 #define PROXIMITY12_REG_PCFG4 0xAD
117 #define PROXIMITY12_REG_PCFG5 0xAE
118 #define PROXIMITY12_REG_PCFG6 0xAF
119 #define PROXIMITY12_REG_PCFG7 0xB0
120 #define PROXIMITY12_REG_POFFSET0 0xB1
121 #define PROXIMITY12_REG_PXAVG 0xB3
122 #define PROXIMITY12_REG_PBSLN 0xB5
123 #define PROXIMITY12_REG_STATUS 0xB7
124 #define PROXIMITY12_REG_STATUS2 0xB8
125 #define PROXIMITY12_REG_STATUS3 0xB9
126 #define PROXIMITY12_REG_STATUS4 0xBA
127 #define PROXIMITY12_REG_STATUS5 0xBB
128 #define PROXIMITY12_REG_STATUS7 0xBD
129 #define PROXIMITY12_REG_STATUS8 0xBE
130 #define PROXIMITY12_REG_STATUS9 0xBF
131 #define PROXIMITY12_REG_ASTATUS 0xC0
132 #define PROXIMITY12_REG_ADATA0 0xC1
133 #define PROXIMITY12_REG_ADATA1 0xC4
134 #define PROXIMITY12_REG_ADATA2 0xC7
135 #define PROXIMITY12_REG_ADATA3 0xCA
136 #define PROXIMITY12_REG_ADATA4 0xCD
137 #define PROXIMITY12_REG_ADATA5 0xD0
138 #define PROXIMITY12_REG_ADATA6 0xD3
139 #define PROXIMITY12_REG_ADATA7 0xD6
140 #define PROXIMITY12_REG_PSTATUS 0xD9
141 #define PROXIMITY12_REG_PDATA0 0xDA
142 #define PROXIMITY12_REG_PDATA1 0xDC
143 #define PROXIMITY12_REG_PDATAR 0xDE
144 #define PROXIMITY12_REG_GPIO 0xF2
145 #define PROXIMITY12_REG_AGC_GAIN_MAX 0xF4
146 #define PROXIMITY12_REG_INTENAB 0xF5
147 #define PROXIMITY12_REG_CONTROL 0xF6
148 #define PROXIMITY12_REG_POFFSET1 0xF7
149 #define PROXIMITY12_REG_FIFO_MAP 0xF9
150 #define PROXIMITY12_REG_FIFO_MAP2 0xFA
151 #define PROXIMITY12_REG_FIFO_STATUS 0xFB
152 #define PROXIMITY12_REG_FDATA 0xFC
153  // proximity12_reg
155 
170 #define PROXIMITY12_ENABLE_FLICKER 0x40
171 #define PROXIMITY12_ENABLE_ALS 0x10
172 #define PROXIMITY12_ENABLE_PROX 0x08
173 #define PROXIMITY12_ENABLE_POWER 0x01
174 
179 #define PROXIMITY12_MEAS_MODE0_CL_APF_VSYNC 0x40
180 #define PROXIMITY12_MEAS_MODE0_EN_PROX_DIODE 0x0C
181 #define PROXIMITY12_MEAS_MODE0_ALS_SET_A_DIODE 0x00
182 #define PROXIMITY12_MEAS_MODE0_ALS_SET_B_DIODE 0x02
183 #define PROXIMITY12_MEAS_MODE0_EN_ALS_DIODE 0x01
184 
189 #define PROXIMITY12_AGC_DISABLE_ALL_MOD 0x00
190 #define PROXIMITY12_AGC_ENABLE_ALL_MOD 0xFF
191 #define PROXIMITY12_AGC_ENABLE_MOD_7 0x80
192 #define PROXIMITY12_AGC_ENABLE_MOD_6 0x40
193 #define PROXIMITY12_AGC_ENABLE_MOD_5 0x20
194 #define PROXIMITY12_AGC_ENABLE_MOD_4 0x10
195 #define PROXIMITY12_AGC_ENABLE_MOD_3 0x08
196 #define PROXIMITY12_AGC_ENABLE_MOD_2 0x04
197 #define PROXIMITY12_AGC_ENABLE_MOD_1 0x02
198 #define PROXIMITY12_AGC_ENABLE_MOD_0 0x01
199 #define PROXIMITY12_MOD_GAIN_2X 0x00
200 #define PROXIMITY12_MOD_GAIN_4X 0x01
201 #define PROXIMITY12_MOD_GAIN_8X 0x02
202 #define PROXIMITY12_MOD_GAIN_16X 0x03
203 #define PROXIMITY12_MOD_GAIN_32X 0x04
204 #define PROXIMITY12_MOD_GAIN_64X 0x05
205 #define PROXIMITY12_MOD_GAIN_128X 0x06
206 #define PROXIMITY12_MOD_GAIN_256X 0x07
207 #define PROXIMITY12_MOD_GAIN_512X 0x08
208 #define PROXIMITY12_MOD_GAIN_1024X 0x09
209 #define PROXIMITY12_MOD_GAIN_2048X 0x0A
210 #define PROXIMITY12_MOD_GAIN_4096X 0x0B
211 
216 #define PROXIMITY12_PROX_FILTER_ENABLE 0x08
217 #define PROXIMITY12_PROX_FILTER_1 0x00
218 #define PROXIMITY12_PROX_FILTER_2 0x01
219 #define PROXIMITY12_PROX_FILTER_3 0x02
220 #define PROXIMITY12_PROX_FILTER_4 0x03
221 #define PROXIMITY12_PROX_FILTER_5 0x04
222 #define PROXIMITY12_PROX_FILTER_6 0x05
223 #define PROXIMITY12_PROX_FILTER_7 0x06
224 #define PROXIMITY12_PROX_FILTER_8 0x07
225 
230 #define PROXIMITY12_ISINK_SCALER_0p5 0x00
231 #define PROXIMITY12_ISINK_SCALER_1 0x01
232 #define PROXIMITY12_ISINK_SCALER_1p5 0x02
233 #define PROXIMITY12_ISINK_SCALER_2 0x03
234 #define PROXIMITY12_ISINK_CURRENT_0mA 0x00
235 #define PROXIMITY12_ISINK_CURRENT_1mA 0x01
236 #define PROXIMITY12_ISINK_CURRENT_2mA 0x02
237 #define PROXIMITY12_ISINK_CURRENT_3mA 0x03
238 #define PROXIMITY12_ISINK_CURRENT_4mA 0x04
239 #define PROXIMITY12_ISINK_CURRENT_5mA 0x05
240 #define PROXIMITY12_ISINK_CURRENT_6mA 0x06
241 #define PROXIMITY12_ISINK_CURRENT_7mA 0x07
242 
247 #define PROXIMITY12_PROX_GAIN_1X 0x00
248 #define PROXIMITY12_PROX_GAIN_2X 0x01
249 #define PROXIMITY12_PROX_GAIN_4X 0x02
250 #define PROXIMITY12_PROX_GAIN_8X 0x03
251 
256 #define PROXIMITY12_AUXID 0x03
257 #define PROXIMITY12_REVID 0x13
258 #define PROXIMITY12_ID 0x40
259 
265 #define PROXIMITY12_SET_DEV_ADDR 0x39
266  // proximity12_set
268 
283 #define PROXIMITY12_MAP_MIKROBUS( cfg, mikrobus ) \
284  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
285  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
286  cfg.syn = MIKROBUS( mikrobus, MIKROBUS_CS ); \
287  cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
288  cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
289  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
290  // proximity12_map // proximity12
293 
298 typedef struct
299 {
300  // Output pins
301  digital_out_t syn;
302  digital_out_t gp1;
303  digital_out_t gp2;
305  // Input pins
306  digital_in_t int_pin;
308  // Modules
309  i2c_master_t i2c;
311  // I2C slave address
312  uint8_t slave_address;
314 } proximity12_t;
315 
320 typedef struct
321 {
322  pin_name_t scl;
323  pin_name_t sda;
325  pin_name_t syn;
326  pin_name_t gp1;
327  pin_name_t gp2;
328  pin_name_t int_pin;
330  uint32_t i2c_speed;
331  uint8_t i2c_address;
334 
339 typedef struct
340 {
341  uint32_t clear;
342  uint32_t red;
343  uint32_t green;
344  uint32_t blue;
345  uint32_t leakage;
346  uint32_t wideband;
347  uint32_t ir1;
348  uint32_t ir2;
349 
351 
356 typedef enum
357 {
359  PROXIMITY12_ERROR = -1
360 
362 
379 
394 
408 
423 err_t proximity12_generic_write ( proximity12_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
424 
439 err_t proximity12_generic_read ( proximity12_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
440 
452 
464 err_t proximity12_read_proximity ( proximity12_t *ctx, uint16_t *prox_data );
465 
479 
491 
503 
515 err_t proximity12_enable ( proximity12_t *ctx, uint8_t en_mask );
516 
528 err_t proximity12_enable_measurement ( proximity12_t *ctx, uint8_t en_mask );
529 
541 
553 err_t proximity12_set_proximity_filter ( proximity12_t *ctx, uint8_t filter );
554 
567 err_t proximity12_set_led_isink ( proximity12_t *ctx, uint8_t scaler, uint8_t current );
568 
580 err_t proximity12_set_proximity_gain ( proximity12_t *ctx, uint8_t gain );
581 
594 err_t proximity12_set_agc_mod_gain ( proximity12_t *ctx, uint8_t en_mask, uint8_t gain );
595 
605 void proximity12_set_syn_pin ( proximity12_t *ctx, uint8_t state );
606 
616 void proximity12_set_gp1_pin ( proximity12_t *ctx, uint8_t state );
617 
627 void proximity12_set_gp2_pin ( proximity12_t *ctx, uint8_t state );
628 
638 
639 #ifdef __cplusplus
640 }
641 #endif
642 #endif // PROXIMITY12_H
643  // proximity12
645 
646 // ------------------------------------------------------------------------ END
proximity12_als_data_t::green
uint32_t green
Definition: proximity12.h:343
proximity12_check_device_id
err_t proximity12_check_device_id(proximity12_t *ctx)
Proximity 12 check device ID function.
proximity12_set_agc_mod_gain
err_t proximity12_set_agc_mod_gain(proximity12_t *ctx, uint8_t en_mask, uint8_t gain)
Proximity 12 set agc modulator gain function.
proximity12_generic_write
err_t proximity12_generic_write(proximity12_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Proximity 12 I2C writing function.
proximity12_enable_measurement
err_t proximity12_enable_measurement(proximity12_t *ctx, uint8_t en_mask)
Proximity 12 enable measurement function.
proximity12_cfg_t::int_pin
pin_name_t int_pin
Definition: proximity12.h:328
proximity12_als_data_t::ir1
uint32_t ir1
Definition: proximity12.h:347
proximity12_read_als
err_t proximity12_read_als(proximity12_t *ctx, proximity12_als_data_t *als)
Proximity 12 read als data function.
proximity12_t::i2c
i2c_master_t i2c
Definition: proximity12.h:309
proximity12_init
err_t proximity12_init(proximity12_t *ctx, proximity12_cfg_t *cfg)
Proximity 12 initialization function.
proximity12_set_proximity_filter
err_t proximity12_set_proximity_filter(proximity12_t *ctx, uint8_t filter)
Proximity 12 set proximity filter function.
proximity12_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: proximity12.h:330
proximity12_cfg_t::sda
pin_name_t sda
Definition: proximity12.h:323
proximity12_t::slave_address
uint8_t slave_address
Definition: proximity12.h:312
proximity12_t::gp2
digital_out_t gp2
Definition: proximity12.h:303
proximity12_wait_atime
err_t proximity12_wait_atime(proximity12_t *ctx)
Proximity 12 wait atime function.
proximity12_return_value_t
proximity12_return_value_t
Proximity 12 Click return value data.
Definition: proximity12.h:357
proximity12_cfg_t
Proximity 12 Click configuration object.
Definition: proximity12.h:321
proximity12_set_syn_pin
void proximity12_set_syn_pin(proximity12_t *ctx, uint8_t state)
Proximity 12 set syn pin state function.
proximity12_enable
err_t proximity12_enable(proximity12_t *ctx, uint8_t en_mask)
Proximity 12 enable function.
proximity12_als_data_t::leakage
uint32_t leakage
Definition: proximity12.h:345
proximity12_cfg_t::scl
pin_name_t scl
Definition: proximity12.h:322
proximity12_set_gp2_pin
void proximity12_set_gp2_pin(proximity12_t *ctx, uint8_t state)
Proximity 12 set gp2 pin state function.
proximity12_als_data_t
Proximity 12 ALS data object.
Definition: proximity12.h:340
proximity12_als_data_t::clear
uint32_t clear
Definition: proximity12.h:341
proximity12_cfg_t::syn
pin_name_t syn
Definition: proximity12.h:325
proximity12_generic_read
err_t proximity12_generic_read(proximity12_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Proximity 12 I2C reading function.
proximity12_cfg_t::gp2
pin_name_t gp2
Definition: proximity12.h:327
proximity12_set_proximity_gain
err_t proximity12_set_proximity_gain(proximity12_t *ctx, uint8_t gain)
Proximity 12 set proximity gain function.
proximity12_als_data_t::blue
uint32_t blue
Definition: proximity12.h:344
proximity12_t::gp1
digital_out_t gp1
Definition: proximity12.h:302
PROXIMITY12_ERROR
@ PROXIMITY12_ERROR
Definition: proximity12.h:359
proximity12_set_led_isink
err_t proximity12_set_led_isink(proximity12_t *ctx, uint8_t scaler, uint8_t current)
Proximity 12 set led isink function.
proximity12_t::int_pin
digital_in_t int_pin
Definition: proximity12.h:306
proximity12_als_data_t::wideband
uint32_t wideband
Definition: proximity12.h:346
proximity12_t::syn
digital_out_t syn
Definition: proximity12.h:301
proximity12_cfg_t::gp1
pin_name_t gp1
Definition: proximity12.h:326
proximity12_cfg_t::i2c_address
uint8_t i2c_address
Definition: proximity12.h:331
proximity12_proximity_calibration
err_t proximity12_proximity_calibration(proximity12_t *ctx)
Proximity 12 proximity calibration function.
proximity12_cfg_setup
void proximity12_cfg_setup(proximity12_cfg_t *cfg)
Proximity 12 configuration object setup function.
proximity12_get_int_pin
uint8_t proximity12_get_int_pin(proximity12_t *ctx)
Proximity 12 get int pin state function.
proximity12_read_proximity
err_t proximity12_read_proximity(proximity12_t *ctx, uint16_t *prox_data)
Proximity 12 read proximity function.
proximity12_set_gp1_pin
void proximity12_set_gp1_pin(proximity12_t *ctx, uint8_t state)
Proximity 12 set gp1 pin state function.
proximity12_wait_ptime
err_t proximity12_wait_ptime(proximity12_t *ctx)
Proximity 12 wait ptime function.
PROXIMITY12_OK
@ PROXIMITY12_OK
Definition: proximity12.h:358
proximity12_als_data_t::red
uint32_t red
Definition: proximity12.h:342
proximity12_t
Proximity 12 Click context object.
Definition: proximity12.h:299
proximity12_default_cfg
err_t proximity12_default_cfg(proximity12_t *ctx)
Proximity 12 default configuration function.
proximity12_als_data_t::ir2
uint32_t ir2
Definition: proximity12.h:348