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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define PROXIMITY16_DCI_ZONE_CONFIG 0x5450
60 #define PROXIMITY16_DCI_FREQ_HZ 0x5458
61 #define PROXIMITY16_DCI_INT_TIME 0x545C
62 #define PROXIMITY16_DCI_FW_NB_TARGET 0x5478
63 #define PROXIMITY16_DCI_RANGING_MODE 0xAD30
64 #define PROXIMITY16_DCI_DSS_CONFIG 0xAD38
65 #define PROXIMITY16_DCI_TARGET_ORDER 0xAE64
66 #define PROXIMITY16_DCI_SHARPENER 0xAED8
67 #define PROXIMITY16_DCI_INTERNAL_CP 0xB39C
68 #define PROXIMITY16_DCI_MOTION_DETECTOR_CFG 0xBFAC
69 #define PROXIMITY16_DCI_SINGLE_RANGE 0xCD5C
70 #define PROXIMITY16_DCI_OUTPUT_CONFIG 0xCD60
71 #define PROXIMITY16_DCI_OUTPUT_ENABLES 0xCD68
72 #define PROXIMITY16_DCI_OUTPUT_LIST 0xCD78
73 #define PROXIMITY16_DCI_PIPE_CONTROL 0xCF78
74 
79 #define PROXIMITY16_UI_CMD_STATUS 0x2C00
80 #define PROXIMITY16_UI_CMD_START 0x2C04
81 #define PROXIMITY16_UI_CMD_END 0x2FFF
82  // proximity16_reg
84 
99 #define PROXIMITY16_TEMP_BUFFER_SIZE 1024
100 #define PROXIMITY16_NVM_DATA_SIZE 492
101 #define PROXIMITY16_OFFSET_BUFFER_SIZE 488
102 #define PROXIMITY16_XTALK_BUFFER_SIZE 776
103 
108 #define PROXIMITY16_RESOLUTION_4X4 16
109 #define PROXIMITY16_RESOLUTION_8X8 64
110 
115 #define PROXIMITY16_RANGING_MODE_CONTINUOUS 1
116 #define PROXIMITY16_RANGING_MODE_AUTONOMOUS 3
117 
122 #define PROXIMITY16_START_BH 0x0000000Dul
123 #define PROXIMITY16_METADATA_BH 0x54B400C0ul
124 #define PROXIMITY16_COMMONDATA_BH 0x54C00040ul
125 #define PROXIMITY16_AMBIENT_RATE_BH 0x54D00104ul
126 #define PROXIMITY16_SPAD_COUNT_BH 0x55D00404ul
127 #define PROXIMITY16_NB_TARGET_DETECTED_BH 0xCF7C0401ul
128 #define PROXIMITY16_SIGNAL_RATE_BH 0xCFBC0404ul
129 #define PROXIMITY16_RANGE_SIGMA_MM_BH 0xD2BC0402ul
130 #define PROXIMITY16_DISTANCE_BH 0xD33C0402ul
131 #define PROXIMITY16_REFLECTANCE_BH 0xD43C0401ul
132 #define PROXIMITY16_TARGET_STATUS_BH 0xD47C0401ul
133 #define PROXIMITY16_MOTION_DETECT_BH 0xCC5008C0ul
134 #define PROXIMITY16_METADATA_IDX 0x54B4
135 #define PROXIMITY16_SPAD_COUNT_IDX 0x55D0
136 #define PROXIMITY16_AMBIENT_RATE_IDX 0x54D0
137 #define PROXIMITY16_NB_TARGET_DETECTED_IDX 0xCF7C
138 #define PROXIMITY16_SIGNAL_RATE_IDX 0xCFBC
139 #define PROXIMITY16_RANGE_SIGMA_MM_IDX 0xD2BC
140 #define PROXIMITY16_DISTANCE_IDX 0xD33C
141 #define PROXIMITY16_REFLECTANCE_EST_PC_IDX 0xD43C
142 #define PROXIMITY16_TARGET_STATUS_IDX 0xD47C
143 #define PROXIMITY16_MOTION_DETEC_IDX 0xCC50
144 
149 #define PROXIMITY16_DEF_RESOLUTION PROXIMITY16_RESOLUTION_8X8
150 #define PROXIMITY16_DEF_RANGING_FREQ_HZ 2
151 #define PROXIMITY16_DEF_RANGING_MODE PROXIMITY16_RANGING_MODE_AUTONOMOUS
152 #define PROXIMITY16_DEF_INTEGRATION_TIME_MS 20
153 
159 #define PROXIMITY16_DEVICE_ADDRESS 0x29
160  // proximity16_set
162 
177 #define PROXIMITY16_MAP_MIKROBUS( cfg, mikrobus ) \
178  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
179  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
180  cfg.i2c_rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
181  cfg.lpn = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
182  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
183  // proximity16_map // proximity16
186 
191 typedef struct
192 {
193  // Output pins
194  digital_out_t i2c_rst;
195  digital_out_t lpn;
197  // Input pins
198  digital_in_t int_pin;
200  // Modules
201  i2c_master_t i2c;
203  // I2C slave address
204  uint8_t slave_address;
207  uint8_t stream_count;
209  uint32_t data_read_size;
211  uint8_t offset_data[ PROXIMITY16_OFFSET_BUFFER_SIZE ];
213  uint8_t temp_buf[ PROXIMITY16_TEMP_BUFFER_SIZE ];
214 
215 } proximity16_t;
216 
221 typedef struct
222 {
223  pin_name_t scl;
224  pin_name_t sda;
226  pin_name_t i2c_rst;
227  pin_name_t lpn;
228  pin_name_t int_pin;
230  uint32_t i2c_speed;
231  uint8_t i2c_address;
234 
239 typedef enum
240 {
242  PROXIMITY16_ERROR = -1
243 
245 
250 typedef struct
251 {
254 
256  uint8_t nb_target_detected[ PROXIMITY16_RESOLUTION_8X8 ];
257 
259  int16_t distance_mm[ PROXIMITY16_RESOLUTION_8X8 ];
260 
262  uint8_t target_status[ PROXIMITY16_RESOLUTION_8X8 ];
263 
265 
270 typedef union
271 {
272  uint32_t bytes;
273  struct
274  {
275  uint32_t type : 4;
276  uint32_t size : 12;
277  uint32_t idx : 16;
278  };
280 
297 
312 
326 
341 err_t proximity16_write_multi ( proximity16_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len );
342 
357 err_t proximity16_read_multi ( proximity16_t *ctx, uint16_t reg, uint8_t *data_out, uint16_t len );
358 
371 err_t proximity16_write_byte ( proximity16_t *ctx, uint16_t reg, uint8_t data_in );
372 
385 err_t proximity16_read_byte ( proximity16_t *ctx, uint16_t reg, uint8_t *data_out );
386 
399 err_t proximity16_write_data ( proximity16_t *ctx, uint8_t *data_in, uint16_t len );
400 
412 
422 
432 void proximity16_set_i2c_rst_pin ( proximity16_t *ctx, uint8_t state );
433 
443 void proximity16_set_lpn_pin ( proximity16_t *ctx, uint8_t state );
444 
454 
467 
482 err_t proximity16_dci_write_data ( proximity16_t *ctx, uint16_t index, uint8_t *data_in, uint16_t data_size );
483 
499 err_t proximity16_dci_read_data ( proximity16_t *ctx, uint16_t index, uint8_t *data_out, uint16_t data_size );
500 
518 err_t proximity16_dci_replace_data ( proximity16_t *ctx, uint16_t index, uint8_t *data_in, uint16_t data_size,
519  uint8_t *new_data, uint16_t new_data_size, uint16_t new_data_pos );
520 
532 err_t proximity16_set_resolution ( proximity16_t *ctx, uint8_t resolution );
533 
545 err_t proximity16_get_resolution ( proximity16_t *ctx, uint8_t *resolution );
546 
559 err_t proximity16_set_ranging_frequency_hz ( proximity16_t *ctx, uint8_t frequency_hz );
560 
573 err_t proximity16_get_ranging_frequency_hz ( proximity16_t *ctx, uint8_t *frequency_hz );
574 
588 err_t proximity16_set_integration_time_ms ( proximity16_t *ctx, uint32_t integration_time_ms );
589 
601 err_t proximity16_get_integration_time_ms ( proximity16_t *ctx, uint32_t *integration_time_ms );
602 
615 err_t proximity16_set_ranging_mode ( proximity16_t *ctx, uint8_t ranging_mode );
616 
629 err_t proximity16_get_ranging_mode ( proximity16_t *ctx, uint8_t *ranging_mode );
630 
642 
655 
669 
670 #ifdef __cplusplus
671 }
672 #endif
673 #endif // PROXIMITY16_H
674  // proximity16
676 
677 // ------------------------------------------------------------------------ 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:242
proximity16_cfg_t::i2c_rst
pin_name_t i2c_rst
Definition: proximity16.h:226
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:271
proximity16_cfg_t::lpn
pin_name_t lpn
Definition: proximity16.h:227
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:276
proximity16_t::i2c_rst
digital_out_t i2c_rst
Definition: proximity16.h:194
proximity16_cfg_t::scl
pin_name_t scl
Definition: proximity16.h:223
PROXIMITY16_RESOLUTION_8X8
#define PROXIMITY16_RESOLUTION_8X8
Definition: proximity16.h:109
proximity16_results_data_t::silicon_temp_degc
int8_t silicon_temp_degc
Definition: proximity16.h:253
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:195
proximity16_cfg_t::i2c_address
uint8_t i2c_address
Definition: proximity16.h:231
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:222
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:192
proximity16_cfg_t::int_pin
pin_name_t int_pin
Definition: proximity16.h:228
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:204
proximity16_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: proximity16.h:230
proximity16_t::int_pin
digital_in_t int_pin
Definition: proximity16.h:198
proximity16_block_header_t::idx
uint32_t idx
Definition: proximity16.h:277
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:101
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:209
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:99
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:275
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:240
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:224
proximity16_t::stream_count
uint8_t stream_count
Definition: proximity16.h:207
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:241
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:201
proximity16_results_data_t
Proximity 16 Click results data structure.
Definition: proximity16.h:251
proximity16_block_header_t::bytes
uint32_t bytes
Definition: proximity16.h:272
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.