uv4  2.0.0.0
uv4.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 UV4_H
36 #define UV4_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 UV4_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 UV4_RETVAL uint8_t
63 
64 #define UV4_OK 0x00
65 #define UV4_INIT_ERROR 0xFF
66 
72 #define UV4_PART_ID_REG 0x00
73 #define UV4_HW_ID_REG 0x01
74 #define UV4_REV_ID_REG 0x02
75 #define UV4_INFO_0_REG 0x03
76 #define UV4_INFO_1_REG 0x04
77 #define UV4_INPUT_3_REG 0x07
78 #define UV4_INPUT_2_REG 0x08
79 #define UV4_INPUT_1_REG 0x09
80 #define UV4_INPUT_0_REG 0x0A
81 #define UV4_COMMAND_REG 0x0B
82 #define UV4_IRQ_ENABLE_REG 0x0F
83 #define UV4_RESPONSE_1_REG 0x10
84 #define UV4_RESPONSE_0_REG 0x11
85 #define UV4_IRQ_STATUS_REG 0x12
86 #define UV4_OUTPUT_0_REG 0x13
87 #define UV4_OUTPUT_1_REG 0x14
88 #define UV4_OUTPUT_2_REG 0x15
89 #define UV4_OUTPUT_3_REG 0x16
90 #define UV4_OUTPUT_4_REG 0x17
91 #define UV4_OUTPUT_5_REG 0x18
92 #define UV4_OUTPUT_6_REG 0x19
93 #define UV4_OUTPUT_7_REG 0x1A
94 #define UV4_OUTPUT_8_REG 0x1B
95 #define UV4_OUTPUT_9_REG 0x1C
96 #define UV4_OUTPUT_10_REG 0x1D
97 #define UV4_OUTPUT_11_REG 0x1E
98 #define UV4_OUTPUT_12_REG 0x1F
99 #define UV4_OUTPUT_13_REG 0x20
100 #define UV4_OUTPUT_14_REG 0x21
101 #define UV4_OUTPUT_15_REG 0x22
102 #define UV4_OUTPUT_16_REG 0x23
103 #define UV4_OUTPUT_17_REG 0x24
104 #define UV4_OUTPUT_18_REG 0x25
105 #define UV4_OUTPUT_19_REG 0x26
106 #define UV4_OUTPUT_20_REG 0x27
107 #define UV4_OUTPUT_21_REG 0x28
108 #define UV4_OUTPUT_22_REG 0x29
109 #define UV4_OUTPUT_23_REG 0x2A
110 #define UV4_OUTPUT_24_REG 0x2B
111 #define UV4_OUTPUT_25_REG 0x2C
112 
118 #define UV4_I2C_ADDR_PARAM 0x00
119 #define UV4_CHAN_LIST_PARAM 0x01
120 #define UV4_ADCCONFIG_0_PARAM 0x02
121 #define UV4_ADCSENS_0_PARAM 0x03
122 #define UV4_ADCPOST_0_PARAM 0x04
123 #define UV4_MEASCONFIG_0_PARAM 0x05
124 #define UV4_ADCCONFIG_1_PARAM 0x06
125 #define UV4_ADCSENS_1_PARAM 0x07
126 #define UV4_ADCPOST_1_PARAM 0x08
127 #define UV4_MEASCONFIG_1_PARAM 0x09
128 #define UV4_ADCCONFIG_2_PARAM 0x0A
129 #define UV4_ADCSENS_2_PARAM 0x0B
130 #define UV4_ADCPOST_2_PARAM 0x0C
131 #define UV4_MEASCONFIG_2_PARAM 0x0D
132 #define UV4_ADCCONFIG_3_PARAM 0x0E
133 #define UV4_ADCSENS_3_PARAM 0x0F
134 #define UV4_ADCPOST_3_PARAM 0x10
135 #define UV4_MEASCONFIG_3_PARAM 0x11
136 #define UV4_ADCCONFIG_4_PARAM 0x12
137 #define UV4_ADCSENS_4_PARAM 0x13
138 #define UV4_ADCPOST_4_PARAM 0x14
139 #define UV4_MEASCONFIG_4_PARAM 0x15
140 #define UV4_ADCCONFIG_5_PARAM 0x16
141 #define UV4_ADCSENS_5_PARAM 0x17
142 #define UV4_ADCPOST_5_PARAM 0x18
143 #define UV4_MEASCONFIG_5_PARAM 0x19
144 #define UV4_MEASRATE_H_PARAM 0x1A
145 #define UV4_MEASRATE_L_PARAM 0x1B
146 #define UV4_MEASCOUNT_0_PARAM 0x1C
147 #define UV4_MEASCOUNT_1_PARAM 0x1D
148 #define UV4_MEASCOUNT_2_PARAM 0x1E
149 #define UV4_THRESHOLD0_H_PARAM 0x25
150 #define UV4_THRESHOLD0_L_PARAM 0x26
151 #define UV4_THRESHOLD1_H_PARAM 0x27
152 #define UV4_THRESHOLD1_L_PARAM 0x28
153 #define UV4_THRESHOLD2_H_PARAM 0x29
154 #define UV4_THRESHOLD2_L_PARAM 0x2A
155 #define UV4_BURST_PARAM 0x2B
156 
162 #define UV4_RESET_CTR_CMD 0x00
163 #define UV4_RESET_SW_CMD 0x01
164 #define UV4_FORCE_CMD 0x11
165 #define UV4_PAUSE_CMD 0x12
166 #define UV4_START_CMD 0x13
167 
173 #define UV4_ALL_INTERR_DISABLE 0x00
174 #define UV4_CHAN0_INTERR_ENABLE 0x01
175 #define UV4_CHAN1_INTERR_ENABLE 0x02
176 #define UV4_CHAN2_INTERR_ENABLE 0x04
177 #define UV4_CHAN3_INTERR_ENABLE 0x08
178 #define UV4_CHAN4_INTERR_ENABLE 0x10
179 #define UV4_CHAN5_INTERR_ENABLE 0x20
180 
186 #define UV4_ALL_CHANNELS_DISABLE 0x00
187 #define UV4_CHAN0_ENABLE 0x01
188 #define UV4_CHAN1_ENABLE 0x02
189 #define UV4_CHAN2_ENABLE 0x04
190 #define UV4_CHAN3_ENABLE 0x08
191 #define UV4_CHAN4_ENABLE 0x10
192 #define UV4_CHAN5_ENABLE 0x20
193 
199 #define UV4_DATARATE_1024 0x00
200 #define UV4_DATARATE_2048 0x20
201 #define UV4_DATARATE_4096 0x40
202 #define UV4_DATARATE_512 0x60
203 
209 #define UV4_OPT_FUNC_SMALL_IR 0x00
210 #define UV4_OPT_FUNC_MEDIUM_IR 0x01
211 #define UV4_OPT_FUNC_LARGE_IR 0x02
212 #define UV4_OPT_FUNC_WHITE 0x0B
213 #define UV4_OPT_FUNC_LARGE_WHITE 0x0D
214 #define UV4_OPT_FUNC_UV 0x18
215 #define UV4_OPT_FUNC_UV_DEEP 0x19
216 
222 #define UV4_NORMAL_GAIN 0x00
223 #define UV4_HIGH_RANGE 0x80
224 #define UV4_1_MEASUREMENT 0x00
225 #define UV4_2_MEASUREMENTS 0x10
226 #define UV4_4_MEASUREMENTS 0x20
227 #define UV4_8_MEASUREMENTS 0x30
228 #define UV4_16_MEASUREMENTS 0x40
229 #define UV4_32_MEASUREMENTS 0x50
230 #define UV4_64_MEASUREMENTS 0x60
231 #define UV4_128_MEASUREMENTS 0x70
232 #define UV4_MEASTIME_24MICROSEC 0x00
233 #define UV4_MEASTIME_48MICROSEC 0x01
234 #define UV4_MEASTIME_96MICROSEC 0x02
235 #define UV4_MEASTIME_25MILISEC 0x0A
236 #define UV4_MEASTIME_50MILISEC 0x0B
237 
243 #define UV4_16BIT_OUT 0x00
244 #define UV4_24BIT_OUT 0x40
245 #define UV4_NO_SHIFT_RIGHT 0x00
246 #define UV4_1BIT_SHIFT_RIGHT 0x08
247 #define UV4_2BITS_SHIFT_RIGHT 0x10
248 #define UV4_3BITS_SHIFT_RIGHT 0x18
249 #define UV4_4BITS_SHIFT_RIGHT 0x20
250 
256 #define UV4_THRESHOLDS_DISABLE 0x00
257 #define UV4_THRESHOLD0_INTERR_ENABLE 0x01
258 #define UV4_THRESHOLD1_INTERR_ENABLE 0x02
259 #define UV4_THRESHOLD2_INTERR_ENABLE 0x03
260 
266 #define UV4_NO_COUNTER_SELECTED 0x00
267 #define UV4_MEASCOUNT1_SELECT 0x40
268 #define UV4_MEASCOUNT2_SELECT 0x80
269 #define UV4_MEASCOUNT3_SELECT 0xC0
270 
276 #define UV4_BURST_DISABLE 0x00
277 #define UV4_BURST_ENABLE 0x80
278 
284 #define UV4_AUTOINC_ENABLE 0x00
285 #define UV4_AUTOINC_DISABLE 0x40
286 
292 #define UV4_OK 0x00
293 #define UV4_ADDR_ERR 0x01
294 #define UV4_PARAM_ERR 0x02
295 #define UV4_CMMND_ERR 0x03
296 #define UV4_LOC_ERR 0x04
297 #define UV4_ACCM_OVERFLOW 0x05
298 #define UV4_BUFF_OVERFLOW 0x06
299 #define UV4_RST_OCCURED 0x07
300 #define UV4_INTERR_OCCURED 0xFF
301 #define UV4_NO_INTERR 0x00
302  // End group macro
305 // --------------------------------------------------------------- PUBLIC TYPES
314 typedef struct
315 {
316 
317  digital_in_t int_pin;
318 
319  // Modules
320 
321  i2c_master_t i2c;
322 
323  // ctx variable
324 
325  uint8_t slave_address;
326 
327  uint8_t config_byte;
328 
329  uint8_t optical_data[ 6 ];
330 
331  uint8_t tmp;
332  uint8_t bit_size[ 6 ];
333  uint8_t inc_en;
334 
335 } uv4_t;
336 
340 typedef struct
341 {
342  // Communication gpio pins
343 
344  pin_name_t scl;
345  pin_name_t sda;
346 
347  // Additional gpio pins
348 
349  pin_name_t int_pin;
350 
351  // static variable
352 
353  uint32_t i2c_speed;
354  uint8_t i2c_address;
355 
356  uint8_t config_byte;
357  uint8_t optical_data[ 6 ];
358 
359  uint8_t dev_tmp;
360 
361 } uv4_cfg_t;
362  // End types group
364 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
365 
371 #ifdef __cplusplus
372 extern "C"{
373 #endif
374 
383 void uv4_cfg_setup ( uv4_cfg_t *cfg );
384 
393 UV4_RETVAL uv4_init ( uv4_t *ctx, uv4_cfg_t *cfg );
394 
402 void uv4_default_cfg ( uv4_t* ctx );
403 
414 UV4_RETVAL uv4_write_reg ( uv4_t* ctx, const uint8_t reg_address, const uint8_t transfer_data );
415 
429 UV4_RETVAL uv4_read_reg ( uv4_t* ctx, uint8_t reg_address, uint8_t* data_out,
430  uint8_t n_bytes );
431 
445 UV4_RETVAL uv4_write_param_data ( uv4_t* ctx, uint8_t param_address, uint8_t transfer_data );
446 
460 UV4_RETVAL uv4_read_param_data(uv4_t* ctx, uint8_t param_address, uint8_t* param_out);
461 
472 void uv4_read_measurements(uv4_t* ctx, uint32_t* measure_out);
473 
487 UV4_RETVAL uv4_check_err_and_ctr(uv4_t* ctx, uint8_t* cnt_data);
488 
499 
500 #ifdef __cplusplus
501 }
502 #endif
503 #endif // _UV4_H_
504  // End public_function group
507 
508 // ------------------------------------------------------------------------- END
uv4_t::int_pin
digital_in_t int_pin
Definition: uv4.h:317
uv4_cfg_t::config_byte
uint8_t config_byte
Definition: uv4.h:356
uv4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: uv4.h:353
uv4_cfg_setup
void uv4_cfg_setup(uv4_cfg_t *cfg)
Config Object Initialization function.
uv4_t::slave_address
uint8_t slave_address
Definition: uv4.h:325
uv4_cfg_t::scl
pin_name_t scl
Definition: uv4.h:344
uv4_t
Click ctx object definition.
Definition: uv4.h:314
uv4_t::inc_en
uint8_t inc_en
Definition: uv4.h:333
uv4_cfg_t::int_pin
pin_name_t int_pin
Definition: uv4.h:349
uv4_write_reg
UV4_RETVAL uv4_write_reg(uv4_t *ctx, const uint8_t reg_address, const uint8_t transfer_data)
Generic write function.
uv4_read_reg
UV4_RETVAL uv4_read_reg(uv4_t *ctx, uint8_t reg_address, uint8_t *data_out, uint8_t n_bytes)
Generic read function.
uv4_t::tmp
uint8_t tmp
Definition: uv4.h:331
uv4_cfg_t
Click configuration structure definition.
Definition: uv4.h:340
uv4_read_param_data
UV4_RETVAL uv4_read_param_data(uv4_t *ctx, uint8_t param_address, uint8_t *param_out)
Parameter Data Read Function.
uv4_cfg_t::sda
pin_name_t sda
Definition: uv4.h:345
UV4_RETVAL
#define UV4_RETVAL
Definition: uv4.h:62
uv4_check_err_and_ctr
UV4_RETVAL uv4_check_err_and_ctr(uv4_t *ctx, uint8_t *cnt_data)
Error And Counter Check function.
uv4_cfg_t::dev_tmp
uint8_t dev_tmp
Definition: uv4.h:359
uv4_check_interr
UV4_RETVAL uv4_check_interr(uv4_t *ctx)
Error And Counter Check function.
uv4_cfg_t::i2c_address
uint8_t i2c_address
Definition: uv4.h:354
uv4_write_param_data
UV4_RETVAL uv4_write_param_data(uv4_t *ctx, uint8_t param_address, uint8_t transfer_data)
Parameter Data Write Function.
uv4_read_measurements
void uv4_read_measurements(uv4_t *ctx, uint32_t *measure_out)
Measurements Read Function.
uv4_t::config_byte
uint8_t config_byte
Definition: uv4.h:327
uv4_default_cfg
void uv4_default_cfg(uv4_t *ctx)
Click Default Configuration function.
uv4_init
UV4_RETVAL uv4_init(uv4_t *ctx, uv4_cfg_t *cfg)
Initialization function.
uv4_t::i2c
i2c_master_t i2c
Definition: uv4.h:321