proximity10  2.0.0.0
proximity10.h
Go to the documentation of this file.
1 
2 /*
3  * MikroSDK - MikroE Software Development Kit
4  * Copyright© 2020 MikroElektronika d.o.o.
5  *
6  * Permission is hereby granted, free of charge, to any person
7  * obtaining a copy of this software and associated documentation
8  * files (the "Software"), to deal in the Software without restriction,
9  * including without limitation the rights to use, copy, modify, merge,
10  * publish, distribute, sublicense, and/or sell copies of the Software,
11  * and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be
15  * included in all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
21  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
23  * OR OTHER DEALINGS IN THE SOFTWARE.
24  */
25 
34 // ----------------------------------------------------------------------------
35 
36 #ifndef PROXIMITY10_H
37 #define PROXIMITY10_H
38 
43 #ifdef PREINIT_SUPPORTED
44 #include "preinit.h"
45 #endif
46 
47 #ifdef MikroCCoreVersion
48  #if MikroCCoreVersion >= 1
49  #include "delays.h"
50  #endif
51 #endif
52 
53 #include "drv_digital_out.h"
54 #include "drv_digital_in.h"
55 #include "drv_i2c_master.h"
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define PROXIMITY10_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
70  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define PROXIMITY10_RETVAL uint8_t
78 
79 #define PROXIMITY10_OK 0x00
80 #define PROXIMITY10_INIT_ERROR 0xFF
81 
87 #define PROXIMITY10_DEFAULT_DEV_ADDR 0x5A
88 
94 #define PROXIMITY10_PART_ID_REG 0x00
95 #define PROXIMITY10_REV_ID_REG 0x01
96 #define PROXIMITY10_SEQ_ID_REG 0x02
97 #define PROXIMITY10_INT_CFG_REG 0x03
98 #define PROXIMITY10_IRQ_EN_REG 0x04
99 #define PROXIMITY10_IRQ_MODE1_REG 0x05
100 #define PROXIMITY10_IRQ_MODE2_REG 0x06
101 #define PROXIMITY10_HW_KEY_REG 0x07
102 #define PROXIMITY10_MEAS_RATE_REG 0x08
103 #define PROXIMITY10_ALS_RATE_REG 0x09
104 #define PROXIMITY10_PS_RATE_REG 0x0A
105 #define PROXIMITY10_ALS_LOW_TH_REG 0x0B
106 #define PROXIMITY10_ALS_HIGH_TH_REG 0x0D
107 #define PROXIMITY10_PS_LED21_REG 0x0F
108 #define PROXIMITY10_PS_LED3_REG 0x10
109 #define PROXIMITY10_PS1_TH_REG 0x11
110 #define PROXIMITY10_PS2_TH_REG 0x13
111 #define PROXIMITY10_PS3_TH_REG 0x15
112 #define PROXIMITY10_PARAM_WR_REG 0x17
113 #define PROXIMITY10_COMMAND_REG 0x18
114 #define PROXIMITY10_RESPONSE_REG 0x20
115 #define PROXIMITY10_IRQ_STATUS_REG 0x21
116 #define PROXIMITY10_ALS_VIS_DATA_REG 0x22
117 #define PROXIMITY10_ALS_IR_DATA_REG 0x24
118 #define PROXIMITY10_PS1_DATA_REG 0x26
119 #define PROXIMITY10_PS2_DATA_REG 0x28
120 #define PROXIMITY10_PS3_DATA_REG 0x2A
121 #define PROXIMITY10_AUX_DATA_REG 0x2C
122 #define PROXIMITY10_PARAM_RD_REG 0x2E
123 #define PROXIMITY10_CHIP_STATUS_REG 0x30
124 #define PROXIMITY10_ANA_IN_KEY_REG 0x3B
125 
131 #define PROXIMITY10_INT_HOST_CLEAR 0x00
132 #define PROXIMITY10_INT_AUTO_CLEAR 0x02
133 #define PROXIMITY10_INT_PIN_EN 0x01
134 
135 #define PROXIMITY10_CMD_INT_EN 0x20
136 #define PROXIMITY10_PS3_INT_EN 0x10
137 #define PROXIMITY10_PS2_INT_EN 0x08
138 #define PROXIMITY10_PS1_INT_EN 0x04
139 #define PROXIMITY10_ALS_INT1_EN 0x02
140 #define PROXIMITY10_ALS_INT0_EN 0x01
141 #define PROXIMITY10_ALL_INT_DIS 0x00
142 
143 #define PROXIMITY10_PS2_INT_MEAS_COMPLETE 0x00
144 #define PROXIMITY10_PS2_INT_MEAS_CROSS_TH 0x40
145 #define PROXIMITY10_PS2_INT_MEAS_GREATER_TH 0xC0
146 #define PROXIMITY10_PS1_INT_MEAS_COMPLETE 0x00
147 #define PROXIMITY10_PS1_INT_MEAS_CROSS_TH 0x10
148 #define PROXIMITY10_PS1_INT_MEAS_GREATER_TH 0x30
149 #define PROXIMITY10_CMD_INT_RESP_WRITTEN 0x00
150 #define PROXIMITY10_CMD_INT_RESP_ERROR 0x04
151 #define PROXIMITY10_PS3_INT_MEAS_COMPLETE 0x00
152 #define PROXIMITY10_PS3_INT_MEAS_CROSS_TH 0x01
153 #define PROXIMITY10_PS3_INT_MEAS_GREATER_TH 0x03
154 
155 #define PROXIMITY10_HW_KEY 0x17
156 
157 #define PROXIMITY10_DEV_WAKEUP_EVERY_10MS 0x84
158 #define PROXIMITY10_DEV_WAKEUP_EVERY_20MS 0x94
159 #define PROXIMITY10_DEV_WAKEUP_EVERY_100MS 0xB9
160 #define PROXIMITY10_DEV_WAKEUP_EVERY_496MS 0xDF
161 #define PROXIMITY10_DEV_WAKEUP_EVERY_1984MS 0xFF
162 
163 #define PROXIMITY10_AUTONOM_MEAS_DIS 0x00
164 #define PROXIMITY10_MEAS_AFTER_EVERY_WAKEUP 0x08
165 #define PROXIMITY10_MEAS_AFTER_10_TIMES_WAKEUP 0x32
166 #define PROXIMITY10_MEAS_AFTER_100_TIMES_WAKEUP 0x69
167 
168 #define PROXIMITY10_LED_NO_CURRENT 0x00
169 #define PROXIMITY10_LED_MIN_CURRENT 0x01
170 #define PROXIMITY10_LED_MAX_CURRENT 0x0F
171 
177 #define PROXIMITY10_INVALID_CMD_ENCOUNT 0x80
178 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_PS1 0x88
179 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_PS2 0x89
180 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_PS3 0x8A
181 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_ALS_VIS 0x8C
182 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_ALS_IR 0x8D
183 #define PROXIMITY10_ADC_OVRFLOW_ENCOUNT_AUX 0x8E
184 
190 #define PROXIMITY10_CMD_INT_FLAG 0x20
191 #define PROXIMITY10_PS3_INT_FLAG 0x10
192 #define PROXIMITY10_PS2_INT_FLAG 0x08
193 #define PROXIMITY10_PS1_INT_FLAG 0x04
194 #define PROXIMITY10_ALS_INT_FLAG 0x03
195 #define PROXIMITY10_INT_CLEARED 0x00
196 
197 #define PROXIMITY10_RUNNING_FLAG 0x04
198 #define PROXIMITY10_SUSPEND_FLAG 0x02
199 #define PROXIMITY10_SLEEP_FLAG 0x01
200 
206 #define PROXIMITY10_I2C_ADDR_PARAM 0x00
207 #define PROXIMITY10_CHLIST_PARAM 0x01
208 #define PROXIMITY10_PSLED12_SEL_PARAM 0x02
209 #define PROXIMITY10_PSLED3_SEL_PARAM 0x03
210 #define PROXIMITY10_PS_ENCODING_PARAM 0x05
211 #define PROXIMITY10_ALS_ENCODING_PARAM 0x06
212 #define PROXIMITY10_PS1_ADCMUX_PARAM 0x07
213 #define PROXIMITY10_PS2_ADCMUX_PARAM 0x08
214 #define PROXIMITY10_PS3_ADCMUX_PARAM 0x09
215 #define PROXIMITY10_PS_ADC_COUNT_PARAM 0x0A
216 #define PROXIMITY10_PS_ADC_GAIN_PARAM 0x0B
217 #define PROXIMITY10_PS_ADC_MISC_PARAM 0x0C
218 #define PROXIMITY10_ALS_IR_ADCMUX_PARAM 0x0E
219 #define PROXIMITY10_AUX_ADCMUX_PARAM 0x0F
220 #define PROXIMITY10_ALS_VIS_ADC_COUNT_PARAM 0x10
221 #define PROXIMITY10_ALS_VIS_ADC_GAIN_PARAM 0x11
222 #define PROXIMITY10_ALS_VIS_ADC_MISC_PARAM 0x12
223 #define PROXIMITY10_ALS_HYST_PARAM 0x16
224 #define PROXIMITY10_PS_HYST_PARAM 0x17
225 #define PROXIMITY10_PS_HISTORY_PARAM 0x18
226 #define PROXIMITY10_ALS_HISTORY_PARAM 0x19
227 #define PROXIMITY10_ADC_OFFSET_PARAM 0x1A
228 #define PROXIMITY10_LED_REC_PARAM 0x1C
229 #define PROXIMITY10_ALS_IR_ADC_COUNT_PARAM 0x1D
230 #define PROXIMITY10_ALS_IR_ADC_GAIN_PARAM 0x1E
231 #define PROXIMITY10_ALS_IR_ADC_MISC_PARAM 0x1F
232 
238 #define PROXIMITY10_EN_AUX 0x40
239 #define PROXIMITY10_EN_ALS_IR 0x20
240 #define PROXIMITY10_EN_ALS_VIS 0x10
241 #define PROXIMITY10_EN_PS3 0x04
242 #define PROXIMITY10_EN_PS2 0x02
243 #define PROXIMITY10_EN_PS1 0x01
244 
245 #define PROXIMITY10_NO_LED_DRIVE 0x00
246 #define PROXIMITY10_LED1_DRIVE_EN 0x01
247 #define PROXIMITY10_LED2_DRIVE_EN 0x02
248 #define PROXIMITY10_LED3_DRIVE_EN 0x04
249 
250 #define PROXIMITY10_ADC_REC_1_CLOCK 0x00
251 #define PROXIMITY10_ADC_REC_7_CLOCK 0x10
252 #define PROXIMITY10_ADC_REC_15_CLOCK 0x20
253 #define PROXIMITY10_ADC_REC_31_CLOCK 0x30
254 #define PROXIMITY10_ADC_REC_63_CLOCK 0x40
255 #define PROXIMITY10_ADC_REC_127_CLOCK 0x50
256 #define PROXIMITY10_ADC_REC_255_CLOCK 0x60
257 #define PROXIMITY10_ADC_REC_511_CLOCK 0x70
258 
259 #define PROXIMITY10_ADC_CLOCK_DIV_1 0x00
260 #define PROXIMITY10_ADC_CLOCK_DIV_2 0x01
261 #define PROXIMITY10_ADC_CLOCK_DIV_4 0x02
262 #define PROXIMITY10_ADC_CLOCK_DIV_8 0x03
263 #define PROXIMITY10_ADC_CLOCK_DIV_16 0x04
264 #define PROXIMITY10_ADC_CLOCK_DIV_32 0x05
265 #define PROXIMITY10_ADC_CLOCK_DIV_64 0x06
266 #define PROXIMITY10_ADC_CLOCK_DIV_128 0x07
267 
268 #define PROXIMITY10_NORMAL_SIGNAL_RANGE 0x00
269 #define PROXIMITY10_HIGH_SIGNAL_RANGE 0x20
270 #define PROXIMITY10_RAW_ADC_MEAS_MODE 0x00
271 #define PROXIMITY10_NORMAL_PROX_MEAS_MODE 0x04
272 
273 #define PROXIMITY10_ADC_INPUT_SMALL_IR 0x00
274 #define PROXIMITY10_ADC_INPUT_LARGE_IR 0x03
275 #define PROXIMITY10_ADC_INPUT_VIS_PHOTODIODE 0x02
276 #define PROXIMITY10_ADC_INPUT_NO_PHOTODIODE 0x06
277 #define PROXIMITY10_ADC_INPUT_GND 0x25
278 #define PROXIMITY10_ADC_INPUT_TEMP 0x65
279 #define PROXIMITY10_ADC_INPUT_VDD 0x75
280 
281 #define PROXIMITY10_2_CONS_SAMPLES 0x03
282 #define PROXIMITY10_3_CONS_SAMPLES 0x07
283 #define PROXIMITY10_8_CONS_SAMPLES 0xFF
284 
290 #define PROXIMITY10_PARAM_QUERY_CMD 0x80
291 #define PROXIMITY10_PARAM_SET_CMD 0xA0
292 #define PROXIMITY10_PARAM_AND_CMD 0xC0
293 #define PROXIMITY10_PARAM_OR_CMD 0xE0
294 #define PROXIMITY10_NOP_CMD 0x00
295 #define PROXIMITY10_RESET_CMD 0x01
296 #define PROXIMITY10_BUSADDR_CMD 0x02
297 #define PROXIMITY10_PS_FORCE_CMD 0x05
298 #define PROXIMITY10_ALS_FORCE_CMD 0x06
299 #define PROXIMITY10_PSALS_FORCE_CMD 0x07
300 #define PROXIMITY10_PS_PAUSE_CMD 0x09
301 #define PROXIMITY10_ALS_PAUSE_CMD 0x0A
302 #define PROXIMITY10_PSALS_PAUSE_CMD 0x0B
303 #define PROXIMITY10_PS_AUTO_CMD 0x0D
304 #define PROXIMITY10_ALS_AUTO_CMD 0x0E
305 #define PROXIMITY10_PSALS_AUTO_CMD 0x0F
306 
312 #define PROXIMITY10_INT_CLEAR_DIS 0x00
313 #define PROXIMITY10_INT_CLEAR_EN 0x01
314 #define PROXIMITY10_CLEAR_INT_CMD 0xFF
315 
321 #define PROXIMITY10_OK 0x00
322 #define PROXIMITY10_INVALID_REG_ADDR 0x01
323 #define PROXIMITY10_INVALID_PARAM_ADDR 0x02
324 #define PROXIMITY10_INVALID_CMD 0x03
325  // End group macro
328 // --------------------------------------------------------------- PUBLIC TYPES
337 typedef struct
338 {
339  // Input pins
340 
341  digital_in_t int_pin;
342 
343  // Modules
344 
345  i2c_master_t i2c;
346 
347  // ctx variable
348 
349  uint8_t slave_address;
350 
351 } proximity10_t;
352 
356 typedef struct
357 {
358  // Communication gpio pins
359 
360  pin_name_t scl;
361  pin_name_t sda;
362 
363  // Additional gpio pins
364 
365  pin_name_t int_pin;
366 
367  // static variable
368 
369  uint32_t i2c_speed;
370  uint8_t i2c_address;
371 
373  // End types group
375 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
376 
382 #ifdef __cplusplus
383 extern "C"{
384 #endif
385 
395 
405 
414 
425 uint8_t proximity10_generic_write ( proximity10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
426 
437 uint8_t proximity10_generic_read ( proximity10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
438 
450 uint8_t proximity10_check_int_status ( proximity10_t *ctx, uint8_t bit_mask, uint8_t clear_en );
451 
462 uint8_t proximity10_check_chip_status ( proximity10_t *ctx, uint8_t bit_mask );
463 
474 
487 uint8_t proximity10_send_command ( proximity10_t *ctx, uint8_t prox_command );
488 
501 uint8_t proximity10_param_query ( proximity10_t *ctx, uint8_t param_addr );
502 
515 uint8_t proximity10_param_set ( proximity10_t *ctx, uint8_t param_addr, uint8_t param_value );
516 
529 uint8_t proximity10_param_and ( proximity10_t *ctx, uint8_t param_addr, uint8_t param_value );
530 
543 uint8_t proximity10_param_or ( proximity10_t *ctx, uint8_t param_addr, uint8_t param_value );
544 
545 #ifdef __cplusplus
546 }
547 #endif
548 #endif // _PROXIMITY10_H_
549  // End public_function group
552 
553 // ------------------------------------------------------------------------- END
proximity10_cfg_t::scl
pin_name_t scl
Definition: proximity10.h:360
proximity10_param_or
uint8_t proximity10_param_or(proximity10_t *ctx, uint8_t param_addr, uint8_t param_value)
Parameter OR function.
proximity10_check_chip_status
uint8_t proximity10_check_chip_status(proximity10_t *ctx, uint8_t bit_mask)
Check Chip Status function.
proximity10_t::i2c
i2c_master_t i2c
Definition: proximity10.h:345
proximity10_generic_read
uint8_t proximity10_generic_read(proximity10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
proximity10_cfg_setup
void proximity10_cfg_setup(proximity10_cfg_t *cfg)
Config Object Initialization function.
PROXIMITY10_RETVAL
#define PROXIMITY10_RETVAL
Definition: proximity10.h:77
proximity10_param_and
uint8_t proximity10_param_and(proximity10_t *ctx, uint8_t param_addr, uint8_t param_value)
Parameter AND function.
proximity10_param_query
uint8_t proximity10_param_query(proximity10_t *ctx, uint8_t param_addr)
Parameter Query function.
proximity10_cfg_t
Click configuration structure definition.
Definition: proximity10.h:357
proximity10_generic_write
uint8_t proximity10_generic_write(proximity10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
proximity10_t::int_pin
digital_in_t int_pin
Definition: proximity10.h:341
proximity10_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: proximity10.h:369
proximity10_cfg_t::i2c_address
uint8_t i2c_address
Definition: proximity10.h:370
proximity10_cfg_t::int_pin
pin_name_t int_pin
Definition: proximity10.h:365
proximity10_t::slave_address
uint8_t slave_address
Definition: proximity10.h:349
proximity10_init
PROXIMITY10_RETVAL proximity10_init(proximity10_t *ctx, proximity10_cfg_t *cfg)
Initialization function.
proximity10_check_int_status
uint8_t proximity10_check_int_status(proximity10_t *ctx, uint8_t bit_mask, uint8_t clear_en)
Check INT Flags function.
proximity10_check_int_pin
uint8_t proximity10_check_int_pin(proximity10_t *ctx)
Check INT Pin function.
proximity10_param_set
uint8_t proximity10_param_set(proximity10_t *ctx, uint8_t param_addr, uint8_t param_value)
Parameter Set function.
proximity10_default_cfg
void proximity10_default_cfg(proximity10_t *ctx)
Click Default Configuration function.
proximity10_t
Click ctx object definition.
Definition: proximity10.h:338
proximity10_send_command
uint8_t proximity10_send_command(proximity10_t *ctx, uint8_t prox_command)
Command Send function.
proximity10_cfg_t::sda
pin_name_t sda
Definition: proximity10.h:361