lightranger3  2.0.0.0
lightranger3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef LIGHTRANGER3_H
36 #define LIGHTRANGER3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define LIGHTRANGER3_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
56 
62 #define LIGHTRANGER3_RETVAL uint8_t
63 
64 #define LIGHTRANGER3_OK 0x00
65 #define LIGHTRANGER3_INIT_ERROR 0xFF
66 
72 #define LIGHTRANGER3_REG_ICSR 0x00
73 #define LIGHTRANGER3_REG_IER 0x02
74 #define LIGHTRANGER3_REG_CMD 0x04
75 #define LIGHTRANGER3_REG_DEV_STATUS 0x06
76 #define LIGHTRANGER3_REG_RESULT 0x08
77 #define LIGHTRANGER3_REG_RESULT_CONFIG 0x0A
78 #define LIGHTRANGER3_REG_CMD_CONFIG_A 0x0C
79 #define LIGHTRANGER3_REG_CMD_CONFIG_B 0x0E
80 #define LIGHTRANGER3_REG_HOST_TO_MCPU_MBX 0x10
81 #define LIGHTRANGER3_REG_MCPU_TO_HOST_MBX 0x12
82 #define LIGHTRANGER3_REG_PMU_CONFIG 0x14
83 #define LIGHTRANGER3_REG_I2C_ADDR_PTR 0x18
84 #define LIGHTRANGER3_REG_I2C_DATA_PTR 0x1A
85 #define LIGHTRANGER3_REG_I2C_INIT_CFG 0x1C
86 #define LIGHTRANGER3_REG_MCPU_PM_CTRL 0x1E
87 #define LIGHTRANGER3_REG_HW_FW_CONFIG_0 0x20
88 #define LIGHTRANGER3_REG_HW_FW_CONFIG_1 0x22
89 #define LIGHTRANGER3_REG_HW_FW_CONFIG_2 0x24
90 #define LIGHTRANGER3_REG_HW_FW_CONFIG_3 0x26
91 #define LIGHTRANGER3_REG_DEVICE_ID 0x28
92 #define LIGHTRANGER3_REG_PTCH_MEMORY_CFG 0x2A
93 
99 #define LIGHTRANGER3_STANDBY_MODE 0x90
100 #define LIGHTRANGER3_OFF_MODE 0x91
101 #define LIGHTRANGER3_ON_MODE 0x92
102 #define LIGHTRANGER3_MEASUREMENT_MODE 0x81
103 
109 #define LIGHTRANGER3_ERROR 0x01
110 #define DISTANCE_IS_GOOD 0x7FFF
111  // End group macro
114 // --------------------------------------------------------------- PUBLIC TYPES
123 typedef struct
124 {
125  // Input pins
126 
127  digital_in_t int_pin;
128 
129  // Modules
130 
131  i2c_master_t i2c;
132 
133  // ctx variable
134 
135  uint8_t slave_address;
136 
138  uint16_t distance;
139 
141 
145 typedef struct
146 {
147  // Communication gpio pins
148 
149  pin_name_t scl;
150  pin_name_t sda;
151 
152  // Additional gpio pins
153 
154  pin_name_t int_pin;
155 
156  // static variable
157 
158  uint32_t i2c_speed;
159  uint8_t i2c_address;
160 
162  uint16_t dev_distance;
163 
165  // End types group
167 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
168 
174 #ifdef __cplusplus
175 extern "C"{
176 #endif
177 
187 
196 
207 void lightranger3_generic_write ( lightranger3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
208 
219 void lightranger3_generic_read ( lightranger3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
220 
230 void lightranger3_write_byte ( lightranger3_t *ctx, uint8_t reg, uint8_t w_data );
231 
241 void lightranger3_write_data ( lightranger3_t *ctx, uint8_t reg, uint16_t w_data );
242 
251 uint8_t lightranger3_read_byte ( lightranger3_t *ctx, uint8_t reg );
252 
261 uint16_t lightranger3_read_data ( lightranger3_t *ctx, uint8_t reg );
262 
271 
280 
289 
298 
307 
315 uint16_t lightranger3_get_distance ( lightranger3_t *ctx );
316 
325 
334 
343 
352 
362 
363 #ifdef __cplusplus
364 }
365 #endif
366 #endif // _LIGHTRANGER3_H_
367  // End public_function group
370 
371 // ------------------------------------------------------------------------- END
uint8_t slave_address
Definition: lightranger3.h:135
uint8_t lightranger3_set_on_mode(lightranger3_t *ctx)
Functions for go to ON mode.
void lightranger3_write_byte(lightranger3_t *ctx, uint8_t reg, uint8_t w_data)
Functions for write one byte in register.
void lightranger3_soft_reset(lightranger3_t *ctx)
Functions for soft reset.
uint16_t confidence_value
Definition: lightranger3.h:137
uint16_t lightranger3_get_distance(lightranger3_t *ctx)
Functions for reads distance.
uint8_t i2c_address
Definition: lightranger3.h:159
digital_in_t int_pin
Definition: lightranger3.h:127
Click configuration structure definition.
Definition: lightranger3.h:145
void lightranger3_generic_write(lightranger3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
uint16_t distance
Definition: lightranger3.h:138
i2c_master_t i2c
Definition: lightranger3.h:131
uint32_t i2c_speed
Definition: lightranger3.h:158
uint16_t lightranger3_read_data(lightranger3_t *ctx, uint8_t reg)
Functions for read data from register.
uint16_t lightranger3_get_device_id(lightranger3_t *ctx)
Functions for reads device ID.
uint16_t lightranger3_get_confidence_value(lightranger3_t *ctx)
Functions for reads confidence value.
pin_name_t sda
Definition: lightranger3.h:150
pin_name_t scl
Definition: lightranger3.h:149
uint8_t lightranger3_read_byte(lightranger3_t *ctx, uint8_t reg)
Functions for read one byte from register.
uint8_t lightranger3_take_single_measurement(lightranger3_t *ctx)
Functions for measurement.
LIGHTRANGER3_RETVAL lightranger3_init(lightranger3_t *ctx, lightranger3_cfg_t *cfg)
Initialization function.
uint8_t lightranger3_set_off_mode(lightranger3_t *ctx)
Functions for go to OFF mode.
#define LIGHTRANGER3_RETVAL
Definition: lightranger3.h:62
Click ctx object definition.
Definition: lightranger3.h:123
pin_name_t int_pin
Definition: lightranger3.h:154
uint8_t lightranger3_get_interrupt(lightranger3_t *ctx)
Functions for reads interrupt pin.
uint8_t lightranger3_set_measurement_mode(lightranger3_t *ctx)
Functions for go to measurement mode.
uint16_t dev_confidence_value
Definition: lightranger3.h:161
uint16_t dev_distance
Definition: lightranger3.h:162
uint8_t lightranger3_device_init(lightranger3_t *ctx)
Functions for initializes chip.
void lightranger3_write_data(lightranger3_t *ctx, uint8_t reg, uint16_t w_data)
Functions for write data in register.
void lightranger3_generic_read(lightranger3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void lightranger3_cfg_setup(lightranger3_cfg_t *cfg)
Config Object Initialization function.
uint8_t lightranger3_set_standby_mode(lightranger3_t *ctx)
Functions for go to standby mode.