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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define LIGHTRANGER3_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
66 
72 #define LIGHTRANGER3_RETVAL uint8_t
73 
74 #define LIGHTRANGER3_OK 0x00
75 #define LIGHTRANGER3_INIT_ERROR 0xFF
76 
82 #define LIGHTRANGER3_REG_ICSR 0x00
83 #define LIGHTRANGER3_REG_IER 0x02
84 #define LIGHTRANGER3_REG_CMD 0x04
85 #define LIGHTRANGER3_REG_DEV_STATUS 0x06
86 #define LIGHTRANGER3_REG_RESULT 0x08
87 #define LIGHTRANGER3_REG_RESULT_CONFIG 0x0A
88 #define LIGHTRANGER3_REG_CMD_CONFIG_A 0x0C
89 #define LIGHTRANGER3_REG_CMD_CONFIG_B 0x0E
90 #define LIGHTRANGER3_REG_HOST_TO_MCPU_MBX 0x10
91 #define LIGHTRANGER3_REG_MCPU_TO_HOST_MBX 0x12
92 #define LIGHTRANGER3_REG_PMU_CONFIG 0x14
93 #define LIGHTRANGER3_REG_I2C_ADDR_PTR 0x18
94 #define LIGHTRANGER3_REG_I2C_DATA_PTR 0x1A
95 #define LIGHTRANGER3_REG_I2C_INIT_CFG 0x1C
96 #define LIGHTRANGER3_REG_MCPU_PM_CTRL 0x1E
97 #define LIGHTRANGER3_REG_HW_FW_CONFIG_0 0x20
98 #define LIGHTRANGER3_REG_HW_FW_CONFIG_1 0x22
99 #define LIGHTRANGER3_REG_HW_FW_CONFIG_2 0x24
100 #define LIGHTRANGER3_REG_HW_FW_CONFIG_3 0x26
101 #define LIGHTRANGER3_REG_DEVICE_ID 0x28
102 #define LIGHTRANGER3_REG_PTCH_MEMORY_CFG 0x2A
103 
109 #define LIGHTRANGER3_STANDBY_MODE 0x90
110 #define LIGHTRANGER3_OFF_MODE 0x91
111 #define LIGHTRANGER3_ON_MODE 0x92
112 #define LIGHTRANGER3_MEASUREMENT_MODE 0x81
113 
119 #define LIGHTRANGER3_ERROR 0x01
120 #define DISTANCE_IS_GOOD 0x7FFF
121  // End group macro
124 // --------------------------------------------------------------- PUBLIC TYPES
133 typedef struct
134 {
135  // Input pins
136 
137  digital_in_t int_pin;
138 
139  // Modules
140 
141  i2c_master_t i2c;
142 
143  // ctx variable
144 
145  uint8_t slave_address;
146 
148  uint16_t distance;
149 
151 
155 typedef struct
156 {
157  // Communication gpio pins
158 
159  pin_name_t scl;
160  pin_name_t sda;
161 
162  // Additional gpio pins
163 
164  pin_name_t int_pin;
165 
166  // static variable
167 
168  uint32_t i2c_speed;
169  uint8_t i2c_address;
170 
172  uint16_t dev_distance;
173 
175  // End types group
177 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
178 
184 #ifdef __cplusplus
185 extern "C"{
186 #endif
187 
197 
206 
217 void lightranger3_generic_write ( lightranger3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
218 
229 void lightranger3_generic_read ( lightranger3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
230 
240 void lightranger3_write_byte ( lightranger3_t *ctx, uint8_t reg, uint8_t w_data );
241 
251 void lightranger3_write_data ( lightranger3_t *ctx, uint8_t reg, uint16_t w_data );
252 
261 uint8_t lightranger3_read_byte ( lightranger3_t *ctx, uint8_t reg );
262 
271 uint16_t lightranger3_read_data ( lightranger3_t *ctx, uint8_t reg );
272 
281 
290 
299 
308 
317 
326 
335 
344 
353 
362 
372 
373 #ifdef __cplusplus
374 }
375 #endif
376 #endif // _LIGHTRANGER3_H_
377  // End public_function group
380 
381 // ------------------------------------------------------------------------- END
lightranger3_cfg_t::dev_distance
uint16_t dev_distance
Definition: lightranger3.h:172
lightranger3_t::confidence_value
uint16_t confidence_value
Definition: lightranger3.h:147
lightranger3_write_byte
void lightranger3_write_byte(lightranger3_t *ctx, uint8_t reg, uint8_t w_data)
Functions for write one byte in register.
lightranger3_cfg_t::dev_confidence_value
uint16_t dev_confidence_value
Definition: lightranger3.h:171
lightranger3_t::slave_address
uint8_t slave_address
Definition: lightranger3.h:145
lightranger3_device_init
uint8_t lightranger3_device_init(lightranger3_t *ctx)
Functions for initializes chip.
lightranger3_cfg_t::sda
pin_name_t sda
Definition: lightranger3.h:160
lightranger3_set_on_mode
uint8_t lightranger3_set_on_mode(lightranger3_t *ctx)
Functions for go to ON mode.
lightranger3_t::int_pin
digital_in_t int_pin
Definition: lightranger3.h:137
lightranger3_cfg_t::int_pin
pin_name_t int_pin
Definition: lightranger3.h:164
lightranger3_cfg_t
Click configuration structure definition.
Definition: lightranger3.h:156
lightranger3_soft_reset
void lightranger3_soft_reset(lightranger3_t *ctx)
Functions for soft reset.
lightranger3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: lightranger3.h:168
lightranger3_cfg_t::i2c_address
uint8_t i2c_address
Definition: lightranger3.h:169
lightranger3_get_confidence_value
uint16_t lightranger3_get_confidence_value(lightranger3_t *ctx)
Functions for reads confidence value.
lightranger3_generic_write
void lightranger3_generic_write(lightranger3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
lightranger3_read_byte
uint8_t lightranger3_read_byte(lightranger3_t *ctx, uint8_t reg)
Functions for read one byte from register.
lightranger3_t::distance
uint16_t distance
Definition: lightranger3.h:148
lightranger3_set_measurement_mode
uint8_t lightranger3_set_measurement_mode(lightranger3_t *ctx)
Functions for go to measurement mode.
lightranger3_cfg_setup
void lightranger3_cfg_setup(lightranger3_cfg_t *cfg)
Config Object Initialization function.
lightranger3_t::i2c
i2c_master_t i2c
Definition: lightranger3.h:141
lightranger3_read_data
uint16_t lightranger3_read_data(lightranger3_t *ctx, uint8_t reg)
Functions for read data from register.
lightranger3_set_standby_mode
uint8_t lightranger3_set_standby_mode(lightranger3_t *ctx)
Functions for go to standby mode.
lightranger3_get_interrupt
uint8_t lightranger3_get_interrupt(lightranger3_t *ctx)
Functions for reads interrupt pin.
lightranger3_generic_read
void lightranger3_generic_read(lightranger3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
LIGHTRANGER3_RETVAL
#define LIGHTRANGER3_RETVAL
Definition: lightranger3.h:72
lightranger3_set_off_mode
uint8_t lightranger3_set_off_mode(lightranger3_t *ctx)
Functions for go to OFF mode.
lightranger3_get_distance
uint16_t lightranger3_get_distance(lightranger3_t *ctx)
Functions for reads distance.
lightranger3_get_device_id
uint16_t lightranger3_get_device_id(lightranger3_t *ctx)
Functions for reads device ID.
lightranger3_init
LIGHTRANGER3_RETVAL lightranger3_init(lightranger3_t *ctx, lightranger3_cfg_t *cfg)
Initialization function.
lightranger3_cfg_t::scl
pin_name_t scl
Definition: lightranger3.h:159
lightranger3_t
Click ctx object definition.
Definition: lightranger3.h:134
lightranger3_take_single_measurement
uint8_t lightranger3_take_single_measurement(lightranger3_t *ctx)
Functions for measurement.
lightranger3_write_data
void lightranger3_write_data(lightranger3_t *ctx, uint8_t reg, uint16_t w_data)
Functions for write data in register.