uv3.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 UV3_H
#define UV3_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 UV3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.ack  = MIKROBUS( mikrobus, MIKROBUS_INT )
#define UV3_RETVAL  uint8_t
 
#define UV3_OK           0x00
#define UV3_INIT_ERROR   0xFF
#define UV3_I2C_ADDR_DEFAULT                                       0x38
#define UV3_ADDR_ARA                                               0x0C
#define UV3_ADDR_CMD                                               0x38
#define UV3_ADDR_DATA_LSB                                          0x38
#define UV3_ADDR_DATA_MSB                                          0x39
#define UV3_CMD_DEFAULT                                            0x02
#define UV3_CMD_SD                                                 0x01
#define UV3_CMD_IT_0_5T                                            0x00
#define UV3_CMD_IT_1T                                              0x04
#define UV3_CMD_IT_2T                                              0x08
#define UV3_CMD_IT_4T                                              0x0C
#define UV3_RAD_LOW                                                0x01
#define UV3_RAD_MODERATE                                           0x02
#define UV3_RAD_HIGH                                               0x03
#define UV3_RAD_VERY_HIGH                                          0x04
#define UV3_RAD_EXTREME                                            0x05
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t ack;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} uv3_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t ack;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} uv3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void uv3_cfg_setup ( uv3_cfg_t *cfg );
 
UV3_RETVAL uv3_init ( uv3_t *ctx, uv3_cfg_t *cfg );
 
void uv3_default_cfg ( uv3_t *ctx );
 
void uv3_write_command ( uv3_t *ctx, uint8_t slave_addr, uint8_t command );
 
uint8_t uv3_read_byte ( uv3_t *ctx, uint8_t slave_addr );
 
void uv3_clear_ack ( uv3_t *ctx );
 
void uv3_enable_sensor ( uv3_t *ctx );
 
void uv3_disable_mode ( uv3_t *ctx );
 
void uv3_set_integration_time ( uv3_t *ctx, uint8_t int_data );
 
uint16_t uv3_read_measurements ( uv3_t *ctx );
 
uint8_t uv3_risk_level ( uint16_t uv_data );
 
uint8_t uv3_get_interrupt ( uv3_t *ctx );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _UV3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END