ambient18.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 AMBIENT18_H
#define AMBIENT18_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 AMBIENT18_MODE_SHUTDOWN         0
#define AMBIENT18_MODE_H_GAIN           1
#define AMBIENT18_MODE_M_GAIN           2
#define AMBIENT18_MODE_L_GAIN           3
 
#define AMBIENT18_ADC_RESOLUTION        0x0FFF
#define AMBIENT18_VREF_3V3              3.3
#define AMBIENT18_VREF_5V               5.0
 
#define AMBIENT18_IOUT_CURRENT_H_GAIN   6.1
#define AMBIENT18_IOUT_CURRENT_M_GAIN   0.61
#define AMBIENT18_IOUT_CURRENT_L_GAIN   0.061
#define AMBIENT18_MICROAMPER_TO_AMPER   0.000001
#define AMBIENT18_IOUT_RESISTOR         5420
 
#define AMBIENT18_SET_DEV_ADDR          0x4D
 
 // ambient18_set
 
#define AMBIENT18_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.gc1 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.gc2 = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // ambient18_map
 // ambient18
 
typedef enum
{
    AMBIENT18_DRV_SEL_ADC,       
    AMBIENT18_DRV_SEL_I2C        
} ambient18_drv_t;
 
typedef struct
{
    digital_out_t  gc1;         
    digital_out_t  gc2;         
    analog_in_t  adc;           
    i2c_master_t i2c;           
    uint8_t     slave_address;  
    pin_name_t  chip_select;    
    float       vref;           
    ambient18_drv_t drv_sel;    
    uint8_t     gain_mode;      
} ambient18_t;
 
typedef struct
{
    pin_name_t  an;                                 
    pin_name_t  scl;                                
    pin_name_t  sda;                                
    pin_name_t  gc1;                                
    pin_name_t  gc2;                                
    analog_in_resolution_t  resolution;             
    float                   vref;                   
    uint32_t                i2c_speed;              
    uint8_t                 i2c_address;            
    ambient18_drv_t drv_sel;                        
} ambient18_cfg_t;
 
typedef enum
{
    AMBIENT18_OK = 0,
    AMBIENT18_ERROR = -1
 
} ambient18_return_value_t;
 
void ambient18_cfg_setup ( ambient18_cfg_t *cfg );
 
void ambient18_drv_interface_selection ( ambient18_cfg_t *cfg, ambient18_drv_t drv_sel );
 
err_t ambient18_init ( ambient18_t *ctx, ambient18_cfg_t *cfg );
 
err_t ambient18_read_raw_adc ( ambient18_t *ctx, uint16_t *raw_adc );
 
err_t ambient18_read_voltage ( ambient18_t *ctx, float *voltage );
 
err_t ambient18_set_vref ( ambient18_t *ctx, float vref );
 
void ambient18_set_gain_mode ( ambient18_t *ctx, uint8_t mode );
 
int32_t ambient18_voltage_to_lux ( ambient18_t *ctx, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT18_H
 
 // ambient18
 
// ------------------------------------------------------------------------ END