proximity16  2.1.0.0
proximity16.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 PROXIMITY16_H
29 #define PROXIMITY16_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
69 #define PROXIMITY16_DCI_ZONE_CONFIG 0x5450
70 #define PROXIMITY16_DCI_FREQ_HZ 0x5458
71 #define PROXIMITY16_DCI_INT_TIME 0x545C
72 #define PROXIMITY16_DCI_FW_NB_TARGET 0x5478
73 #define PROXIMITY16_DCI_RANGING_MODE 0xAD30
74 #define PROXIMITY16_DCI_DSS_CONFIG 0xAD38
75 #define PROXIMITY16_DCI_TARGET_ORDER 0xAE64
76 #define PROXIMITY16_DCI_SHARPENER 0xAED8
77 #define PROXIMITY16_DCI_INTERNAL_CP 0xB39C
78 #define PROXIMITY16_DCI_MOTION_DETECTOR_CFG 0xBFAC
79 #define PROXIMITY16_DCI_SINGLE_RANGE 0xCD5C
80 #define PROXIMITY16_DCI_OUTPUT_CONFIG 0xCD60
81 #define PROXIMITY16_DCI_OUTPUT_ENABLES 0xCD68
82 #define PROXIMITY16_DCI_OUTPUT_LIST 0xCD78
83 #define PROXIMITY16_DCI_PIPE_CONTROL 0xCF78
84 
89 #define PROXIMITY16_UI_CMD_STATUS 0x2C00
90 #define PROXIMITY16_UI_CMD_START 0x2C04
91 #define PROXIMITY16_UI_CMD_END 0x2FFF
92  // proximity16_reg
94 
109 #define PROXIMITY16_TEMP_BUFFER_SIZE 1024
110 #define PROXIMITY16_NVM_DATA_SIZE 492
111 #define PROXIMITY16_OFFSET_BUFFER_SIZE 488
112 #define PROXIMITY16_XTALK_BUFFER_SIZE 776
113 
118 #define PROXIMITY16_RESOLUTION_4X4 16
119 #define PROXIMITY16_RESOLUTION_8X8 64
120 
125 #define PROXIMITY16_RANGING_MODE_CONTINUOUS 1
126 #define PROXIMITY16_RANGING_MODE_AUTONOMOUS 3
127 
132 #define PROXIMITY16_START_BH 0x0000000Dul
133 #define PROXIMITY16_METADATA_BH 0x54B400C0ul
134 #define PROXIMITY16_COMMONDATA_BH 0x54C00040ul
135 #define PROXIMITY16_AMBIENT_RATE_BH 0x54D00104ul
136 #define PROXIMITY16_SPAD_COUNT_BH 0x55D00404ul
137 #define PROXIMITY16_NB_TARGET_DETECTED_BH 0xCF7C0401ul
138 #define PROXIMITY16_SIGNAL_RATE_BH 0xCFBC0404ul
139 #define PROXIMITY16_RANGE_SIGMA_MM_BH 0xD2BC0402ul
140 #define PROXIMITY16_DISTANCE_BH 0xD33C0402ul
141 #define PROXIMITY16_REFLECTANCE_BH 0xD43C0401ul
142 #define PROXIMITY16_TARGET_STATUS_BH 0xD47C0401ul
143 #define PROXIMITY16_MOTION_DETECT_BH 0xCC5008C0ul
144 #define PROXIMITY16_METADATA_IDX 0x54B4
145 #define PROXIMITY16_SPAD_COUNT_IDX 0x55D0
146 #define PROXIMITY16_AMBIENT_RATE_IDX 0x54D0
147 #define PROXIMITY16_NB_TARGET_DETECTED_IDX 0xCF7C
148 #define PROXIMITY16_SIGNAL_RATE_IDX 0xCFBC
149 #define PROXIMITY16_RANGE_SIGMA_MM_IDX 0xD2BC
150 #define PROXIMITY16_DISTANCE_IDX 0xD33C
151 #define PROXIMITY16_REFLECTANCE_EST_PC_IDX 0xD43C
152 #define PROXIMITY16_TARGET_STATUS_IDX 0xD47C
153 #define PROXIMITY16_MOTION_DETEC_IDX 0xCC50
154 
159 #define PROXIMITY16_DEF_RESOLUTION PROXIMITY16_RESOLUTION_8X8
160 #define PROXIMITY16_DEF_RANGING_FREQ_HZ 2
161 #define PROXIMITY16_DEF_RANGING_MODE PROXIMITY16_RANGING_MODE_AUTONOMOUS
162 #define PROXIMITY16_DEF_INTEGRATION_TIME_MS 20
163 
169 #define PROXIMITY16_DEVICE_ADDRESS 0x29
170  // proximity16_set
172 
187 #define PROXIMITY16_MAP_MIKROBUS( cfg, mikrobus ) \
188  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
189  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
190  cfg.i2c_rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
191  cfg.lpn = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
192  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
193  // proximity16_map // proximity16
196 
201 typedef struct
202 {
203  // Output pins
204  digital_out_t i2c_rst;
205  digital_out_t lpn;
207  // Input pins
208  digital_in_t int_pin;
210  // Modules
211  i2c_master_t i2c;
213  // I2C slave address
214  uint8_t slave_address;
217  uint8_t stream_count;
219  uint32_t data_read_size;
221  uint8_t offset_data[ PROXIMITY16_OFFSET_BUFFER_SIZE ];
223  uint8_t temp_buf[ PROXIMITY16_TEMP_BUFFER_SIZE ];
224 
225 } proximity16_t;
226 
231 typedef struct
232 {
233  pin_name_t scl;
234  pin_name_t sda;
236  pin_name_t i2c_rst;
237  pin_name_t lpn;
238  pin_name_t int_pin;
240  uint32_t i2c_speed;
241  uint8_t i2c_address;
244 
249 typedef enum
250 {
252  PROXIMITY16_ERROR = -1
253 
255 
260 typedef struct
261 {
264 
266  uint8_t nb_target_detected[ PROXIMITY16_RESOLUTION_8X8 ];
267 
269  int16_t distance_mm[ PROXIMITY16_RESOLUTION_8X8 ];
270 
272  uint8_t target_status[ PROXIMITY16_RESOLUTION_8X8 ];
273 
275 
280 typedef union
281 {
282  uint32_t bytes;
283  struct
284  {
285  uint32_t type : 4;
286  uint32_t size : 12;
287  uint32_t idx : 16;
288  };
290 
307 
322 
336 
351 err_t proximity16_write_multi ( proximity16_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len );
352 
367 err_t proximity16_read_multi ( proximity16_t *ctx, uint16_t reg, uint8_t *data_out, uint16_t len );
368 
381 err_t proximity16_write_byte ( proximity16_t *ctx, uint16_t reg, uint8_t data_in );
382 
395 err_t proximity16_read_byte ( proximity16_t *ctx, uint16_t reg, uint8_t *data_out );
396 
409 err_t proximity16_write_data ( proximity16_t *ctx, uint8_t *data_in, uint16_t len );
410 
422 
432 
442 void proximity16_set_i2c_rst_pin ( proximity16_t *ctx, uint8_t state );
443 
453 void proximity16_set_lpn_pin ( proximity16_t *ctx, uint8_t state );
454 
464 
477 
492 err_t proximity16_dci_write_data ( proximity16_t *ctx, uint16_t index, uint8_t *data_in, uint16_t data_size );
493 
509 err_t proximity16_dci_read_data ( proximity16_t *ctx, uint16_t index, uint8_t *data_out, uint16_t data_size );
510 
528 err_t proximity16_dci_replace_data ( proximity16_t *ctx, uint16_t index, uint8_t *data_in, uint16_t data_size,
529  uint8_t *new_data, uint16_t new_data_size, uint16_t new_data_pos );
530 
542 err_t proximity16_set_resolution ( proximity16_t *ctx, uint8_t resolution );
543 
555 err_t proximity16_get_resolution ( proximity16_t *ctx, uint8_t *resolution );
556 
569 err_t proximity16_set_ranging_frequency_hz ( proximity16_t *ctx, uint8_t frequency_hz );
570 
583 err_t proximity16_get_ranging_frequency_hz ( proximity16_t *ctx, uint8_t *frequency_hz );
584 
598 err_t proximity16_set_integration_time_ms ( proximity16_t *ctx, uint32_t integration_time_ms );
599 
611 err_t proximity16_get_integration_time_ms ( proximity16_t *ctx, uint32_t *integration_time_ms );
612 
625 err_t proximity16_set_ranging_mode ( proximity16_t *ctx, uint8_t ranging_mode );
626 
639 err_t proximity16_get_ranging_mode ( proximity16_t *ctx, uint8_t *ranging_mode );
640 
652 
665 
679 
680 #ifdef __cplusplus
681 }
682 #endif
683 #endif // PROXIMITY16_H
684  // proximity16
686 
687 // ------------------------------------------------------------------------ END
proximity16_read_byte
err_t proximity16_read_byte(proximity16_t *ctx, uint16_t reg, uint8_t *data_out)
Proximity 16 read byte function.
proximity16_set_ranging_frequency_hz
err_t proximity16_set_ranging_frequency_hz(proximity16_t *ctx, uint8_t frequency_hz)
Proximity 16 set ranging frequency hz function.
proximity16_init
err_t proximity16_init(proximity16_t *ctx, proximity16_cfg_t *cfg)
Proximity 16 initialization function.
proximity16_get_int_pin
uint8_t proximity16_get_int_pin(proximity16_t *ctx)
Proximity 16 get int pin function.
PROXIMITY16_ERROR
@ PROXIMITY16_ERROR
Definition: proximity16.h:252
proximity16_cfg_t::i2c_rst
pin_name_t i2c_rst
Definition: proximity16.h:236
proximity16_set_resolution
err_t proximity16_set_resolution(proximity16_t *ctx, uint8_t resolution)
Proximity 16 set resolution function.
proximity16_block_header_t
Proximity 16 Click block header union data definition.
Definition: proximity16.h:281
proximity16_cfg_t::lpn
pin_name_t lpn
Definition: proximity16.h:237
proximity16_get_ranging_mode
err_t proximity16_get_ranging_mode(proximity16_t *ctx, uint8_t *ranging_mode)
Proximity 16 get ranging mode function.
proximity16_block_header_t::size
uint32_t size
Definition: proximity16.h:286
proximity16_t::i2c_rst
digital_out_t i2c_rst
Definition: proximity16.h:204
proximity16_cfg_t::scl
pin_name_t scl
Definition: proximity16.h:233
PROXIMITY16_RESOLUTION_8X8
#define PROXIMITY16_RESOLUTION_8X8
Definition: proximity16.h:119
proximity16_results_data_t::silicon_temp_degc
int8_t silicon_temp_degc
Definition: proximity16.h:263
proximity16_sensor_init
err_t proximity16_sensor_init(proximity16_t *ctx)
Proximity 16 sensor init function.
proximity16_t::lpn
digital_out_t lpn
Definition: proximity16.h:205
proximity16_cfg_t::i2c_address
uint8_t i2c_address
Definition: proximity16.h:241
proximity16_write_multi
err_t proximity16_write_multi(proximity16_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len)
Proximity 16 write multi function.
proximity16_cfg_t
Proximity 16 Click configuration object.
Definition: proximity16.h:232
proximity16_get_resolution
err_t proximity16_get_resolution(proximity16_t *ctx, uint8_t *resolution)
Proximity 16 get resolution function.
proximity16_t
Proximity 16 Click context object.
Definition: proximity16.h:202
proximity16_cfg_t::int_pin
pin_name_t int_pin
Definition: proximity16.h:238
proximity16_default_cfg
err_t proximity16_default_cfg(proximity16_t *ctx)
Proximity 16 default configuration function.
proximity16_t::slave_address
uint8_t slave_address
Definition: proximity16.h:214
proximity16_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: proximity16.h:240
proximity16_t::int_pin
digital_in_t int_pin
Definition: proximity16.h:208
proximity16_block_header_t::idx
uint32_t idx
Definition: proximity16.h:287
proximity16_cfg_setup
void proximity16_cfg_setup(proximity16_cfg_t *cfg)
Proximity 16 configuration object setup function.
PROXIMITY16_OFFSET_BUFFER_SIZE
#define PROXIMITY16_OFFSET_BUFFER_SIZE
Definition: proximity16.h:111
proximity16_get_integration_time_ms
err_t proximity16_get_integration_time_ms(proximity16_t *ctx, uint32_t *integration_time_ms)
Proximity 16 get integration time ms function.
proximity16_set_ranging_mode
err_t proximity16_set_ranging_mode(proximity16_t *ctx, uint8_t ranging_mode)
Proximity 16 set ranging mode function.
proximity16_t::data_read_size
uint32_t data_read_size
Definition: proximity16.h:219
proximity16_write_byte
err_t proximity16_write_byte(proximity16_t *ctx, uint16_t reg, uint8_t data_in)
Proximity 16 write byte function.
proximity16_get_ranging_data
err_t proximity16_get_ranging_data(proximity16_t *ctx, proximity16_results_data_t *results)
Proximity 16 get ranging data function.
PROXIMITY16_TEMP_BUFFER_SIZE
#define PROXIMITY16_TEMP_BUFFER_SIZE
Proximity 16 buffers size setting.
Definition: proximity16.h:109
proximity16_write_data
err_t proximity16_write_data(proximity16_t *ctx, uint8_t *data_in, uint16_t len)
Proximity 16 write data function.
proximity16_block_header_t::type
uint32_t type
Definition: proximity16.h:285
proximity16_check_communication
err_t proximity16_check_communication(proximity16_t *ctx)
Proximity 16 check communication function.
proximity16_read_multi
err_t proximity16_read_multi(proximity16_t *ctx, uint16_t reg, uint8_t *data_out, uint16_t len)
Proximity 16 read multi function.
proximity16_set_lpn_pin
void proximity16_set_lpn_pin(proximity16_t *ctx, uint8_t state)
Proximity 16 set lpn function.
proximity16_return_value_t
proximity16_return_value_t
Proximity 16 Click return value data.
Definition: proximity16.h:250
proximity16_start_ranging
err_t proximity16_start_ranging(proximity16_t *ctx)
Proximity 16 start ranging function.
proximity16_cfg_t::sda
pin_name_t sda
Definition: proximity16.h:234
proximity16_t::stream_count
uint8_t stream_count
Definition: proximity16.h:217
proximity16_stop_ranging
err_t proximity16_stop_ranging(proximity16_t *ctx)
Proximity 16 stop ranging function.
proximity16_dci_write_data
err_t proximity16_dci_write_data(proximity16_t *ctx, uint16_t index, uint8_t *data_in, uint16_t data_size)
Proximity 16 dci write data function.
PROXIMITY16_OK
@ PROXIMITY16_OK
Definition: proximity16.h:251
proximity16_set_integration_time_ms
err_t proximity16_set_integration_time_ms(proximity16_t *ctx, uint32_t integration_time_ms)
Proximity 16 set integration time ms function.
proximity16_dci_read_data
err_t proximity16_dci_read_data(proximity16_t *ctx, uint16_t index, uint8_t *data_out, uint16_t data_size)
Proximity 16 dci read data function.
proximity16_set_i2c_rst_pin
void proximity16_set_i2c_rst_pin(proximity16_t *ctx, uint8_t state)
Proximity 16 set i2c rst function.
proximity16_reset_i2c
void proximity16_reset_i2c(proximity16_t *ctx)
Proximity 16 reset i2c function.
proximity16_t::i2c
i2c_master_t i2c
Definition: proximity16.h:211
proximity16_results_data_t
Proximity 16 Click results data structure.
Definition: proximity16.h:261
proximity16_block_header_t::bytes
uint32_t bytes
Definition: proximity16.h:282
proximity16_dci_replace_data
err_t proximity16_dci_replace_data(proximity16_t *ctx, uint16_t index, uint8_t *data_in, uint16_t data_size, uint8_t *new_data, uint16_t new_data_size, uint16_t new_data_pos)
Proximity 16 dci replace data function.
proximity16_get_ranging_frequency_hz
err_t proximity16_get_ranging_frequency_hz(proximity16_t *ctx, uint8_t *frequency_hz)
Proximity 16 get ranging frequency hz function.