ambient12.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 AMBIENT12_H
#define AMBIENT12_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 AMBIENT12_SET_DEV_ADDR           0x4D
 
#define AMBIENT12_ADC_RESOLUTION         0x0FFF
#define AMBIENT12_VREF_3V3               3.3
 
#define AMBIENT12_IOUT_CURRENT_H_GAIN    0.57
#define AMBIENT12_IOUT_CURRENT_M_GAIN    0.057
#define AMBIENT12_IOUT_CURRENT_L_GAIN    0.0057
#define AMBIENT12_MICROAMPER_TO_AMPER    0.000001
#define AMBIENT12_IOUT_RESISTOR          5700
 
 // ambient12_set
 
#define AMBIENT12_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.gc1 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.gc2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // ambient12_map
 // ambient12
 
typedef enum
{
    AMBIENT12_MODE_SHUTDOWN,
    AMBIENT12_MODE_H_GAIN,
    AMBIENT12_MODE_M_GAIN,
    AMBIENT12_MODE_L_GAIN
 
} ambient12_gain_mode_t;
 
typedef struct
{
    digital_out_t  gc1;         
    digital_out_t  gc2;         
    analog_in_t  adc;           
    i2c_master_t i2c;           
    uint8_t slave_address;      
    ambient12_gain_mode_t gain_mode;
 
} ambient12_t;
 
typedef struct
{
    pin_name_t  an;             
    pin_name_t  gc1;            
    pin_name_t  gc2;            
    pin_name_t  scl;            
    pin_name_t  sda;            
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
    analog_in_resolution_t  resolution; 
    float                   vref;       
} ambient12_cfg_t;
 
typedef enum
{
    AMBIENT12_OK = 0,
    AMBIENT12_ERROR = -1
 
} ambient12_return_value_t;
 
void ambient12_cfg_setup ( ambient12_cfg_t *cfg );
 
err_t ambient12_init ( ambient12_t *ctx, ambient12_cfg_t *cfg );
 
err_t ambient12_read_an_pin_value ( ambient12_t *ctx, uint16_t *data_out );
 
err_t ambient12_read_an_pin_voltage ( ambient12_t *ctx, float *data_out );
 
err_t ambient12_read_raw_adc ( ambient12_t *ctx, uint16_t *raw_adc );
 
err_t ambient12_read_adc_voltage ( ambient12_t *ctx, float *voltage );
 
void ambient12_set_gc1_pin ( ambient12_t *ctx, uint8_t state );
 
void ambient12_set_gc2_pin ( ambient12_t *ctx, uint8_t state );
 
void ambient12_set_gain_mode ( ambient12_t *ctx, uint8_t mode );
 
int32_t ambient12_voltage_to_lux ( ambient12_t *ctx, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT12_H
 
 // ambient12
 
// ------------------------------------------------------------------------ END