lightranger11  2.1.0.0
lightranger11.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 LIGHTRANGER11_H
29 #define LIGHTRANGER11_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 LIGHTRANGER11_DCI_ZONE_CONFIG 0x5450
60 #define LIGHTRANGER11_DCI_FREQ_HZ 0x5458
61 #define LIGHTRANGER11_DCI_INT_TIME 0x545C
62 #define LIGHTRANGER11_DCI_FW_NB_TARGET 0x5478
63 #define LIGHTRANGER11_DCI_RANGING_MODE 0xAD30
64 #define LIGHTRANGER11_DCI_DSS_CONFIG 0xAD38
65 #define LIGHTRANGER11_DCI_TARGET_ORDER 0xAE64
66 #define LIGHTRANGER11_DCI_SHARPENER 0xAED8
67 #define LIGHTRANGER11_DCI_INTERNAL_CP 0xB39C
68 #define LIGHTRANGER11_DCI_MOTION_DETECTOR_CFG 0xBFAC
69 #define LIGHTRANGER11_DCI_SINGLE_RANGE 0xCD5C
70 #define LIGHTRANGER11_DCI_OUTPUT_CONFIG 0xCD60
71 #define LIGHTRANGER11_DCI_OUTPUT_ENABLES 0xCD68
72 #define LIGHTRANGER11_DCI_OUTPUT_LIST 0xCD78
73 #define LIGHTRANGER11_DCI_PIPE_CONTROL 0xCF78
74 
79 #define LIGHTRANGER11_UI_CMD_STATUS 0x2C00
80 #define LIGHTRANGER11_UI_CMD_START 0x2C04
81 #define LIGHTRANGER11_UI_CMD_END 0x2FFF
82  // lightranger11_reg
84 
99 #define LIGHTRANGER11_TEMP_BUFFER_SIZE 1024
100 #define LIGHTRANGER11_NVM_DATA_SIZE 492
101 #define LIGHTRANGER11_OFFSET_BUFFER_SIZE 488
102 #define LIGHTRANGER11_XTALK_BUFFER_SIZE 776
103 
108 #define LIGHTRANGER11_RESOLUTION_4X4 16
109 #define LIGHTRANGER11_RESOLUTION_8X8 64
110 
115 #define LIGHTRANGER11_RANGING_MODE_CONTINUOUS 1
116 #define LIGHTRANGER11_RANGING_MODE_AUTONOMOUS 3
117 
122 #define LIGHTRANGER11_START_BH 0x0000000Dul
123 #define LIGHTRANGER11_METADATA_BH 0x54B400C0ul
124 #define LIGHTRANGER11_COMMONDATA_BH 0x54C00040ul
125 #define LIGHTRANGER11_AMBIENT_RATE_BH 0x54D00104ul
126 #define LIGHTRANGER11_SPAD_COUNT_BH 0x55D00404ul
127 #define LIGHTRANGER11_NB_TARGET_DETECTED_BH 0xCF7C0401ul
128 #define LIGHTRANGER11_SIGNAL_RATE_BH 0xCFBC0404ul
129 #define LIGHTRANGER11_RANGE_SIGMA_MM_BH 0xD2BC0402ul
130 #define LIGHTRANGER11_DISTANCE_BH 0xD33C0402ul
131 #define LIGHTRANGER11_REFLECTANCE_BH 0xD43C0401ul
132 #define LIGHTRANGER11_TARGET_STATUS_BH 0xD47C0401ul
133 #define LIGHTRANGER11_MOTION_DETECT_BH 0xCC5008C0ul
134 #define LIGHTRANGER11_METADATA_IDX 0x54B4
135 #define LIGHTRANGER11_SPAD_COUNT_IDX 0x55D0
136 #define LIGHTRANGER11_AMBIENT_RATE_IDX 0x54D0
137 #define LIGHTRANGER11_NB_TARGET_DETECTED_IDX 0xCF7C
138 #define LIGHTRANGER11_SIGNAL_RATE_IDX 0xCFBC
139 #define LIGHTRANGER11_RANGE_SIGMA_MM_IDX 0xD2BC
140 #define LIGHTRANGER11_DISTANCE_IDX 0xD33C
141 #define LIGHTRANGER11_REFLECTANCE_EST_PC_IDX 0xD43C
142 #define LIGHTRANGER11_TARGET_STATUS_IDX 0xD47C
143 #define LIGHTRANGER11_MOTION_DETEC_IDX 0xCC50
144 
149 #define LIGHTRANGER11_DEF_RESOLUTION LIGHTRANGER11_RESOLUTION_8X8
150 #define LIGHTRANGER11_DEF_RANGING_FREQ_HZ 2
151 #define LIGHTRANGER11_DEF_RANGING_MODE LIGHTRANGER11_RANGING_MODE_AUTONOMOUS
152 #define LIGHTRANGER11_DEF_INTEGRATION_TIME_MS 20
153 
159 #define LIGHTRANGER11_DEVICE_ADDRESS 0x29
160  // lightranger11_set
162 
177 #define LIGHTRANGER11_MAP_MIKROBUS( cfg, mikrobus ) \
178  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
179  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
180  cfg.rsc = MIKROBUS( mikrobus, MIKROBUS_RST ); \
181  cfg.lp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
182  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
183  // lightranger11_map // lightranger11
186 
191 typedef struct
192 {
193  // Output pins
194  digital_out_t rsc;
195  digital_out_t lp;
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[ LIGHTRANGER11_OFFSET_BUFFER_SIZE ];
213  uint8_t temp_buf[ LIGHTRANGER11_TEMP_BUFFER_SIZE ];
214 
216 
221 typedef struct
222 {
223  pin_name_t scl;
224  pin_name_t sda;
226  pin_name_t rsc;
227  pin_name_t lp;
228  pin_name_t int_pin;
230  uint32_t i2c_speed;
231  uint8_t i2c_address;
234 
239 typedef struct
240 {
243 
245  uint8_t nb_target_detected[ 64 ];
246 
248  int16_t distance_mm[ 64 ];
249 
251  uint8_t target_status[ 64 ];
252 
254 
259 typedef enum
260 {
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 lightranger11_write_multi ( lightranger11_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len );
342 
357 err_t lightranger11_read_multi ( lightranger11_t *ctx, uint16_t reg, uint8_t *data_out, uint16_t len );
358 
371 err_t lightranger11_write_byte ( lightranger11_t *ctx, uint16_t reg, uint8_t data_in );
372 
385 err_t lightranger11_read_byte ( lightranger11_t *ctx, uint16_t reg, uint8_t *data_out );
386 
399 err_t lightranger11_write_data ( lightranger11_t *ctx, uint8_t *data_in, uint16_t len );
400 
412 
422 
432 void lightranger11_set_i2c_rst_pin ( lightranger11_t *ctx, uint8_t state );
433 
443 void lightranger11_set_lpn_pin ( lightranger11_t *ctx, uint8_t state );
444 
454 
467 
482 err_t lightranger11_dci_write_data ( lightranger11_t *ctx, uint16_t index,
483  uint8_t *data_in,
484  uint16_t data_size );
485 
502 err_t lightranger11_dci_read_data ( lightranger11_t *ctx, uint16_t index,
503  uint8_t *data_out,
504  uint16_t data_size );
505 
523 err_t lightranger11_dci_replace_data ( lightranger11_t *ctx, uint16_t index, uint8_t *data_in,
524  uint16_t data_size, uint8_t *new_data,
525  uint16_t new_data_size, uint16_t new_data_pos );
526 
539 err_t lightranger11_set_resolution ( lightranger11_t *ctx, uint8_t resolution );
540 
552 err_t lightranger11_get_resolution ( lightranger11_t *ctx, uint8_t *resolution );
553 
568 err_t lightranger11_set_rang_freq_hz ( lightranger11_t *ctx, uint8_t frequency_hz );
569 
582 err_t lightranger11_get_rang_freq_hz ( lightranger11_t *ctx, uint8_t *frequency_hz );
583 
598 err_t lightranger11_set_integ_time_ms ( lightranger11_t *ctx, uint32_t integration_time_ms );
599 
611 err_t lightranger11_get_integ_time_ms ( lightranger11_t *ctx, uint32_t *integration_time_ms );
612 
627 err_t lightranger11_set_ranging_mode ( lightranger11_t *ctx, uint8_t ranging_mode );
628 
642 err_t lightranger11_get_ranging_mode ( lightranger11_t *ctx, uint8_t *ranging_mode );
643 
656 
669 
683 
684 #ifdef __cplusplus
685 }
686 #endif
687 #endif // LIGHTRANGER11_H
688  // lightranger11
690 
691 // ------------------------------------------------------------------------ END
lightranger11_set_ranging_mode
err_t lightranger11_set_ranging_mode(lightranger11_t *ctx, uint8_t ranging_mode)
LightRanger 11 set ranging mode function.
lightranger11_cfg_t::sda
pin_name_t sda
Definition: lightranger11.h:224
lightranger11_get_resolution
err_t lightranger11_get_resolution(lightranger11_t *ctx, uint8_t *resolution)
LightRanger 11 get resolution function.
lightranger11_sensor_init
err_t lightranger11_sensor_init(lightranger11_t *ctx)
LightRanger 11 sensor init function.
lightranger11_dci_write_data
err_t lightranger11_dci_write_data(lightranger11_t *ctx, uint16_t index, uint8_t *data_in, uint16_t data_size)
LightRanger 11 dci write data function.
lightranger11_set_lpn_pin
void lightranger11_set_lpn_pin(lightranger11_t *ctx, uint8_t state)
LightRanger 11 set lpn function.
lightranger11_get_rang_freq_hz
err_t lightranger11_get_rang_freq_hz(lightranger11_t *ctx, uint8_t *frequency_hz)
LightRanger 11 get ranging frequency hz function.
lightranger11_get_int_pin
uint8_t lightranger11_get_int_pin(lightranger11_t *ctx)
LightRanger 11 get int pin function.
lightranger11_get_ranging_data
err_t lightranger11_get_ranging_data(lightranger11_t *ctx, lightranger11_results_data_t *results)
LightRanger 11 get ranging data function.
lightranger11_default_cfg
err_t lightranger11_default_cfg(lightranger11_t *ctx)
LightRanger 11 default configuration function.
LIGHTRANGER11_OK
@ LIGHTRANGER11_OK
Definition: lightranger11.h:261
lightranger11_reset_i2c
void lightranger11_reset_i2c(lightranger11_t *ctx)
LightRanger 11 reset i2c function.
LIGHTRANGER11_TEMP_BUFFER_SIZE
#define LIGHTRANGER11_TEMP_BUFFER_SIZE
LightRanger 11 buffers size setting.
Definition: lightranger11.h:99
lightranger11_t::i2c
i2c_master_t i2c
Definition: lightranger11.h:201
lightranger11_read_multi
err_t lightranger11_read_multi(lightranger11_t *ctx, uint16_t reg, uint8_t *data_out, uint16_t len)
LightRanger 11 read multi function.
lightranger11_set_integ_time_ms
err_t lightranger11_set_integ_time_ms(lightranger11_t *ctx, uint32_t integration_time_ms)
LightRanger 11 set integration time ms function.
lightranger11_init
err_t lightranger11_init(lightranger11_t *ctx, lightranger11_cfg_t *cfg)
LightRanger 11 initialization function.
lightranger11_cfg_t
LightRanger 11 Click configuration object.
Definition: lightranger11.h:222
lightranger11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: lightranger11.h:230
lightranger11_return_value_t
lightranger11_return_value_t
LightRanger 11 Click return value data.
Definition: lightranger11.h:260
LIGHTRANGER11_OFFSET_BUFFER_SIZE
#define LIGHTRANGER11_OFFSET_BUFFER_SIZE
Definition: lightranger11.h:101
lightranger11_write_data
err_t lightranger11_write_data(lightranger11_t *ctx, uint8_t *data_in, uint16_t len)
LightRanger 11 write data function.
LIGHTRANGER11_ERROR
@ LIGHTRANGER11_ERROR
Definition: lightranger11.h:262
lightranger11_block_header_t
LightRanger 11 Click block header union data definition.
Definition: lightranger11.h:271
lightranger11_t::slave_address
uint8_t slave_address
Definition: lightranger11.h:204
lightranger11_dci_read_data
err_t lightranger11_dci_read_data(lightranger11_t *ctx, uint16_t index, uint8_t *data_out, uint16_t data_size)
LightRanger 11 dci read data function.
lightranger11_cfg_setup
void lightranger11_cfg_setup(lightranger11_cfg_t *cfg)
LightRanger 11 configuration object setup function.
lightranger11_cfg_t::i2c_address
uint8_t i2c_address
Definition: lightranger11.h:231
lightranger11_set_i2c_rst_pin
void lightranger11_set_i2c_rst_pin(lightranger11_t *ctx, uint8_t state)
LightRanger 11 set i2c rst function.
lightranger11_read_byte
err_t lightranger11_read_byte(lightranger11_t *ctx, uint16_t reg, uint8_t *data_out)
LightRanger 11 read byte function.
lightranger11_t::stream_count
uint8_t stream_count
Definition: lightranger11.h:207
lightranger11_cfg_t::lp
pin_name_t lp
Definition: lightranger11.h:227
lightranger11_t::data_read_size
uint32_t data_read_size
Definition: lightranger11.h:209
lightranger11_set_rang_freq_hz
err_t lightranger11_set_rang_freq_hz(lightranger11_t *ctx, uint8_t frequency_hz)
LightRanger 11 set ranging frequency hz function.
lightranger11_stop_ranging
err_t lightranger11_stop_ranging(lightranger11_t *ctx)
LightRanger 11 stop ranging function.
lightranger11_results_data_t
LightRanger 11 Click block header union data definition.
Definition: lightranger11.h:240
lightranger11_get_ranging_mode
err_t lightranger11_get_ranging_mode(lightranger11_t *ctx, uint8_t *ranging_mode)
LightRanger 11 get ranging mode function.
lightranger11_write_multi
err_t lightranger11_write_multi(lightranger11_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len)
LightRanger 11 write multi function.
lightranger11_get_integ_time_ms
err_t lightranger11_get_integ_time_ms(lightranger11_t *ctx, uint32_t *integration_time_ms)
LightRanger 11 get integration time ms function.
lightranger11_t::rsc
digital_out_t rsc
Definition: lightranger11.h:194
lightranger11_cfg_t::scl
pin_name_t scl
Definition: lightranger11.h:223
lightranger11_block_header_t::size
uint32_t size
Definition: lightranger11.h:276
lightranger11_write_byte
err_t lightranger11_write_byte(lightranger11_t *ctx, uint16_t reg, uint8_t data_in)
LightRanger 11 write byte function.
lightranger11_block_header_t::idx
uint32_t idx
Definition: lightranger11.h:277
lightranger11_t::int_pin
digital_in_t int_pin
Definition: lightranger11.h:198
lightranger11_check_comm
err_t lightranger11_check_comm(lightranger11_t *ctx)
LightRanger 11 check communication function.
lightranger11_start_ranging
err_t lightranger11_start_ranging(lightranger11_t *ctx)
LightRanger 11 start ranging function.
lightranger11_block_header_t::type
uint32_t type
Definition: lightranger11.h:275
lightranger11_t::lp
digital_out_t lp
Definition: lightranger11.h:195
lightranger11_t
LightRanger 11 Click context object.
Definition: lightranger11.h:192
lightranger11_cfg_t::int_pin
pin_name_t int_pin
Definition: lightranger11.h:228
lightranger11_cfg_t::rsc
pin_name_t rsc
Definition: lightranger11.h:226
lightranger11_dci_replace_data
err_t lightranger11_dci_replace_data(lightranger11_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)
LightRanger 11 dci replace data function.
lightranger11_results_data_t::silicon_temp_degc
int8_t silicon_temp_degc
Definition: lightranger11.h:242
lightranger11_block_header_t::bytes
uint32_t bytes
Definition: lightranger11.h:272
lightranger11_set_resolution
err_t lightranger11_set_resolution(lightranger11_t *ctx, uint8_t resolution)
LightRanger 11 set resolution function.