proximity17  2.0.0.0
proximity17.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 PROXIMITY17_H
29 #define PROXIMITY17_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define PROXIMITY17_REG_ENABLE 0x80
74 #define PROXIMITY17_REG_PRATE 0x82
75 #define PROXIMITY17_REG_PILTL 0x88
76 #define PROXIMITY17_REG_PILTH 0x89
77 #define PROXIMITY17_REG_PIHTL 0x8A
78 #define PROXIMITY17_REG_PIHTH 0x8B
79 #define PROXIMITY17_REG_PERS 0x8C
80 #define PROXIMITY17_REG_CFG0 0x8D
81 #define PROXIMITY17_REG_PCFG0 0x8E
82 #define PROXIMITY17_REG_PCFG1 0x8F
83 #define PROXIMITY17_REG_REVID 0x91
84 #define PROXIMITY17_REG_ID 0x92
85 #define PROXIMITY17_REG_STATUS 0x9B
86 #define PROXIMITY17_REG_PDATAL 0x9C
87 #define PROXIMITY17_REG_PDATAH 0x9D
88 #define PROXIMITY17_REG_REVID2 0xA6
89 #define PROXIMITY17_REG_SOFTRST 0xA8
90 #define PROXIMITY17_REG_PWTIME 0xA9
91 #define PROXIMITY17_REG_CFG8 0xAA
92 #define PROXIMITY17_REG_CFG3 0xAB
93 #define PROXIMITY17_REG_CFG6 0xAE
94 #define PROXIMITY17_REG_PFILTER 0xB3
95 #define PROXIMITY17_REG_POFFSETL 0xC0
96 #define PROXIMITY17_REG_POFFSETH 0xC1
97 #define PROXIMITY17_REG_CALIB 0xD7
98 #define PROXIMITY17_REG_CALIBCFG 0xD9
99 #define PROXIMITY17_REG_CALIBSTAT 0xDC
100 #define PROXIMITY17_REG_INTENAB 0xDD
101 #define PROXIMITY17_REG_FAC_L 0xE5
102 #define PROXIMITY17_REG_FAC_H 0xE6
103 #define PROXIMITY17_REG_TEST9 0xF9
104  // proximity17_reg
106 
121 #define PROXIMITY17_ENABLE_PWEN 0x10
122 #define PROXIMITY17_ENABLE_PEN 0x04
123 #define PROXIMITY17_ENABLE_PON 0x01
124 
129 #define PROXIMITY17_SOFT_RESET 0x01
130 
135 #define PROXIMITY17_PGAIN_1X 0x00
136 #define PROXIMITY17_PGAIN_2X 0x40
137 #define PROXIMITY17_PGAIN_4X 0x80
138 #define PROXIMITY17_PGAIN_8X 0xC0
139 #define PROXIMITY17_PPULSE_MIN 0x00
140 #define PROXIMITY17_PPULSE_DEFAULT 0x0F
141 #define PROXIMITY17_PPULSE_MAX 0x3F
142 
147 #define PROXIMITY17_PPULSE_LEN_1US 0x00
148 #define PROXIMITY17_PPULSE_LEN_2US 0x20
149 #define PROXIMITY17_PPULSE_LEN_4US 0x40
150 #define PROXIMITY17_PPULSE_LEN_8US 0x60
151 #define PROXIMITY17_PPULSE_LEN_12US 0x80
152 #define PROXIMITY17_PPULSE_LEN_16US 0xA0
153 #define PROXIMITY17_PPULSE_LEN_24US 0xC0
154 #define PROXIMITY17_PPULSE_LEN_32US 0xE0
155 #define PROXIMITY17_PLDRIVE_2mA 0x00
156 #define PROXIMITY17_PLDRIVE_3mA 0x01
157 #define PROXIMITY17_PLDRIVE_4mA 0x02
158 #define PROXIMITY17_PLDRIVE_5mA 0x03
159 #define PROXIMITY17_PLDRIVE_6mA 0x04
160 #define PROXIMITY17_PLDRIVE_7mA 0x05
161 #define PROXIMITY17_PLDRIVE_8mA 0x06
162 #define PROXIMITY17_PLDRIVE_9mA 0x07
163 #define PROXIMITY17_PLDRIVE_10mA 0x08
164 
169 #define PROXIMITY17_PDSELECT_NO_PDIODE 0x00
170 #define PROXIMITY17_PDSELECT_FAR_PDIODE 0x01
171 #define PROXIMITY17_PDSELECT_NEAR_PDIODE 0x02
172 #define PROXIMITY17_PDSELECT_BOTH_PDIODE 0x03
173 
178 #define PROXIMITY17_STATUS_PHIGH 0x80
179 #define PROXIMITY17_STATUS_PLOW 0x40
180 #define PROXIMITY17_STATUS_PSAT 0x20
181 #define PROXIMITY17_STATUS_PINT 0x10
182 #define PROXIMITY17_STATUS_CINT 0x08
183 #define PROXIMITY17_STATUS_ZINT 0x04
184 #define PROXIMITY17_STATUS_PSAT_REFLECTIVE 0x02
185 #define PROXIMITY17_STATUS_PSAT_AMBIENT 0x01
186 #define PROXIMITY17_STATUS_CLEAR_ALL 0xFF
187 
192 #define PROXIMITY17_INTENAB_PIM 0x20
193 #define PROXIMITY17_INTENAB_PIEN 0x10
194 #define PROXIMITY17_INTENAB_PSIEN 0x08
195 #define PROXIMITY17_INTENAB_CIEN 0x04
196 #define PROXIMITY17_INTENAB_ZIEN 0x02
197 #define PROXIMITY17_INTENAB_DISABLE 0x00
198 
203 #define PROXIMITY17_CALAVG 0x80
204 #define PROXIMITY17_ELECTRICAL_CALIB 0x20
205 #define PROXIMITY17_CALPRATE 0x10
206 #define PROXIMITY17_START_OFFSET_CAL 0x01
207 
212 #define PROXIMITY17_BINSRCH_TARGET_3 0x00
213 #define PROXIMITY17_BINSRCH_TARGET_7 0x20
214 #define PROXIMITY17_BINSRCH_TARGET_15 0x40
215 #define PROXIMITY17_BINSRCH_TARGET_31 0x60
216 #define PROXIMITY17_BINSRCH_TARGET_63 0x80
217 #define PROXIMITY17_BINSRCH_TARGET_127 0xA0
218 #define PROXIMITY17_BINSRCH_TARGET_255 0xC0
219 #define PROXIMITY17_BINSRCH_TARGET_511 0xE0
220 #define PROXIMITY17_CALIBCFG_RESERVED 0x10
221 #define PROXIMITY17_AUTO_OFFSET_ADJ 0x08
222 #define PROXIMITY17_PROX_AVG_DISABLE 0x00
223 #define PROXIMITY17_PROX_AVG_2 0x01
224 #define PROXIMITY17_PROX_AVG_4 0x02
225 #define PROXIMITY17_PROX_AVG_8 0x03
226 #define PROXIMITY17_PROX_AVG_16 0x04
227 #define PROXIMITY17_PROX_AVG_32 0x05
228 #define PROXIMITY17_PROX_AVG_64 0x06
229 #define PROXIMITY17_PROX_AVG_128 0x07
230 
235 #define PROXIMITY17_OFFSET_ADJUSTED 0x04
236 #define PROXIMITY17_CALIB_FINISHED 0x01
237 
242 #define PROXIMITY17_APC_ENABLE 0x3F
243 #define PROXIMITY17_APC_DISABLE 0x7F
244 
249 #define PROXIMITY17_DEVICE_ID 0x44
250 
256 #define PROXIMITY17_DEVICE_ADDRESS 0x39
257  // proximity17_set
259 
274 #define PROXIMITY17_MAP_MIKROBUS( cfg, mikrobus ) \
275  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
276  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
277  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
278  // proximity17_map // proximity17
281 
286 typedef struct
287 {
288  // Input pins
289  digital_in_t int_pin;
291  // Modules
292  i2c_master_t i2c;
294  // I2C slave address
295  uint8_t slave_address;
297 } proximity17_t;
298 
303 typedef struct
304 {
305  pin_name_t scl;
306  pin_name_t sda;
308  pin_name_t int_pin;
310  uint32_t i2c_speed;
311  uint8_t i2c_address;
314 
319 typedef enum
320 {
322  PROXIMITY17_ERROR = -1
323 
325 
342 
357 
371 
386 err_t proximity17_generic_write ( proximity17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
387 
402 err_t proximity17_generic_read ( proximity17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
403 
416 err_t proximity17_write_register ( proximity17_t *ctx, uint8_t reg, uint8_t data_in );
417 
430 err_t proximity17_read_register ( proximity17_t *ctx, uint8_t reg, uint8_t *data_out );
431 
444 
456 
468 err_t proximity17_read_proximity ( proximity17_t *ctx, uint16_t *prox_data );
469 
479 
480 #ifdef __cplusplus
481 }
482 #endif
483 #endif // PROXIMITY17_H
484  // proximity17
486 
487 // ------------------------------------------------------------------------ END
proximity17_cfg_t::i2c_address
uint8_t i2c_address
Definition: proximity17.h:311
proximity17_soft_reset
err_t proximity17_soft_reset(proximity17_t *ctx)
Proximity 17 soft reset function.
proximity17_default_cfg
err_t proximity17_default_cfg(proximity17_t *ctx)
Proximity 17 default configuration function.
proximity17_cfg_t::scl
pin_name_t scl
Definition: proximity17.h:305
proximity17_check_communication
err_t proximity17_check_communication(proximity17_t *ctx)
Proximity 17 check communication function.
proximity17_write_register
err_t proximity17_write_register(proximity17_t *ctx, uint8_t reg, uint8_t data_in)
Proximity 17 write register function.
PROXIMITY17_OK
@ PROXIMITY17_OK
Definition: proximity17.h:321
proximity17_read_proximity
err_t proximity17_read_proximity(proximity17_t *ctx, uint16_t *prox_data)
Proximity 17 read proximity function.
PROXIMITY17_ERROR
@ PROXIMITY17_ERROR
Definition: proximity17.h:322
proximity17_return_value_t
proximity17_return_value_t
Proximity 17 Click return value data.
Definition: proximity17.h:320
proximity17_t::slave_address
uint8_t slave_address
Definition: proximity17.h:295
proximity17_cfg_t::sda
pin_name_t sda
Definition: proximity17.h:306
proximity17_cfg_t
Proximity 17 Click configuration object.
Definition: proximity17.h:304
proximity17_read_register
err_t proximity17_read_register(proximity17_t *ctx, uint8_t reg, uint8_t *data_out)
Proximity 17 read register function.
proximity17_generic_read
err_t proximity17_generic_read(proximity17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Proximity 17 I2C reading function.
proximity17_t::i2c
i2c_master_t i2c
Definition: proximity17.h:292
proximity17_cfg_t::int_pin
pin_name_t int_pin
Definition: proximity17.h:308
proximity17_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: proximity17.h:310
proximity17_cfg_setup
void proximity17_cfg_setup(proximity17_cfg_t *cfg)
Proximity 17 configuration object setup function.
proximity17_t
Proximity 17 Click context object.
Definition: proximity17.h:287
proximity17_generic_write
err_t proximity17_generic_write(proximity17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Proximity 17 I2C writing function.
proximity17_init
err_t proximity17_init(proximity17_t *ctx, proximity17_cfg_t *cfg)
Proximity 17 initialization function.
proximity17_t::int_pin
digital_in_t int_pin
Definition: proximity17.h:289
proximity17_get_int_pin
uint8_t proximity17_get_int_pin(proximity17_t *ctx)
Proximity 17 get int pin function.