uv2 2.0.0.0
uv2.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 UV2_H
36#define UV2_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 UV2_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
61#define UV2_RETVAL uint8_t
62
63#define UV2_OK 0x00
64#define UV2_INIT_ERROR 0xFF
71#define UV2_I2C_ADDRESS 0x10
72#define UV2_DEV_ID 0x26
79#define UV2_REG_CONF 0x00
80#define UV2_REG_UVA 0x07
81#define UV2_REG_UVB 0x09
82#define UV2_REG_UVCOMP1 0x0A
83#define UV2_REG_UVCOMP2 0x0B
84#define UV2_REG_DEVID 0x0C
91#define UV2_CONF_IT_50MS 0x00
92#define UV2_CONF_IT_100MS 0x10
93#define UV2_CONF_IT_200MS 0x20
94#define UV2_CONF_IT_400MS 0x30
95#define UV2_CONF_IT_800MS 0x40
96#define UV2_CONF_IT_MASK 0x8F
103#define UV2_CONF_HD_NORM 0x00
104#define UV2_CONF_HD_HIGH 0x08
111#define UV2_CONF_MODE_TRIG 0x00
112#define UV2_CONF_ONE_TRIG 0x04
119#define UV2_CONF_AF_OFF 0x00
120#define UV2_CONF_AF_ON 0x02
127#define UV2_CONF_SD_PWR_ON 0x00
128#define UV2_CONF_SD_PWR_OFF 0x01
135#define UV2_UVI_UVA_VIS_COEFF 3.33
136#define UV2_UVI_UVA_IR_COEFF 2.50
137#define UV2_UVI_UVB_VIS_COEFF 3.66
138#define UV2_UVI_UVB_IR_COEFF 2.75
145#define UV2_UVI_UVA_RESPONSE 0.00110
146#define UV2_UVI_UVB_RESPONSE 0.00125
153#define UV2_WRITE_MSB_BITS 0x00 // End group macro
157// --------------------------------------------------------------- PUBLIC TYPES
166typedef struct
167{
168 // Modules
169
170 i2c_master_t i2c;
171
172 // ctx variable
173
175
176} uv2_t;
177
181typedef struct
182{
183 // Communication gpio pins
184
185 pin_name_t scl;
186 pin_name_t sda;
187
188 // static variable
189
190 uint32_t i2c_speed;
191 uint8_t i2c_address;
192
193} uv2_cfg_t;
194 // End types group
196// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
197
203#ifdef __cplusplus
204extern "C"{
205#endif
206
216
226
234void uv2_default_cfg ( uv2_t *ctx );
235
246void uv2_generic_write ( uv2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
247
258void uv2_generic_read ( uv2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
259
270void uv2_write_data ( uv2_t *ctx, uint8_t reg_address, uint8_t write_data );
271
281uint16_t uv2_read_data ( uv2_t *ctx, uint8_t reg_address );
282
292void uv2_set_config ( uv2_t *ctx, uint8_t config_value );
293
303void uv2_set_integration_time ( uv2_t *ctx, uint16_t intg_time );
304
314
324
334
344void uv2_set_active_force_mode ( uv2_t *ctx, uint8_t force_mode );
345
355
365
373uint8_t uv2_check_id ( uv2_t *ctx );
374
383uint16_t uv2_get_uva ( uv2_t *ctx );
384
393uint16_t uv2_get_uvb ( uv2_t *ctx );
394
403float uv2_get_uv_index ( uv2_t *ctx );
404
405#ifdef __cplusplus
406}
407#endif
408#endif // _UV2_H_
409 // End public_function group
412
413// ------------------------------------------------------------------------- END
#define UV2_RETVAL
Definition: uv2.h:61
void uv2_set_config(uv2_t *ctx, uint8_t config_value)
Set configuration function.
float uv2_get_uv_index(uv2_t *ctx)
Get UV index function.
void uv2_set_power_on(uv2_t *ctx)
Set power ON function.
uint16_t uv2_read_data(uv2_t *ctx, uint8_t reg_address)
Read 16-bit data from 8-bit address function.
void uv2_write_data(uv2_t *ctx, uint8_t reg_address, uint8_t write_data)
Write 16-bit data function.
void uv2_cfg_setup(uv2_cfg_t *cfg)
Config Object Initialization function.
void uv2_set_active_force_mode(uv2_t *ctx, uint8_t force_mode)
Set active force mode function.
uint8_t uv2_check_id(uv2_t *ctx)
Check sensor ID function.
void uv2_set_high_dynamic(uv2_t *ctx)
Set high dynamic function.
void uv2_set_normal_dynamic(uv2_t *ctx)
Set normal dynamic function.
void uv2_set_power_off(uv2_t *ctx)
Set power OFF function.
void uv2_default_cfg(uv2_t *ctx)
Click Default Configuration function.
void uv2_generic_read(uv2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void uv2_generic_write(uv2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
uint16_t uv2_get_uva(uv2_t *ctx)
Get UVA data function.
void uv2_set_integration_time(uv2_t *ctx, uint16_t intg_time)
Set integration time function.
void uv2_set_trigger_measurement(uv2_t *ctx)
Set trigger one measurement function.
UV2_RETVAL uv2_init(uv2_t *ctx, uv2_cfg_t *cfg)
Initialization function.
uint16_t uv2_get_uvb(uv2_t *ctx)
Get UVB data function.
Click configuration structure definition.
Definition: uv2.h:182
uint32_t i2c_speed
Definition: uv2.h:190
pin_name_t scl
Definition: uv2.h:185
pin_name_t sda
Definition: uv2.h:186
uint8_t i2c_address
Definition: uv2.h:191
Click ctx object definition.
Definition: uv2.h:167
i2c_master_t i2c
Definition: uv2.h:170
uint8_t slave_address
Definition: uv2.h:174