ambient21.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 AMBIENT21_H
#define AMBIENT21_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 AMBIENT21_REG_ENABLE                0x00
#define AMBIENT21_REG_CONFIG                0x01
#define AMBIENT21_REG_AILTL                 0x04
#define AMBIENT21_REG_AILTH                 0x05
#define AMBIENT21_REG_AIHTL                 0x06
#define AMBIENT21_REG_AIHTH                 0x07
#define AMBIENT21_REG_NPAILTL               0x08
#define AMBIENT21_REG_NPAILTH               0x09
#define AMBIENT21_REG_NPAIHTL               0x0A
#define AMBIENT21_REG_NPAIHTH               0x0B
#define AMBIENT21_REG_PERSIST               0x0C
#define AMBIENT21_REG_PID                   0x11
#define AMBIENT21_REG_ID                    0x12
#define AMBIENT21_REG_STATUS                0x13
#define AMBIENT21_REG_C0DATAL               0x14
#define AMBIENT21_REG_C0DATAH               0x15
#define AMBIENT21_REG_C1DATAL               0x16
#define AMBIENT21_REG_C1DATAH               0x17
 
 // ambient21_reg
 
#define AMBIENT21_CMD_NORMAL_OP             0xA0
#define AMBIENT21_CMD_SPEC_FUNC             0xE0
#define AMBIENT21_SF_INT_SET                0x04
#define AMBIENT21_SF_CLEAR_ALS_INT          0x06
#define AMBIENT21_SF_CLEAR_ALS_NOPERS_INT   0x07
#define AMBIENT21_SF_CLEAR_NOPERS_INT       0x0A
#define AMBIENT21_ADDR_SF_MASK              0x1F
 
#define AMBIENT21_ENABLE_NPIEN              0x80
#define AMBIENT21_ENABLE_SAI                0x40
#define AMBIENT21_ENABLE_AIEN               0x10
#define AMBIENT21_ENABLE_AEN                0x02
#define AMBIENT21_ENABLE_PON                0x01
 
#define AMBIENT21_CONFIG_SRESET             0x80
#define AMBIENT21_CONFIG_AGAIN_LOW          0x00
#define AMBIENT21_CONFIG_AGAIN_MID          0x10
#define AMBIENT21_CONFIG_AGAIN_HIGH         0x20
#define AMBIENT21_CONFIG_AGAIN_MAX          0x30
#define AMBIENT21_CONFIG_AGAIN_MASK         0x30
#define AMBIENT21_CONFIG_ATIME_100MS        0x00
#define AMBIENT21_CONFIG_ATIME_200MS        0x01
#define AMBIENT21_CONFIG_ATIME_300MS        0x02
#define AMBIENT21_CONFIG_ATIME_400MS        0x03
#define AMBIENT21_CONFIG_ATIME_500MS        0x04
#define AMBIENT21_CONFIG_ATIME_600MS        0x05
#define AMBIENT21_CONFIG_ATIME_MASK         0x07
 
#define AMBIENT21_PERSIST_EVERY             0x00
#define AMBIENT21_PERSIST_ANY               0x01
#define AMBIENT21_PERSIST_2                 0x02
#define AMBIENT21_PERSIST_3                 0x03
#define AMBIENT21_PERSIST_5                 0x04
#define AMBIENT21_PERSIST_10                0x05
#define AMBIENT21_PERSIST_15                0x06
#define AMBIENT21_PERSIST_20                0x07
#define AMBIENT21_PERSIST_25                0x08
#define AMBIENT21_PERSIST_30                0x09
#define AMBIENT21_PERSIST_35                0x0A
#define AMBIENT21_PERSIST_40                0x0B
#define AMBIENT21_PERSIST_45                0x0C
#define AMBIENT21_PERSIST_50                0x0D
#define AMBIENT21_PERSIST_55                0x0E
#define AMBIENT21_PERSIST_60                0x0F
#define AMBIENT21_PERSIST_MASK              0x0F
 
#define AMBIENT21_STATUS_NPINTR             0x20
#define AMBIENT21_STATUS_AINT               0x10
#define AMBIENT21_STATUS_AVALID             0x01
 
#define AMBIENT21_DEVICE_ID                 0x50
 
#define AMBIENT21_AGAIN_LOW                 0x00
#define AMBIENT21_AGAIN_MID                 0x01
#define AMBIENT21_AGAIN_HIGH                0x02
#define AMBIENT21_AGAIN_MAX                 0x03
#define AMBIENT21_ATIME_100MS               0x00
#define AMBIENT21_ATIME_200MS               0x01
#define AMBIENT21_ATIME_300MS               0x02
#define AMBIENT21_ATIME_400MS               0x03
#define AMBIENT21_ATIME_500MS               0x04
#define AMBIENT21_ATIME_600MS               0x05
 
#define AMBIENT21_GAIN_0                    1.0f
#define AMBIENT21_GAIN_1                    25.0f
#define AMBIENT21_GAIN_2                    428.0f
#define AMBIENT21_GAIN_3                    9876.0f
#define AMBIENT21_TIME_RES                  100.0f
#define AMBIENT21_LUX_GDF                   900.0f
#define AMBIENT21_LUX_COEF                  1.0f
 
#define AMBIENT21_DEVICE_ADDRESS            0x29
 
 // ambient21_set
 
#define AMBIENT21_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ambient21_map
 // ambient21
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;           
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
    float   atime_ms;               
    float   again;                  
    float   cpl;                    
} ambient21_t;
 
typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
    pin_name_t int_pin;             
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
} ambient21_cfg_t;
 
typedef enum
{
    AMBIENT21_OK = 0,
    AMBIENT21_ERROR = -1
 
} ambient21_return_value_t;
 
void ambient21_cfg_setup ( ambient21_cfg_t *cfg );
 
err_t ambient21_init ( ambient21_t *ctx, ambient21_cfg_t *cfg );
 
err_t ambient21_default_cfg ( ambient21_t *ctx );
 
err_t ambient21_generic_write ( ambient21_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t ambient21_generic_read ( ambient21_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t ambient21_write_register ( ambient21_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t ambient21_read_register ( ambient21_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t ambient21_write_spec_func ( ambient21_t *ctx, uint8_t spec_func );
 
uint8_t ambient21_get_int_pin ( ambient21_t *ctx );
 
err_t ambient21_check_communication ( ambient21_t *ctx );
 
err_t ambient21_clear_interrupts ( ambient21_t *ctx );
 
err_t ambient21_set_config ( ambient21_t *ctx, uint8_t again, uint8_t atime );
 
err_t ambient21_read_raw_data ( ambient21_t *ctx, uint16_t *ch_0, uint16_t *ch_1 );
 
err_t ambient21_measure_light_level ( ambient21_t *ctx, uint16_t *lux );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT21_H
 
 // ambient21
 
// ------------------------------------------------------------------------ END