uv5.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 UV5_H
#define UV5_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 UV5_CFG_STATE_REG_OSR                 0x00
#define UV5_CFG_STATE_REG_AGEN                0x02
#define UV5_CFG_STATE_REG_CREG1               0x06
#define UV5_CFG_STATE_REG_CREG2               0x07
#define UV5_CFG_STATE_REG_CREG3               0x08
#define UV5_CFG_STATE_REG_BREAK               0x09
#define UV5_CFG_STATE_REG_EDGES               0x0A
#define UV5_CFG_STATE_REG_OPTREG              0x0B
#define UV5_MESASURE_STATE_REG_OSR            0x00
#define UV5_MESASURE_STATE_REG_TEMP           0x01
#define UV5_MESASURE_STATE_REG_MRES1          0x02
#define UV5_MESASURE_STATE_REG_MRES2          0x03
#define UV5_MESASURE_STATE_REG_MRES3          0x04
#define UV5_MESASURE_STATE_REG_OUTCONV_L      0x05
#define UV5_MESASURE_STATE_REG_OUTCONV_H      0x06
 
 // uv5_reg
 
#define UV5_START_MEASURMENT                  0x80
#define UV5_POWER_DOWN                        0x40
#define UV5_SW_RESET                          0x08
#define UV5_CONFIGURATION_MODE                0x02
#define UV5_MEASUREMENT_MODE                  0x03
 
#define UV5_DEVID                             0x20
#define UV5_MUT                               0x01
 
#define UV5_GAIN_2048X                        0x00
#define UV5_GAIN_1024X                        0x10
#define UV5_GAIN_512X                         0x20
#define UV5_GAIN_256X                         0x30
#define UV5_GAIN_128X                         0x40
#define UV5_GAIN_64X                          0x50
#define UV5_GAIN_32X                          0x60
#define UV5_GAIN_16X                          0x70
#define UV5_GAIN_8X                           0x80
#define UV5_GAIN_4X                           0x90
#define UV5_GAIN_2X                           0xA0
#define UV5_GAIN_1X                           0xB0
#define UV5_TIME_1_MS                         0x00
#define UV5_TIME_2_MS                         0x01
#define UV5_TIME_4_MS                         0x02
#define UV5_TIME_8_MS                         0x03
#define UV5_TIME_16_MS                        0x04
#define UV5_TIME_32_MS                        0x05
#define UV5_TIME_64_MS                        0x06
#define UV5_TIME_128_MS                       0x07
#define UV5_TIME_256_MS                       0x08
#define UV5_TIME_512_MS                       0x09
#define UV5_TIME_1024_MS                      0x0A
#define UV5_TIME_2048_MS                      0x0B
#define UV5_TIME_4096_MS                      0x0C
#define UV5_TIME_8192_MS                      0x0D
#define UV5_TIME_16384_MS                     0x0E
 
#define UV5_EN_TM                             0x40
#define UV5_EN_DIV                            0x08
#define UV5_DIV_256                           0x07
#define UV5_DIV_128                           0x06
#define UV5_DIV_64                            0x05
#define UV5_DIV_32                            0x04
#define UV5_DIV_16                            0x03
#define UV5_DIV_8                             0x02
#define UV5_DIV_4                             0x01
#define UV5_DIV_2                             0x00
 
#define UV5_MMODE_CONT                        0x00
#define UV5_MMODE_CMD                         0x40
#define UV5_MMODE_SYNS                        0x80
#define UV5_MMODE_SYND                        0xC0
#define UV5_STANDBY_ON                        0x10
#define UV5_READY_PUSH_PULL                   0x00
#define UV5_READY_OPEN_DRAIN                  0x08
#define UV5_CCLK_1024_KHZ                     0x00
#define UV5_CCLK_2048_KHZ                     0x01
#define UV5_CCLK_4096_KHZ                     0x02
#define UV5_CCLK_8192_KHZ                     0x03
 
#define UV5_TEMPERATURE_CALC_CONST            0.05
#define UV5_TEMPERATURE_CALC_VALUE            66.9
 
#define UV5_DEVICE_ADDRESS_00                  0x74
#define UV5_DEVICE_ADDRESS_01                  0x75
#define UV5_DEVICE_ADDRESS_10                  0x76
#define UV5_DEVICE_ADDRESS_11                  0x77
 
 // uv5_set
 
#define UV5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.syn = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // uv5_map
 // uv5
 
typedef struct
{
    // Output pins
    digital_out_t syn;          
    // Input pins
    digital_in_t rdy;           
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} uv5_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t syn;             
    pin_name_t rdy;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} uv5_cfg_t;
 
typedef enum
{
    UV5_OK = 0,
    UV5_ERROR = -1
 
} uv5_return_value_t;
 
void uv5_cfg_setup ( uv5_cfg_t *cfg );
 
err_t uv5_init ( uv5_t *ctx, uv5_cfg_t *cfg );
 
err_t uv5_default_cfg ( uv5_t *ctx );
 
err_t uv5_generic_write ( uv5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t uv5_generic_read ( uv5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
 
err_t uv5_write_cfg_reg ( uv5_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t uv5_write_measu_reg ( uv5_t *ctx, uint8_t reg, uint8_t *data_in );
 
err_t uv5_read_cfg_reg ( uv5_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t uv5_read_measu_reg ( uv5_t *ctx, uint8_t reg, uint8_t *data_out );
 
void uv5_set_syn_pin ( uv5_t *ctx, uint8_t pin_state );
 
uint8_t uv5_get_rdy_pin ( uv5_t *ctx );
 
err_t uv5_sw_reset ( uv5_t *ctx );
 
err_t uv5_temperature_read ( uv5_t *ctx, float *temp_data );
 
err_t uv5_channel_uva_read ( uv5_t *ctx, uint16_t *uva_data );
 
err_t uv5_channel_uvb_read ( uv5_t *ctx, uint16_t *uvb_data );
 
err_t uv5_channel_uvc_read ( uv5_t *ctx, uint16_t *uvc_data );
 
#ifdef __cplusplus
}
#endif
#endif // UV5_H
 
 // uv5
 
// ------------------------------------------------------------------------ END