ambient10.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 AMBIENT10_H
#define AMBIENT10_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_analog_in.h"
#include "drv_i2c_master.h"
 
#define AMBIENT10_SET_DEV_ADDR          0x4D
 
#define AMBIENT10_ADC_RESOLUTION        0x0FFF
#define AMBIENT10_VREF_3V3              3.3
#define AMBIENT10_VREF_5V               5.0
 
#define AMBIENT10_MICROAMPER_TO_AMPER   0.000001
#define AMBIENT10_IOUT_TO_LUX           2.5
#define AMBIENT10_IOUT_RESISTOR         5100
 
 // ambient10_set
 
#define AMBIENT10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // ambient10_map
 // ambient10
 
typedef struct
{
    analog_in_t  adc;           
    i2c_master_t i2c;           
    uint8_t slave_address;      
    float   vref;               
} ambient10_t;
 
typedef struct
{
    pin_name_t  an;             
    pin_name_t  scl;            
    pin_name_t  sda;            
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
    analog_in_resolution_t  resolution;     
    float                   vref;           
} ambient10_cfg_t;
 
typedef enum
{
    AMBIENT10_OK = 0,
    AMBIENT10_ERROR = -1
 
} ambient10_return_value_t;
 
void ambient10_cfg_setup ( ambient10_cfg_t *cfg );
 
err_t ambient10_init ( ambient10_t *ctx, ambient10_cfg_t *cfg );
 
err_t ambient10_read_an_pin_value ( ambient10_t *ctx, uint16_t *data_out );
 
err_t ambient10_read_an_pin_voltage ( ambient10_t *ctx, float *data_out );
 
err_t ambient10_read_raw_adc ( ambient10_t *ctx, uint16_t *raw_adc );
 
err_t ambient10_read_adc_voltage ( ambient10_t *ctx, float *voltage );
 
err_t ambient10_set_vref ( ambient10_t *ctx, float vref );
 
uint16_t ambient10_voltage_to_lux ( ambient10_t *ctx, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT10_H
 
 // ambient10
 
// ------------------------------------------------------------------------ END