proximity  2.0.0.0
proximity.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 PROXIMITY_H
36 #define PROXIMITY_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 PROXIMITY_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 PROXIMITY_RETVAL uint8_t
63 
64 #define PROXIMITY_OK 0x00
65 #define PROXIMITY_INIT_ERROR 0xFF
66 
72 #define PROXIMITY_SLAVE_ADDR 0x13
73 #define PROXIMITY_REGISTER_COMMAND 0x80
74 #define PROXIMITY_REGISTER_ID 0x81
75 #define PROXIMITY_REGISTER_PROX_RATE 0x82
76 #define PROXIMITY_REGISTER_PROX_CURRENT 0x83
77 #define PROXIMITY_REGISTER_AMBI_PARAMETER 0x84
78 #define PROXIMITY_REGISTER_AMBI_VALUE 0x85
79 #define PROXIMITY_REGISTER_PROX_VALUE 0x87
80 #define PROXIMITY_REGISTER_INTERRUPT_CONTROL 0x89
81 #define PROXIMITY_REGISTER_INTERRUPT_LOW_THRES 0x8a
82 #define PROXIMITY_REGISTER_INTERRUPT_HIGH_THRES 0x8c
83 #define PROXIMITY_REGISTER_INTERRUPT_STATUS 0x8e
84 #define PROXIMITY_REGISTER_PROX_TIMING 0xf9
85 #define PROXIMITY_REGISTER_AMBI_IR_LIGHT_LEVEL 0x90
86 
92 #define PROXIMITY_COMMAND_ALL_DISABLE 0x00
93 #define PROXIMITY_COMMAND_SELFTIMED_MODE_ENABLE 0x01
94 #define PROXIMITY_COMMAND_PROX_ENABLE 0x02
95 #define PROXIMITY_COMMAND_AMBI_ENABLE 0x04
96 #define PROXIMITY_COMMAND_PROX_ON_DEMAND 0x08
97 #define PROXIMITY_COMMAND_AMBI_ON_DEMAND 0x10
98 #define PROXIMITY_COMMAND_MASK_PROX_DATA_READY 0x20
99 #define PROXIMITY_COMMAND_MASK_AMBI_DATA_READY 0x40
100 #define PROXIMITY_COMMAND_MASK_LOCK 0x80
101 
107 #define PROXIMITY_PRODUCT_MASK_REVISION_ID 0x0f
108 #define PROXIMITY_PRODUCT_MASK_PRODUCT_ID 0xf0
109 
115 #define PROXIMITY_MEASUREMENT_RATE_2 0x00
116 #define PROXIMITY_MEASUREMENT_RATE_4 0x01
117 #define PROXIMITY_MEASUREMENT_RATE_8 0x02
118 #define PROXIMITY_MEASUREMENT_RATE_16 0x03
119 #define PROXIMITY_MEASUREMENT_RATE_31 0x04
120 #define PROXIMITY_MEASUREMENT_RATE_62 0x05
121 #define PROXIMITY_MEASUREMENT_RATE_125 0x06
122 #define PROXIMITY_MEASUREMENT_RATE_250 0x07
123 #define PROXIMITY_MASK_MEASUREMENT_RATE 0x07
124 
130 #define PROXIMITY_MASK_LED_CURRENT 0x3f
131 #define PROXIMITY_MASK_FUSE_PROG_ID 0xc0
132 
138 #define PROXIMITY_AMBI_PARA_AVERAGE_1 0x00
139 #define PROXIMITY_AMBI_PARA_AVERAGE_2 0x01
140 #define PROXIMITY_AMBI_PARA_AVERAGE_4 0x02
141 #define PROXIMITY_AMBI_PARA_AVERAGE_8 0x03
142 #define PROXIMITY_AMBI_PARA_AVERAGE_16 0x04
143 #define PROXIMITY_AMBI_PARA_AVERAGE_32 0x05
144 #define PROXIMITY_AMBI_PARA_AVERAGE_64 0x06
145 #define PROXIMITY_AMBI_PARA_AVERAGE_128 0x07
146 #define PROXIMITY_AMBI_MASK_PARA_AVERAGE 0x07
147 #define PROXIMITY_AMBI_PARA_AUTO_OFFSET_ENABLE 0x08
148 #define PROXIMITY_AMBI_MASK_PARA_AUTO_OFFSET 0x08
149 #define PROXIMITY_AMBI_PARA_MEAS_RATE_1 0x00
150 #define PROXIMITY_AMBI_PARA_MEAS_RATE_2 0x10
151 #define PROXIMITY_AMBI_PARA_MEAS_RATE_3 0x20
152 #define PROXIMITY_AMBI_PARA_MEAS_RATE_4 0x30
153 #define PROXIMITY_AMBI_PARA_MEAS_RATE_5 0x40
154 #define PROXIMITY_AMBI_PARA_MEAS_RATE_6 0x50
155 #define PROXIMITY_AMBI_PARA_MEAS_RATE_8 0x60
156 #define PROXIMITY_AMBI_PARA_MEAS_RATE_10 0x70
157 #define PROXIMITY_AMBI_MASK_PARA_MEAS_RATE 0x70
158 #define PROXIMITY_AMBI_PARA_CONT_CONV_ENABLE 0x80
159 #define PROXIMITY_AMBI_MASK_PARA_CONT_CONV 0x80
160 
166 #define PROXIMITY_INTERRUPT_THRES_SEL_PROX 0x00
167 #define PROXIMITY_INTERRUPT_THRES_SEL_ALS 0x01
168 #define PROXIMITY_INTERRUPT_THRES_ENABLE 0x02
169 #define PROXIMITY_INTERRUPT_ALS_READY_ENABLE 0x04
170 #define PROXIMITY_INTERRUPT_PROX_READY_ENABLE 0x08
171 #define PROXIMITY_INTERRUPT_COUNT_EXCEED_1 0x00
172 #define PROXIMITY_INTERRUPT_COUNT_EXCEED_2 0x20
173 #define PROXIMITY_INTERRUPT_COUNT_EXCEED_4 0x40
174 #define PROXIMITY_INTERRUPT_COUNT_EXCEED_8 0x60
175 #define PROXIMITY_INTERRUPT_COUNT_EXCEED_16 0x80
176 #define PROXIMITY_INTERRUPT_COUNT_EXCEED_32 0xa0
177 #define PROXIMITY_INTERRUPT_COUNT_EXCEED_64 0xc0
178 #define PROXIMITY_INTERRUPT_COUNT_EXCEED_128 0xe0
179 #define PROXIMITY_INTERRUPT_MASK_COUNT_EXCEED 0xe0
180 #define PROXIMITY_INTERRUPT_STATUS_THRES_HI 0x01
181 #define PROXIMITY_INTERRUPT_STATUS_THRES_LO 0x02
182 #define PROXIMITY_INTERRUPT_STATUS_ALS_READY 0x04
183 #define PROXIMITY_INTERRUPT_STATUS_PROX_READY 0x08
184 #define PROXIMITY_INTERRUPT_MASK_STATUS_THRES_HI 0x01
185 #define PROXIMITY_INTERRUPT_MASK_THRES_LO 0x02
186 #define PROXIMITY_INTERRUPT_MASK_ALS_READY 0x04
187 #define PROXIMITY_INTERRUPT_MASK_PROX_READY 0x08
188  // End group macro
190 // --------------------------------------------------------------- PUBLIC TYPES
199 typedef struct
200 {
201 
202  // Input pins
203 
204  digital_in_t int_pin;
205 
206  // Modules
207 
208  i2c_master_t i2c;
209 
210  // ctx variable
211 
212  uint8_t slave_address;
213 
214 } proximity_t;
215 
219 typedef struct
220 {
221  // Communication gpio pins
222 
223  pin_name_t scl;
224  pin_name_t sda;
225 
226  // Additional gpio pins
227 
228  pin_name_t int_pin;
229 
230  // static variable
231 
232  uint32_t i2c_speed;
233  uint8_t i2c_address;
234 
236  // End types group
238 
244 #ifdef __cplusplus
245 extern "C"{
246 #endif
247 
257 
267 
275 void proximity_write_byte ( proximity_t *ctx, uint8_t w_addr, uint8_t w_data);
276 
285 uint8_t proximity_read_byte ( proximity_t *ctx, uint8_t r_addr);
286 
295 void proximity_read_data ( proximity_t *ctx, uint8_t r_addr, uint8_t* rcv_data, uint8_t n_len);
296 
305 void proximity_write_data ( proximity_t *ctx, uint8_t w_addr, uint8_t* wr_data, uint8_t n_len);
306 
312 
318 
326 
334 
335 
336 #ifdef __cplusplus
337 }
338 #endif
339 #endif // _PROXIMITY_H_
340  // End public_function group
343 
344 // ------------------------------------------------------------------------- END
proximity_t::slave_address
uint8_t slave_address
Definition: proximity.h:212
proximity_init
PROXIMITY_RETVAL proximity_init(proximity_t *ctx, proximity_cfg_t *cfg)
Initialization function.
proximity_write_data
void proximity_write_data(proximity_t *ctx, uint8_t w_addr, uint8_t *wr_data, uint8_t n_len)
Functions for write data.
proximity_set_upper_threshold
void proximity_set_upper_threshold(proximity_t *ctx)
Functions for sets upper threshold.
proximity_cfg_t::scl
pin_name_t scl
Definition: proximity.h:223
proximity_cfg_setup
void proximity_cfg_setup(proximity_cfg_t *cfg)
Config Object Initialization function.
proximity_t::int_pin
digital_in_t int_pin
Definition: proximity.h:204
proximity_t::i2c
i2c_master_t i2c
Definition: proximity.h:208
proximity_cfg_t::i2c_address
uint8_t i2c_address
Definition: proximity.h:233
proximity_read_prox_data
uint16_t proximity_read_prox_data(proximity_t *ctx)
Functions for reads Proximity data.
proximity_cfg_t
Click configuration structure definition.
Definition: proximity.h:220
proximity_read_ambient_light
uint16_t proximity_read_ambient_light(proximity_t *ctx)
Functions for reads Ambient light.
proximity_read_byte
uint8_t proximity_read_byte(proximity_t *ctx, uint8_t r_addr)
Functions for read byte from register.
proximity_read_data
void proximity_read_data(proximity_t *ctx, uint8_t r_addr, uint8_t *rcv_data, uint8_t n_len)
Functions for read data from register.
proximity_cfg_t::sda
pin_name_t sda
Definition: proximity.h:224
proximity_t
Click ctx object definition.
Definition: proximity.h:200
proximity_set_default_mode
void proximity_set_default_mode(proximity_t *ctx)
Functions for sets default mode.
proximity_cfg_t::int_pin
pin_name_t int_pin
Definition: proximity.h:228
proximity_write_byte
void proximity_write_byte(proximity_t *ctx, uint8_t w_addr, uint8_t w_data)
Functions for write one byte in register.
proximity_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: proximity.h:232
PROXIMITY_RETVAL
#define PROXIMITY_RETVAL
Definition: proximity.h:62