uvb.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 UVB_H
#define UVB_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 UVB_REG_CHIP_ID               0x00
#define UVB_REG_MODE                  0x01
#define UVB_REG_RES_UV                0x04
#define UVB_REG_RANGE_UVB             0x07
#define UVB_REG_MODE_CTRL             0x0A
#define UVB_REG_SOFT_RESET            0x0B
#define UVB_REG_UVB_LSB               0x17
#define UVB_REG_UVB_MSB               0x18
#define UVB_REG_NVM_READ_CTRL         0x30
#define UVB_REG_NVM_MSB               0x31
#define UVB_REG_NVM_LSB               0x32
 
 // uvb_reg
 
#define UVB_MODE_NO_OPERATION         0x00
#define UVB_MODE_UVB_OPERATION        0x20
#define UVB_MODE_NORMAL               0x00
#define UVB_MODE_LOW_POWER            0x01
#define UVB_MODE_AUTO_SHUTDOWN        0x02
#define UVB_MODE_SHUTDOWN             0x03
 
#define UVB_RESOLUTION_800ms          0x00
#define UVB_RESOLUTION_400ms          0x01
#define UVB_RESOLUTION_200ms          0x02
#define UVB_RESOLUTION_100ms          0x03
 
#define UVB_RANGE_x1                  0x00
#define UVB_RANGE_x2                  0x01
#define UVB_RANGE_x4                  0x02
#define UVB_RANGE_x8                  0x03
#define UVB_RANGE_x16                 0x04
#define UVB_RANGE_x32                 0x05
#define UVB_RANGE_x64                 0x06
#define UVB_RANGE_x128                0x07
 
#define UVB_MCTRL_SLEEP_2_TIMES       0x00
#define UVB_MCTRL_SLEEP_4_TIMES       0x01
#define UVB_MCTRL_SLEEP_8_TIMES       0x02
#define UVB_MCTRL_SLEEP_16_TIMES      0x03
#define UVB_MCTRL_SLEEP_32_TIMES      0x04
#define UVB_MCTRL_SLEEP_64_TIMES      0x05
#define UVB_MCTRL_SLEEP_128_TIMES     0x06
#define UVB_MCTRL_SLEEP_256_TIMES     0x07
 
#define UVB_DEF_CHIP_ID               0x62
 
 
#define UVB_SET_DEV_ADDR  0x39
 
 // uvb_set
 
#define UVB_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // uvb_map
 // uvb
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
} uvb_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} uvb_cfg_t;
 
typedef enum
{
   UVB_OK = 0,
   UVB_ERROR = -1
 
} uvb_return_value_t;
 
void uvb_cfg_setup ( uvb_cfg_t *cfg );
 
err_t uvb_init ( uvb_t *ctx, uvb_cfg_t *cfg );
 
err_t uvb_default_cfg ( uvb_t *ctx );
 
err_t uvb_generic_write ( uvb_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t uvb_generic_read ( uvb_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void uvb_configuration ( uvb_t *ctx, uint8_t reg, uint8_t cfg );
 
uint8_t uvb_read_byte ( uvb_t *ctx, uint8_t reg );
 
err_t uvb_check_communication ( uvb_t *ctx );
 
uint16_t uvb_get_uv_data ( uvb_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // UVB_H
 
 // uvb
 
// ------------------------------------------------------------------------ END