uva.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 UVA_H
#define UVA_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#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"
 
#define UVA_REG_CHIP_ID                     0x00
#define UVA_REG_MODE                        0x01
#define UVA_REG_RES_UV                      0x04
#define UVA_REG_RANGE_UVA                   0x05
#define UVA_REG_MODE_CTRL                   0x0A
#define UVA_REG_SOFT_RESET                  0x0B
#define UVA_REG_UVA_LSB                     0x15
#define UVA_REG_UVA_MSB                     0x16
#define UVA_REG_NVM_READ_CTRL               0x30
#define UVA_REG_NVM_MSB                     0x31
#define UVA_REG_NVM_LSB                     0x32
 
 // uva_reg
 
#define UVA_CHIP_ID                         0x62
 
#define UVA_MODE_NO_OPERATION               0x00
#define UVA_MODE_UVA_OPERATION              0x10
#define UVA_MODE_NORMAL                     0x00
#define UVA_MODE_LOW_POWER                  0x01
#define UVA_MODE_AUTO_SHUTDOWN              0x02
#define UVA_MODE_SHUTDOWN                   0x03
 
#define UVA_RESOLUTION_800MS                0x00
#define UVA_RESOLUTION_400MS                0x01
#define UVA_RESOLUTION_200MS                0x02
#define UVA_RESOLUTION_100MS                0x03
 
#define UVA_RANGE_X1                        0x00
#define UVA_RANGE_X2                        0x01
#define UVA_RANGE_X4                        0x02
#define UVA_RANGE_X8                        0x03
#define UVA_RANGE_X16                       0x04
#define UVA_RANGE_X32                       0x05
#define UVA_RANGE_X64                       0x06
#define UVA_RANGE_X128                      0x07
 
#define UVA_MODE_CTRL_SLEEP_2_TIMES         0x00
#define UVA_MODE_CTRL_SLEEP_4_TIMES         0x01
#define UVA_MODE_CTRL_SLEEP_8_TIMES         0x02
#define UVA_MODE_CTRL_SLEEP_16_TIMES        0x03
#define UVA_MODE_CTRL_SLEEP_32_TIMES        0x04
#define UVA_MODE_CTRL_SLEEP_64_TIMES        0x05
#define UVA_MODE_CTRL_SLEEP_128_TIMES       0x06
#define UVA_MODE_CTRL_SLEEP_256_TIMES       0x07
 
#define UVA_SOFT_RESET                      0xA5
 
#define UVA_NVM_READ_ADDRESS_OFFSET         0x0A
#define UVA_NVM_READ_ADDRESS_A_SCALE        0x0B
 
#define UVA_SET_DEV_ADDR                    0x39
 
 // uva_set
 
#define UVA_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // uva_map
 // uva
 
typedef struct
{
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} uva_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} uva_cfg_t;
 
typedef enum
{
    UVA_OK = 0,
    UVA_ERROR = -1
 
} uva_return_value_t;
 
void uva_cfg_setup ( uva_cfg_t *cfg );
 
err_t uva_init ( uva_t *ctx, uva_cfg_t *cfg );
 
err_t uva_default_cfg ( uva_t *ctx );
 
err_t uva_generic_write ( uva_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t uva_generic_read ( uva_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t uva_write_register ( uva_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t uva_read_register ( uva_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t uva_check_communication ( uva_t *ctx );
 
err_t uva_read_data ( uva_t *ctx, uint16_t *uva_data );
 
err_t uva_soft_reset ( uva_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // UVA_H
 
 // uva
 
// ------------------------------------------------------------------------ END