uv2.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE 
 * OR OTHER DEALINGS IN THE SOFTWARE. 
 */
 
// ----------------------------------------------------------------------------
 
#ifndef UV2_H
#define UV2_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define UV2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define UV2_RETVAL  uint8_t
 
#define UV2_OK           0x00
#define UV2_INIT_ERROR   0xFF
#define UV2_I2C_ADDRESS                                            0x10
#define UV2_DEV_ID                                                 0x26
#define UV2_REG_CONF                                               0x00
#define UV2_REG_UVA                                                0x07
#define UV2_REG_UVB                                                0x09
#define UV2_REG_UVCOMP1                                            0x0A
#define UV2_REG_UVCOMP2                                            0x0B
#define UV2_REG_DEVID                                              0x0C
#define UV2_CONF_IT_50MS                                           0x00
#define UV2_CONF_IT_100MS                                          0x10
#define UV2_CONF_IT_200MS                                          0x20
#define UV2_CONF_IT_400MS                                          0x30
#define UV2_CONF_IT_800MS                                          0x40
#define UV2_CONF_IT_MASK                                           0x8F
#define UV2_CONF_HD_NORM                                           0x00
#define UV2_CONF_HD_HIGH                                           0x08
#define UV2_CONF_MODE_TRIG                                         0x00
#define UV2_CONF_ONE_TRIG                                          0x04
#define UV2_CONF_AF_OFF                                            0x00
#define UV2_CONF_AF_ON                                             0x02
#define UV2_CONF_SD_PWR_ON                                         0x00
#define UV2_CONF_SD_PWR_OFF                                        0x01
#define UV2_UVI_UVA_VIS_COEFF                                      3.33
#define UV2_UVI_UVA_IR_COEFF                                       2.50
#define UV2_UVI_UVB_VIS_COEFF                                      3.66
#define UV2_UVI_UVB_IR_COEFF                                       2.75
#define UV2_UVI_UVA_RESPONSE                                       0.00110
#define UV2_UVI_UVB_RESPONSE                                       0.00125
#define UV2_WRITE_MSB_BITS                                         0x00
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{   
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} uv2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} uv2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void uv2_cfg_setup ( uv2_cfg_t *cfg );
 
UV2_RETVAL uv2_init ( uv2_t *ctx, uv2_cfg_t *cfg );
 
void uv2_default_cfg ( uv2_t *ctx );
 
void uv2_generic_write ( uv2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void uv2_generic_read ( uv2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void uv2_write_data ( uv2_t *ctx, uint8_t reg_address, uint8_t write_data );
 
uint16_t uv2_read_data ( uv2_t *ctx, uint8_t reg_address );
 
void uv2_set_config ( uv2_t *ctx, uint8_t config_value );
 
void uv2_set_integration_time ( uv2_t *ctx, uint16_t intg_time );
 
void uv2_set_normal_dynamic ( uv2_t *ctx );
 
void uv2_set_high_dynamic ( uv2_t *ctx );
 
void uv2_set_trigger_measurement ( uv2_t *ctx );
 
void uv2_set_active_force_mode ( uv2_t *ctx, uint8_t force_mode );
 
void uv2_set_power_on ( uv2_t *ctx );
 
void uv2_set_power_off ( uv2_t *ctx );
 
uint8_t uv2_check_id ( uv2_t *ctx );
 
uint16_t uv2_get_uva ( uv2_t *ctx );
 
uint16_t uv2_get_uvb ( uv2_t *ctx );
 
float uv2_get_uv_index ( uv2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _UV2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END