lightranger  2.0.0.0
lightranger.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 LIGHTRANGER_H
36 #define LIGHTRANGER_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define LIGHTRANGER_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
70  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
72 
78 #define LIGHTRANGER_RETVAL uint8_t
79 
80 #define LIGHTRANGER_OK 0x00
81 #define LIGHTRANGER_INIT_ERROR 0xFF
82 
88 #define LIGHTRANGER_IDENTIFICATION_MODEL_ID 0x0000
89 #define LIGHTRANGER_IDENTIFICATION_MODEL_REV_MAJOR 0x0001
90 #define LIGHTRANGER_IDENTIFICATION_MODEL_REV_MINOR 0x0002
91 #define LIGHTRANGER_IDENTIFICATION_MODULE_REV_MAJOR 0x0003
92 #define LIGHTRANGER_IDENTIFICATION_MODULE_REV_MINOR 0x0004
93 #define LIGHTRANGER_IDENTIFICATION_DATE_HI 0x0006
94 #define LIGHTRANGER_IDENTIFICATION_DATE_LO 0x0007
95 #define LIGHTRANGER_IDENTIFICATION_TIME_HI 0x0008
96 #define LIGHTRANGER_IDENTIFICATION_TIME_LO 0x0009
97 
103 #define LIGHTRANGER_SYSTEM_MODE_GPIO0 0x0010
104 #define LIGHTRANGER_SYSTEM_MODE_GPIO1 0x0011
105 #define LIGHTRANGER_SYSTEM_HISTORY_CTRL 0x0012
106 #define LIGHTRANGER_SYSTEM_INTERRUPT_CONFIG_GPIO 0x0014
107 #define LIGHTRANGER_SYSTEM_INTERRUPT_CLEAR 0x0015
108 #define LIGHTRANGER_SYSTEM_FRESH_OUT_OF_RESET 0x0016
109 #define LIGHTRANGER_SYSTEM_GROUPED_PARAMETER_HOLD 0x0017
110 
116 #define LIGHTRANGER_SYSRANGE_START 0x0018
117 #define LIGHTRANGER_SYSRANGE_THRESH_HIGH 0x0019
118 #define LIGHTRANGER_SYSRANGE_THRESH_LOW 0x001A
119 #define LIGHTRANGER_SYSRANGE_INTERMEASUREMENT_PERIOD 0x001B
120 #define LIGHTRANGER_SYSRANGE_MAX_CONVERGENCE_TIME 0x001C
121 #define LIGHTRANGER_SYSRANGE_CROSSTALK_COMPENSATION_RATE 0x001E
122 #define LIGHTRANGER_SYSRANGE_CROSSTALK_VALID_HEIGHT 0x0021
123 #define LIGHTRANGER_SYSRANGE_EARLY_CONVERGENCE_ESTIMATE 0x0022
124 #define LIGHTRANGER_SYSRANGE_PART_TO_PART_RANGE_OFFSET 0x0024
125 #define LIGHTRANGER_SYSRANGE_RANGE_IGNORE_VALID_HEIGHT 0x0025
126 #define LIGHTRANGER_SYSRANGE_RANGE_IGNORE_THRESHOLD 0x0026
127 #define LIGHTRANGER_SYSRANGE_MAX_AMBIENT_LEVEL_MULT 0x002C
128 #define LIGHTRANGER_SYSRANGE_RANGE_CHECK_ENABLES 0x002D
129 #define LIGHTRANGER_SYSRANGE_VHV_RECALIBRATE 0x002E
130 #define LIGHTRANGER_SYSRANGE_VHV_REPEAT_RATE 0x0031
131 #define LIGHTRANGER_SYSALS_START 0x0038
132 #define LIGHTRANGER_SYSALS_THRESH_HIGH 0x003A
133 #define LIGHTRANGER_SYSALS_THRESH_LOW 0x003C
134 #define LIGHTRANGER_SYSALS_INTERMEASUREMENT_PERIOD 0x003E
135 #define LIGHTRANGER_SYSALS_ANALOGUE_GAIN 0x003F
136 #define LIGHTRANGER_SYSALS_INTEGRATION_PERIOD 0x0040
137 
143 #define LIGHTRANGER_RESULT_RANGE_STATUS 0x004D
144 #define LIGHTRANGER_RESULT_ALS_STATUS 0x004E
145 #define LIGHTRANGER_RESULT_INTERRUPT_STATUS_GPIO 0x004F
146 #define LIGHTRANGER_RESULT_ALS_VAL 0x0050
147 #define LIGHTRANGER_RESULT_HISTORY_BUFFER0 0x0052
148 #define LIGHTRANGER_RESULT_HISTORY_BUFFER1 0x0053
149 #define LIGHTRANGER_RESULT_HISTORY_BUFFER2 0x0054
150 #define LIGHTRANGER_RESULT_HISTORY_BUFFER3 0x0055
151 #define LIGHTRANGER_RESULT_HISTORY_BUFFER4 0x0056
152 #define LIGHTRANGER_RESULT_HISTORY_BUFFER5 0x0057
153 #define LIGHTRANGER_RESULT_HISTORY_BUFFER6 0x0058
154 #define LIGHTRANGER_RESULT_HISTORY_BUFFER7 0x0059
155 #define LIGHTRANGER_RESULT_HISTORY_BUFFER8 0x0060
156 #define LIGHTRANGER_RESULT_RANGE_VAL 0x0062
157 #define LIGHTRANGER_RESULT_RANGE_RAW 0x0064
158 #define LIGHTRANGER_RESULT_RANGE_RETURN_RATE 0x0066
159 #define LIGHTRANGER_RESULT_RANGE_REFERENCE_RATE 0x0068
160 #define LIGHTRANGER_RESULT_RANGE_RETURN_SIGNAL_COUNT 0x006C
161 #define LIGHTRANGER_RESULT_RANGE_REFERENCE_SIGNAL_COUNT 0x0070
162 #define LIGHTRANGER_RESULT_RANGE_RETURN_AMB_COUNT 0x0074
163 #define LIGHTRANGER_RESULT_RANGE_REFERENCE_AMB_COUNT 0x0078
164 #define LIGHTRANGER_RESULT_RANGE_RETURN_CONV_TIME 0x007C
165 #define LIGHTRANGER_RESULT_RANGE_REFERENCE_CONV_TIME 0x0080
166 
171 #define LIGHTRANGER_READOUT_AVERAGING_SAMPLE_PERIOD 0x010A
172 #define LIGHTRANGER_FIRMWARE_BOOTUP 0x0119
173 #define LIGHTRANGER_FIRMWARE_RESULT_SCALER 0x0120
174 #define LIGHTRANGER_I2C_SLAVE_DEVICE_ADDRESS 0x0212
175 #define LIGHTRANGER_INTERLEAVED_MODE_ENABLE 0x02A3
176 
182 #define LIGHTRANGER_CMD_RESET 0x1E
183 #define LIGHTRANGER_CMD_ADC_READ 0x00
184 #define LIGHTRANGER_CMD_ADC_CONV 0x40
185 #define LIGHTRANGER_CMD_ADC_D1 0x00
186 #define LIGHTRANGER_CMD_ADC_D2 0x10
187 #define LIGHTRANGER_CMD_ADC_256 0x00
188 #define LIGHTRANGER_CMD_ADC_512 0x02
189 #define LIGHTRANGER_CMD_ADC_1024 0x04
190 #define LIGHTRANGER_CMD_ADC_2048 0x06
191 #define LIGHTRANGER_CMD_ADC_4096 0x08
192 #define LIGHTRANGER_CMD_PROM_RD 0xA0
193 #define LIGHTRANGER_CMD_CALC_DIST 0x32
194 #define LIGHTRANGER_CMD_INTERRUPT_CLEAR 0x07
195 #define LIGHTRANGER_CMD_GAIN_1X 0x06
196 
202 #define LIGHTRANGER_I2C_ADDRESS 0x29
203  // End group macro
206 // --------------------------------------------------------------- PUBLIC TYPES
215 typedef struct
216 {
217 
218  digital_out_t en;
219 
220  digital_in_t int_pin;
221 
222  // Modules
223 
224  i2c_master_t i2c;
225 
226  // ctx variable
227 
228  uint8_t slave_address;
229 
230 } lightranger_t;
231 
235 typedef struct
236 {
237  // Communication gpio pins
238 
239  pin_name_t scl;
240  pin_name_t sda;
241 
242  // Additional gpio pins
243 
244  pin_name_t en;
245 
246  pin_name_t int_pin;
247 
248  // static variable
249 
250  uint32_t i2c_speed;
251  uint8_t i2c_address;
252 
254  // End types group
256 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
257 
263 #ifdef __cplusplus
264 extern "C"{
265 #endif
266 
276 
286 
295 
304 
314 
325 
336 float lightranger_get_ambiant_light ( lightranger_t* ctx, uint8_t als_gain_check );
337 
347 
358 uint16_t lightranger_read_data ( lightranger_t* ctx, uint16_t reg_addr );
359 
370 void lightranger_write_data ( lightranger_t* ctx, uint16_t reg_addr, uint16_t write_command );
371 
382 uint8_t lightranger_read_byte ( lightranger_t* ctx, uint16_t reg_addr );
383 
393 void lightranger_write_byte ( lightranger_t* ctx, uint16_t reg_addr, uint8_t write_command );
394 
395 
396 
397 #ifdef __cplusplus
398 }
399 #endif
400 #endif // _LIGHTRANGER_H_
401  // End public_function group
404 
405 // ------------------------------------------------------------------------- END
lightranger_read_data
uint16_t lightranger_read_data(lightranger_t *ctx, uint16_t reg_addr)
Generic read data function.
lightranger_read_byte
uint8_t lightranger_read_byte(lightranger_t *ctx, uint16_t reg_addr)
Generic read byte function.
lightranger_t::slave_address
uint8_t slave_address
Definition: lightranger.h:228
lightranger_get_distance
uint8_t lightranger_get_distance(lightranger_t *ctx)
Get Distance.
lightranger_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: lightranger.h:250
lightranger_write_byte
void lightranger_write_byte(lightranger_t *ctx, uint16_t reg_addr, uint8_t write_command)
Generic write byte function.
lightranger_poll_range
void lightranger_poll_range(lightranger_t *ctx)
Poll range.
lightranger_cfg_t::int_pin
pin_name_t int_pin
Definition: lightranger.h:246
LIGHTRANGER_RETVAL
#define LIGHTRANGER_RETVAL
Definition: lightranger.h:78
lightranger_cfg_t
Click configuration structure definition.
Definition: lightranger.h:236
lightranger_get_ambiant_light
float lightranger_get_ambiant_light(lightranger_t *ctx, uint8_t als_gain_check)
Get ambiant light.
lightranger_cfg_t::scl
pin_name_t scl
Definition: lightranger.h:239
lightranger_interrupts_clear
void lightranger_interrupts_clear(lightranger_t *ctx)
Clear Interrupts.
lightranger_start_single_shot_range_mode
void lightranger_start_single_shot_range_mode(lightranger_t *ctx)
Function Start Single Mode.
lightranger_t::i2c
i2c_master_t i2c
Definition: lightranger.h:224
lightranger_t::int_pin
digital_in_t int_pin
Definition: lightranger.h:220
lightranger_cfg_setup
void lightranger_cfg_setup(lightranger_cfg_t *cfg)
Config Object Initialization function.
lightranger_t::en
digital_out_t en
Definition: lightranger.h:218
lightranger_write_data
void lightranger_write_data(lightranger_t *ctx, uint16_t reg_addr, uint16_t write_command)
Generic write data function.
lightranger_cfg_t::sda
pin_name_t sda
Definition: lightranger.h:240
lightranger_init
LIGHTRANGER_RETVAL lightranger_init(lightranger_t *ctx, lightranger_cfg_t *cfg)
Initialization function.
lightranger_t
Click ctx object definition.
Definition: lightranger.h:216
lightranger_cfg_t::i2c_address
uint8_t i2c_address
Definition: lightranger.h:251
lightranger_default_cfg
void lightranger_default_cfg(lightranger_t *ctx)
Click Default Configuration function.
lightranger_cfg_t::en
pin_name_t en
Definition: lightranger.h:244