lightranger10  2.0.0.0
lightranger10.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 LIGHTRANGER10_H
29 #define LIGHTRANGER10_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 LIGHTRANGER10_REG_SOFT_RESET 0x0000
60 #define LIGHTRANGER10_REG_ALGO_PTP_RANGE_OFFSET_MM 0x001E
61 #define LIGHTRANGER10_REG_MM_CFG_INNER_OFFSET_MM 0x0020
62 #define LIGHTRANGER10_REG_MM_CFG_OUTER_OFFSET_MM 0x0022
63 #define LIGHTRANGER10_REG_RANGE_CFG_VCSEL_PERIOD_A 0x0060
64 #define LIGHTRANGER10_REG_RANGE_CFG_VCSEL_PERIOD_B 0x0063
65 #define LIGHTRANGER10_REG_RANGE_CFG_VALID_PHASE_HIGH 0x0069
66 #define LIGHTRANGER10_REG_SD_CFG_WOI_SD0 0x0078
67 #define LIGHTRANGER10_REG_SD_CFG_WOI_SD1 0x0079
68 #define LIGHTRANGER10_REG_SD_CFG_INIT_PHASE_SD0 0x007A
69 #define LIGHTRANGER10_REG_SD_CFG_INIT_PHASE_SD1 0x007B
70 #define LIGHTRANGER10_REG_SYSTEM_INT_MEAS_PERIOD 0x006C
71 #define LIGHTRANGER10_REG_SYSTEM_INTERRUPT_CLEAR 0x0086
72 #define LIGHTRANGER10_REG_SYSTEM_MODE_START 0x0087
73 #define LIGHTRANGER10_REG_RESULT_RANGE_MM_SD0 0x0096
74 #define LIGHTRANGER10_REG_RESULT_OSC_CALIBRATE_VAL 0x00DE
75 #define LIGHTRANGER10_REG_MODEL_ID 0x010F
76 #define LIGHTRANGER10_REG_MODEL_TYPE 0x0110
77  // lightranger10_reg
79 
94 #define LIGHTRANGER10_SOFT_RESET_SET 0x00
95 #define LIGHTRANGER10_SOFT_RESET_CLEAR 0x01
96 
101 #define LIGHTRANGER10_INTERRUPT_CLEAR 0x01
102 
107 #define LIGHTRANGER10_RANGING_ENABLE 0x40
108 #define LIGHTRANGER10_RANGING_DISABLE 0x00
109 
114 #define LIGHTRANGER10_DISTANCE_MODE_MEDIUM 0x00
115 #define LIGHTRANGER10_DISTANCE_MODE_LONG 0x01
116 
121 #define LIGHTRANGER10_DISTANCE_MEDIUM_RANGE_PERIOD_A 0x0B
122 #define LIGHTRANGER10_DISTANCE_MEDIUM_RANGE_PERIOD_B 0x09
123 #define LIGHTRANGER10_DISTANCE_MEDIUM_RANGE_VAL_PH_H 0x78
124 #define LIGHTRANGER10_DISTANCE_MEDIUM_SD_WOI_SD0 0x0B
125 #define LIGHTRANGER10_DISTANCE_MEDIUM_SD_WOI_SD1 0x09
126 #define LIGHTRANGER10_DISTANCE_MEDIUM_SD_IN_PH_SD0 0x0A
127 #define LIGHTRANGER10_DISTANCE_MEDIUM_SD_IN_PH_SD1 0x0A
128 #define LIGHTRANGER10_DISTANCE_LONG_RANGE_PERIOD_A 0x0F
129 #define LIGHTRANGER10_DISTANCE_LONG_RANGE_PERIOD_B 0x0D
130 #define LIGHTRANGER10_DISTANCE_LONG_RANGE_VAL_PH_H 0xB8
131 #define LIGHTRANGER10_DISTANCE_LONG_SD_WOI_SD0 0x0F
132 #define LIGHTRANGER10_DISTANCE_LONG_SD_WOI_SD1 0x0D
133 #define LIGHTRANGER10_DISTANCE_LONG_SD_IN_PH_SD0 0x0E
134 #define LIGHTRANGER10_DISTANCE_LONG_SD_IN_PH_SD1 0x0E
135 
140 #define LIGHTRANGER10_ALGO_PTP_RANGE_OFFSET_MM_MULT 4
141 #define LIGHTRANGER10_ALGO_PTP_RANGE_OFFSET_MM_RESET 0
142 #define LIGHTRANGER10_MM_CFG_INNER_OFFSET_MM_RESET 0
143 #define LIGHTRANGER10_MM_CFG_OUTER_OFFSET_MM_RESET 0
144 #define LIGHTRANGER10_CALIBRATE_DISTANCE_AVERAGE_NUM 20
145 
150 #define LIGHTRANGER10_DEFAULT_IM_PERIOD_MS 200
151 #define LIGHTRANGER10_OSC_CALIB_IM_PERIOD_OFFSET 4
152 
157 #define LIGHTRANGER10_MODEL_ID 0xEB
158 #define LIGHTRANGER10_MODEL_TYPE 0xAA
159 
165 #define LIGHTRANGER10_DEVICE_ADDRESS 0x29
166  // lightranger10_set
168 
183 #define LIGHTRANGER10_MAP_MIKROBUS( cfg, mikrobus ) \
184  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
185  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
186  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
187  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
188  // lightranger10_map // lightranger10
191 
196 typedef struct
197 {
198  // Output pins
199  digital_out_t en;
201  // Input pins
202  digital_in_t int_pin;
204  // Modules
205  i2c_master_t i2c;
207  // I2C slave address
208  uint8_t slave_address;
211 
216 typedef struct
217 {
218  pin_name_t scl;
219  pin_name_t sda;
221  pin_name_t en;
222  pin_name_t int_pin;
224  uint32_t i2c_speed;
225  uint8_t i2c_address;
228 
233 typedef enum
234 {
237 
239 
256 
271 
285 
300 err_t lightranger10_generic_write ( lightranger10_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len );
301 
316 err_t lightranger10_generic_read ( lightranger10_t *ctx, uint16_t reg, uint8_t *data_out, uint8_t len );
317 
330 err_t lightranger10_write_byte ( lightranger10_t *ctx, uint16_t reg, uint8_t data_in );
331 
344 err_t lightranger10_read_byte ( lightranger10_t *ctx, uint16_t reg, uint8_t *data_out );
345 
359 err_t lightranger10_write_word ( lightranger10_t *ctx, uint16_t reg, uint16_t data_in );
360 
374 err_t lightranger10_read_word ( lightranger10_t *ctx, uint16_t reg, uint16_t *data_out );
375 
389 err_t lightranger10_write_dword ( lightranger10_t *ctx, uint16_t reg, uint32_t data_in );
390 
404 err_t lightranger10_read_dword ( lightranger10_t *ctx, uint16_t reg, uint16_t *data_out );
405 
417 
427 
437 
447 
457 
469 
481 
494 
506 err_t lightranger10_set_distance_offset ( lightranger10_t *ctx, int16_t offset_mm );
507 
519 err_t lightranger10_calibrate_distance ( lightranger10_t *ctx, uint16_t target_distance_mm );
520 
533 err_t lightranger10_set_distance_mode ( lightranger10_t *ctx, uint8_t distance_mode );
534 
546 
558 
570 err_t lightranger10_get_distance ( lightranger10_t *ctx, uint16_t *distance_mm );
571 
572 #ifdef __cplusplus
573 }
574 #endif
575 #endif // LIGHTRANGER10_H
576  // lightranger10
578 
579 // ------------------------------------------------------------------------ END
lightranger10_t::slave_address
uint8_t slave_address
Definition: lightranger10.h:208
lightranger10_set_distance_offset
err_t lightranger10_set_distance_offset(lightranger10_t *ctx, int16_t offset_mm)
LightRanger 10 set distance offset function.
lightranger10_default_cfg
err_t lightranger10_default_cfg(lightranger10_t *ctx)
LightRanger 10 default configuration function.
lightranger10_cfg_t::sda
pin_name_t sda
Definition: lightranger10.h:219
lightranger10_read_byte
err_t lightranger10_read_byte(lightranger10_t *ctx, uint16_t reg, uint8_t *data_out)
LightRanger 10 read byte function.
lightranger10_cfg_t::en
pin_name_t en
Definition: lightranger10.h:221
lightranger10_write_dword
err_t lightranger10_write_dword(lightranger10_t *ctx, uint16_t reg, uint32_t data_in)
LightRanger 10 write dword function.
LIGHTRANGER10_ERROR
@ LIGHTRANGER10_ERROR
Definition: lightranger10.h:236
lightranger10_t::int_pin
digital_in_t int_pin
Definition: lightranger10.h:202
lightranger10_cfg_t::scl
pin_name_t scl
Definition: lightranger10.h:218
lightranger10_generic_write
err_t lightranger10_generic_write(lightranger10_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len)
LightRanger 10 I2C writing function.
lightranger10_read_word
err_t lightranger10_read_word(lightranger10_t *ctx, uint16_t reg, uint16_t *data_out)
LightRanger 10 read word function.
lightranger10_cfg_t
LightRanger 10 Click configuration object.
Definition: lightranger10.h:217
lightranger10_enable_device
void lightranger10_enable_device(lightranger10_t *ctx)
LightRanger 10 enable device function.
lightranger10_cfg_t::int_pin
pin_name_t int_pin
Definition: lightranger10.h:222
lightranger10_disable_device
void lightranger10_disable_device(lightranger10_t *ctx)
LightRanger 10 disable device function.
lightranger10_soft_reset
err_t lightranger10_soft_reset(lightranger10_t *ctx)
LightRanger 10 soft reset function.
lightranger10_cfg_t::i2c_address
uint8_t i2c_address
Definition: lightranger10.h:225
lightranger10_check_communication
err_t lightranger10_check_communication(lightranger10_t *ctx)
LightRanger 10 check communication function.
lightranger10_start_measurement
err_t lightranger10_start_measurement(lightranger10_t *ctx)
LightRanger 10 start measurement function.
lightranger10_t::en
digital_out_t en
Definition: lightranger10.h:199
lightranger10_reset_device
void lightranger10_reset_device(lightranger10_t *ctx)
LightRanger 10 reset device function.
lightranger10_write_word
err_t lightranger10_write_word(lightranger10_t *ctx, uint16_t reg, uint16_t data_in)
LightRanger 10 write word function.
lightranger10_cfg_setup
void lightranger10_cfg_setup(lightranger10_cfg_t *cfg)
LightRanger 10 configuration object setup function.
lightranger10_calibrate_distance
err_t lightranger10_calibrate_distance(lightranger10_t *ctx, uint16_t target_distance_mm)
LightRanger 10 calibrate distance function.
lightranger10_get_int_pin
uint8_t lightranger10_get_int_pin(lightranger10_t *ctx)
LightRanger 10 get int pin function.
lightranger10_return_value_t
lightranger10_return_value_t
LightRanger 10 Click return value data.
Definition: lightranger10.h:234
LIGHTRANGER10_OK
@ LIGHTRANGER10_OK
Definition: lightranger10.h:235
lightranger10_get_distance
err_t lightranger10_get_distance(lightranger10_t *ctx, uint16_t *distance_mm)
LightRanger 10 get distance function.
lightranger10_write_byte
err_t lightranger10_write_byte(lightranger10_t *ctx, uint16_t reg, uint8_t data_in)
LightRanger 10 write byte function.
lightranger10_set_distance_mode
err_t lightranger10_set_distance_mode(lightranger10_t *ctx, uint8_t distance_mode)
LightRanger 10 set distance mode function.
lightranger10_generic_read
err_t lightranger10_generic_read(lightranger10_t *ctx, uint16_t reg, uint8_t *data_out, uint8_t len)
LightRanger 10 I2C reading function.
lightranger10_set_inter_measurement_period_ms
err_t lightranger10_set_inter_measurement_period_ms(lightranger10_t *ctx, uint32_t period_ms)
LightRanger 10 set inter measurement period ms function.
lightranger10_read_dword
err_t lightranger10_read_dword(lightranger10_t *ctx, uint16_t reg, uint16_t *data_out)
LightRanger 10 read dword function.
lightranger10_t::i2c
i2c_master_t i2c
Definition: lightranger10.h:205
lightranger10_stop_measurement
err_t lightranger10_stop_measurement(lightranger10_t *ctx)
LightRanger 10 stop measurement function.
lightranger10_t
LightRanger 10 Click context object.
Definition: lightranger10.h:197
lightranger10_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: lightranger10.h:224
lightranger10_clear_interrupts
err_t lightranger10_clear_interrupts(lightranger10_t *ctx)
LightRanger 10 clear interrupts function.
lightranger10_init
err_t lightranger10_init(lightranger10_t *ctx, lightranger10_cfg_t *cfg)
LightRanger 10 initialization function.