ambient20.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 AMBIENT20_H
#define AMBIENT20_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 AMBIENT20_SYSTEM_CONTROL_REG        0x40
#define AMBIENT20_MODE_CONTROL1_REG         0x41
#define AMBIENT20_MODE_CONTROL2_REG         0x42
#define AMBIENT20_MODE_CONTROL3_REG         0x43
#define AMBIENT20_DATA0_LSB_REG             0x50
#define AMBIENT20_DATA0_MSB_REG             0x51
#define AMBIENT20_DATA1_LSB_REG             0x52
#define AMBIENT20_DATA1_MSB_REG             0x53
#define AMBIENT20_MANUFACTURER_ID_REG       0x92
 
 // ambient20_reg
 
#define AMBIENT20_GAIN_X1                   0x02
#define AMBIENT20_GAIN_X32                  0x0A
#define AMBIENT20_GAIN_X256                 0x0C
#define AMBIENT20_100mS_MODE                0x00
#define AMBIENT20_55mS_MODE                 0x01
#define AMBIENT20_VALID_MASK                0x80
#define AMBIENT20_ENABLE                    0x01
#define AMBIENT20_DISABLE                   0x00
#define AMBIENT20_MANUFACTURER_ID           0xE0
#define AMBIENT20_PART_ID                   0x12
#define AMBIENT20_PART_ID_MASK              0x3F
 
#define AMBIENT20_DATA0_CONVERSION_COEF     0.169491525
#define AMBIENT20_DATA1_CONVERSION_COEF     0.689655172
 
#define AMBIENT20_DEVICE_ADDRESS        0x38
 
 // ambient20_set
 
#define AMBIENT20_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ) 
  
 // ambient20_map
 // ambient20
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                           
    // I2C slave address
    uint8_t slave_address;                      
    uint8_t data0_gain;
    uint8_t data1_gain;
 
} ambient20_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} ambient20_cfg_t;
 
typedef enum
{
    AMBIENT20_OK = 0,
    AMBIENT20_ERROR = -1
 
} ambient20_return_value_t;
 
void ambient20_cfg_setup ( ambient20_cfg_t *cfg );
 
err_t ambient20_init ( ambient20_t *ctx, ambient20_cfg_t *cfg );
 
err_t ambient20_default_cfg ( ambient20_t *ctx );
 
err_t ambient20_generic_write ( ambient20_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t ambient20_generic_read ( ambient20_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t ambient20_sw_reset ( ambient20_t *ctx );
 
err_t ambient20_get_manufacturer_id ( ambient20_t *ctx, uint8_t *manufacturer_id );
 
err_t ambient20_get_part_id ( ambient20_t *ctx, uint8_t *part_id );
 
err_t ambient20_enable_wait_mode ( ambient20_t *ctx );
 
err_t ambient20_disable_wait_mode ( ambient20_t *ctx );
 
err_t ambient20_set_meas_mode ( ambient20_t *ctx, uint8_t meas_mode );
 
err_t ambient20_set_gain ( ambient20_t *ctx, uint8_t data0_gain, uint8_t data1_gain );
 
err_t ambient20_enable_meas ( ambient20_t *ctx );
 
err_t ambient20_disable_meas ( ambient20_t *ctx );
 
err_t ambient20_check_valid ( ambient20_t *ctx );
 
err_t ambient20_read_data0 ( ambient20_t *ctx, uint16_t *data0_out );
 
err_t ambient20_read_data1 ( ambient20_t *ctx, uint16_t *data1_out );
 
err_t ambient20_get_data_lux ( ambient20_t *ctx, float *data0_out ,float *data1_out );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT20_H
 
 // ambient20
 
// ------------------------------------------------------------------------ END