proximity15  2.0.0.0
proximity15.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 PROXIMITY15_H
29 #define PROXIMITY15_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define PROXIMITY15_REG_SOFT_RESET 0x0000
74 #define PROXIMITY15_REG_PAD_I2C_HV_CFG 0x002D
75 #define PROXIMITY15_REG_CFG_TIMEOUT_MACROP 0x004B
76 #define PROXIMITY15_REG_CFG_TIMEOUT_MACROP_A_HI 0x005E
77 #define PROXIMITY15_REG_CFG_VCSEL_PERIOD_A 0x0060
78 #define PROXIMITY15_REG_CFG_TIMEOUT_MACROP_B_HI 0x0061
79 #define PROXIMITY15_REG_CFG_VCSEL_PERIOD_B 0x0063
80 #define PROXIMITY15_REG_CFG_VALID_PHASE_HIGH 0x0069
81 #define PROXIMITY15_REG_SYSTEM_INT_MEAS_PERIOD 0x006C
82 #define PROXIMITY15_REG_SD_CFG_WOI_SD0 0x0078
83 #define PROXIMITY15_REG_SD_CFG_INIT_PHASE_SD0 0x007A
84 #define PROXIMITY15_REG_SYSTEM_INTERRUPT_CLEAR 0x0086
85 #define PROXIMITY15_REG_SYSTEM_MODE_START 0x0087
86 #define PROXIMITY15_REG_RES_FINAL_RANGE_MM_SD0 0x0096
87 #define PROXIMITY15_REG_RES_OSC_CALIB_VAL 0x00DE
88 #define PROXIMITY15_REG_MODEL_ID 0x010F
89 #define PROXIMITY15_REG_MODULE_TYPE 0x0110
90  // proximity15_reg
92 
107 #define PROXIMITY15_MODEL_ID 0xEA
108 #define PROXIMITY15_MODULE_TYPE 0xCC
109 
114 #define PROXIMITY15_SOFT_RESET_ENTER 0x00
115 #define PROXIMITY15_SOFT_RESET_EXIT 0x01
116 #define PROXIMITY15_START_RANGING 0x40
117 #define PROXIMITY15_STOP_RANGING 0x00
118 #define PROXIMITY15_CLEAR_INTERRUPT 0x01
119 #define PROXIMITY15_MEASURE_PERIOD_CONST 1.075
120 #define PROXIMITY15_TIMEOUT_MACROP_SHORT 0x14
121 #define PROXIMITY15_TIMEOUT_MACROP_LONG 0x0A
122 #define PROXIMITY15_DISTANCE_MODE_SHORT 0x01
123 #define PROXIMITY15_DISTANCE_MODE_LONG 0x02
124 
130 #define PROXIMITY15_SET_DEV_ADDR 0x29
131  // proximity15_set
133 
148 #define PROXIMITY15_MAP_MIKROBUS( cfg, mikrobus ) \
149  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
150  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
151  cfg.xsh = MIKROBUS( mikrobus, MIKROBUS_CS ); \
152  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
153  // proximity15_map // proximity15
156 
161 typedef struct
162 {
163  // Output pins
164  digital_out_t xsh;
166  // Input pins
167  digital_in_t int_pin;
169  // Modules
170  i2c_master_t i2c;
172  // I2C slave address
173  uint8_t slave_address;
175 } proximity15_t;
176 
181 typedef struct
182 {
183  pin_name_t scl;
184  pin_name_t sda;
186  pin_name_t xsh;
187  pin_name_t int_pin;
189  uint32_t i2c_speed;
190  uint8_t i2c_address;
193 
198 typedef enum
199 {
201  PROXIMITY15_ERROR = -1
202 
204 
210 typedef enum
211 {
219 
221 
238 
254 
269 
285 err_t proximity15_write_registers ( proximity15_t *ctx, uint16_t reg, uint8_t *tx_buf, uint8_t tx_len );
286 
302 err_t proximity15_read_registers ( proximity15_t *ctx, uint16_t reg, uint8_t *rx_buf, uint8_t rx_len );
303 
317 err_t proximity15_write_register ( proximity15_t *ctx, uint16_t reg, uint8_t tx_data );
318 
332 err_t proximity15_read_register ( proximity15_t *ctx, uint16_t reg, uint8_t *rx_data );
333 
347 
360 
374 err_t proximity15_get_distance ( proximity15_t *ctx, uint16_t *distance );
375 
385 
395 
405 
419 
432 
445 
459 
474 err_t proximity15_set_distance_mode ( proximity15_t *ctx, uint8_t mode );
475 
489 err_t proximity15_get_distance_mode ( proximity15_t *ctx, uint8_t *mode );
490 
505 
520 
521 #ifdef __cplusplus
522 }
523 #endif
524 #endif // PROXIMITY15_H
525  // proximity15
527 
528 // ------------------------------------------------------------------------ END
proximity15_get_int_pin
uint8_t proximity15_get_int_pin(proximity15_t *ctx)
Proximity 15 get int pin function.
PROXIMITY15_TIMING_BUDGET_200MS
@ PROXIMITY15_TIMING_BUDGET_200MS
Definition: proximity15.h:217
PROXIMITY15_TIMING_BUDGET_20MS
@ PROXIMITY15_TIMING_BUDGET_20MS
Definition: proximity15.h:213
PROXIMITY15_OK
@ PROXIMITY15_OK
Definition: proximity15.h:200
proximity15_get_timing_budget
err_t proximity15_get_timing_budget(proximity15_t *ctx, proximity15_timing_budget_t *time)
Proximity 15 get timing budget function.
proximity15_set_inter_measurement_period
err_t proximity15_set_inter_measurement_period(proximity15_t *ctx, uint16_t time_ms)
Proximity 15 set inter measurement period function.
proximity15_init
err_t proximity15_init(proximity15_t *ctx, proximity15_cfg_t *cfg)
Proximity 15 initialization function.
proximity15_return_value_t
proximity15_return_value_t
Proximity 15 Click return value data.
Definition: proximity15.h:199
PROXIMITY15_TIMING_BUDGET_100MS
@ PROXIMITY15_TIMING_BUDGET_100MS
Definition: proximity15.h:216
proximity15_t::slave_address
uint8_t slave_address
Definition: proximity15.h:173
proximity15_timing_budget_t
proximity15_timing_budget_t
Proximity 15 Click timing budget values.
Definition: proximity15.h:211
proximity15_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: proximity15.h:189
proximity15_cfg_t::xsh
pin_name_t xsh
Definition: proximity15.h:186
proximity15_t::i2c
i2c_master_t i2c
Definition: proximity15.h:170
proximity15_cfg_t::scl
pin_name_t scl
Definition: proximity15.h:183
proximity15_software_reset
err_t proximity15_software_reset(proximity15_t *ctx)
Proximity 15 software reset function.
proximity15_cfg_t::int_pin
pin_name_t int_pin
Definition: proximity15.h:187
proximity15_cfg_t
Proximity 15 Click configuration object.
Definition: proximity15.h:182
proximity15_get_distance
err_t proximity15_get_distance(proximity15_t *ctx, uint16_t *distance)
Proximity 15 get distance function.
proximity15_cfg_setup
void proximity15_cfg_setup(proximity15_cfg_t *cfg)
Proximity 15 configuration object setup function.
proximity15_start_ranging
err_t proximity15_start_ranging(proximity15_t *ctx)
Proximity 15 start ranging function.
proximity15_write_registers
err_t proximity15_write_registers(proximity15_t *ctx, uint16_t reg, uint8_t *tx_buf, uint8_t tx_len)
Proximity 15 write registers function.
PROXIMITY15_TIMING_BUDGET_500MS
@ PROXIMITY15_TIMING_BUDGET_500MS
Definition: proximity15.h:218
proximity15_cfg_t::sda
pin_name_t sda
Definition: proximity15.h:184
proximity15_check_communication
err_t proximity15_check_communication(proximity15_t *ctx)
Proximity 15 check communication function.
proximity15_cfg_t::i2c_address
uint8_t i2c_address
Definition: proximity15.h:190
proximity15_set_timing_budget
err_t proximity15_set_timing_budget(proximity15_t *ctx, proximity15_timing_budget_t time)
Proximity 15 set timing budget function.
PROXIMITY15_TIMING_BUDGET_15MS
@ PROXIMITY15_TIMING_BUDGET_15MS
Definition: proximity15.h:212
proximity15_set_distance_mode
err_t proximity15_set_distance_mode(proximity15_t *ctx, uint8_t mode)
Proximity 15 set distance mode function.
proximity15_disable_sensor
void proximity15_disable_sensor(proximity15_t *ctx)
Proximity 15 disable sensor function.
proximity15_get_distance_mode
err_t proximity15_get_distance_mode(proximity15_t *ctx, uint8_t *mode)
Proximity 15 get distance mode function.
proximity15_t
Proximity 15 Click context object.
Definition: proximity15.h:162
proximity15_clear_interrupt
err_t proximity15_clear_interrupt(proximity15_t *ctx)
Proximity 15 clear interrupt function.
proximity15_enable_sensor
void proximity15_enable_sensor(proximity15_t *ctx)
Proximity 15 enable sensor function.
proximity15_t::xsh
digital_out_t xsh
Definition: proximity15.h:164
proximity15_read_registers
err_t proximity15_read_registers(proximity15_t *ctx, uint16_t reg, uint8_t *rx_buf, uint8_t rx_len)
Proximity 15 read registers function.
proximity15_default_cfg
err_t proximity15_default_cfg(proximity15_t *ctx)
Proximity 15 default configuration function.
proximity15_write_register
err_t proximity15_write_register(proximity15_t *ctx, uint16_t reg, uint8_t tx_data)
Proximity 15 write register function.
proximity15_read_register
err_t proximity15_read_register(proximity15_t *ctx, uint16_t reg, uint8_t *rx_data)
Proximity 15 read register function.
proximity15_t::int_pin
digital_in_t int_pin
Definition: proximity15.h:167
PROXIMITY15_TIMING_BUDGET_50MS
@ PROXIMITY15_TIMING_BUDGET_50MS
Definition: proximity15.h:215
proximity15_stop_ranging
err_t proximity15_stop_ranging(proximity15_t *ctx)
Proximity 15 stop ranging function.
PROXIMITY15_ERROR
@ PROXIMITY15_ERROR
Definition: proximity15.h:201
PROXIMITY15_TIMING_BUDGET_33MS
@ PROXIMITY15_TIMING_BUDGET_33MS
Definition: proximity15.h:214