ambient19.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 AMBIENT19_H
#define AMBIENT19_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 AMBIENT19_REG_SYSM_CTRL                 0x00
#define AMBIENT19_REG_INT_CTRL                  0x01
#define AMBIENT19_REG_INT_FLAG                  0x02
#define AMBIENT19_REG_WAIT_TIME                 0x03
#define AMBIENT19_REG_ALS_GAIN                  0x04
#define AMBIENT19_REG_ALS_TIME                  0x05
#define AMBIENT19_REG_LED_CTRL                  0x06
#define AMBIENT19_REG_PS_GAIN                   0x07
#define AMBIENT19_REG_PS_PULSE                  0x08
#define AMBIENT19_REG_PS_TIME                   0x09
#define AMBIENT19_REG_PERSISTENCE               0x0B
#define AMBIENT19_REG_ALS_THRES_LL              0x0C
#define AMBIENT19_REG_ALS_THRES_LH              0x0D
#define AMBIENT19_REG_ALS_THRES_HL              0x0E
#define AMBIENT19_REG_ALS_THRES_HH              0x0F
#define AMBIENT19_REG_PS_THRES_LL               0x10
#define AMBIENT19_REG_PS_THRES_LH               0x11
#define AMBIENT19_REG_PS_THRES_HL               0x12
#define AMBIENT19_REG_PS_THRES_HH               0x13
#define AMBIENT19_REG_PS_OFFSET_L               0x14
#define AMBIENT19_REG_PS_OFFSET_H               0x15
#define AMBIENT19_REG_INT_SOURCE                0x16
#define AMBIENT19_REG_ERROR_FLAG                0x17
#define AMBIENT19_REG_PS_DATA_L                 0x18
#define AMBIENT19_REG_PS_DATA_H                 0x19
#define AMBIENT19_REG_IR_DATA_L                 0x1A
#define AMBIENT19_REG_IR_DATA_H                 0x1B
#define AMBIENT19_REG_CH0_DATA_L                0x1C
#define AMBIENT19_REG_CH0_DATA_H                0x1D
#define AMBIENT19_REG_CH1_DATA_L                0x1E
#define AMBIENT19_REG_CH1_DATA_H                0x1F
#define AMBIENT19_REG_PNO_LB                    0xBC
#define AMBIENT19_REG_PNO_HB                    0xBD
 
 // ambient19_reg
 
#define AMBIENT19_SYSM_CTRL_SWRST               0x80
#define AMBIENT19_SYSM_EN_WAIT                  0x40
#define AMBIENT19_SYSM_EN_PS                    0x02
#define AMBIENT19_SYSM_EN_ALS                   0x01
 
#define AMBIENT19_INT_CTRL_PS_INT_MODE          0x80
#define AMBIENT19_INT_CTRL_SINT_MODE            0x40
#define AMBIENT19_INT_CTRL_PS_SYNC              0x20
#define AMBIENT19_INT_CTRL_ALS_SYNC             0x10
#define AMBIENT19_INT_CTRL_EN_PINT              0x02
#define AMBIENT19_INT_CTRL_EN_AINT              0x01
 
#define AMBIENT19_INT_FLAG_INT_POR              0x80
#define AMBIENT19_INT_FLAG_DATA_FLAG            0x40
#define AMBIENT19_INT_FLAG_OBJ                  0x20
#define AMBIENT19_INT_FLAG_INT_PS               0x02
#define AMBIENT19_INT_FLAG_INT_ALS              0x01
 
#define AMBIENT19_WAIT_TIME_MAX                 1280.0
#define AMBIENT19_WAIT_TIME_MIN                 5.0
#define AMBIENT19_WAIT_TIME_STEP                5.0
#define AMBIENT19_WAIT_TIME_DEFAULT             100.0
 
#define AMBIENT19_ALS_GAIN_1X                   0x00
#define AMBIENT19_ALS_GAIN_4X                   0x01
#define AMBIENT19_ALS_GAIN_8X                   0x02
#define AMBIENT19_ALS_GAIN_32X                  0x03
#define AMBIENT19_ALS_GAIN_96X                  0x04
 
#define AMBIENT19_ALS_TIME_MAX                  674.888
#define AMBIENT19_ALS_TIME_MIN                  5.513
#define AMBIENT19_ALS_TIME_STEP                 2.625
#define AMBIENT19_ALS_TIME_DEFAULT              400.0
 
#define AMBIENT19_LED_CTRL_IRDR_SEL_50mA        0x00
#define AMBIENT19_LED_CTRL_IRDR_SEL_100mA       0x40
#define AMBIENT19_LED_CTRL_IRDR_SEL_150mA       0x80
#define AMBIENT19_LED_CTRL_IRDR_SEL_200mA       0xC0
#define AMBIENT19_LED_CTRL_IRDR_SEL_BIT_MASK    0xC0
#define AMBIENT19_LED_CTRL_ITW_PS_MAX           875.213
#define AMBIENT19_LED_CTRL_ITW_PS_MIN           13.675
#define AMBIENT19_LED_CTRL_ITW_PS_STEP          13.675
#define AMBIENT19_LED_CTRL_ITW_PS_BIT_MASK      0x3F
 
#define AMBIENT19_PS_GAIN_1X                    0x00
#define AMBIENT19_PS_GAIN_2X                    0x01
#define AMBIENT19_PS_GAIN_4X                    0x02
#define AMBIENT19_PS_GAIN_8X                    0x03
 
#define AMBIENT19_PS_TIME_MAX_COUNT_4095        0x0F
 
#define AMBIENT19_PERSISTANCE_EVERY_ALS_CONV    0x00
 
#define AMBIENT19_INT_SOURCE_CH0_DATA           0x00
#define AMBIENT19_INT_SOURCE_CH1_DATA           0x01
 
#define AMBIENT19_LUX_K1                        0.52
#define AMBIENT19_LUX_K2                        0.94
#define AMBIENT19_LUX_K3                        1.12 // calculated using lux meter
 
#define AMBIENT19_PRODUCT_NUM_LOW               0x14
#define AMBIENT19_PRODUCT_NUM_HIGH              0x16
 
#define AMBIENT19_DEVICE_ADDRESS                0x38
 
 // ambient19_set
 
#define AMBIENT19_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ambient19_map
 // ambient19
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;           
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
    uint8_t pga_als;                
    uint8_t alsconv;                
} ambient19_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  int_pin;            
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} ambient19_cfg_t;
 
typedef enum
{
    AMBIENT19_OK = 0,
    AMBIENT19_ERROR = -1
 
} ambient19_return_value_t;
 
void ambient19_cfg_setup ( ambient19_cfg_t *cfg );
 
err_t ambient19_init ( ambient19_t *ctx, ambient19_cfg_t *cfg );
 
err_t ambient19_default_cfg ( ambient19_t *ctx );
 
err_t ambient19_generic_write ( ambient19_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t ambient19_generic_read ( ambient19_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t ambient19_write_register ( ambient19_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t ambient19_read_register ( ambient19_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t ambient19_check_communication ( ambient19_t *ctx );
 
uint8_t ambient19_get_int_pin ( ambient19_t *ctx );
 
err_t ambient19_clear_interrupts ( ambient19_t *ctx );
 
err_t ambient19_set_wait_time ( ambient19_t *ctx, float wait_time_ms );
 
err_t ambient19_set_als_time ( ambient19_t *ctx, float als_time_ms );
 
err_t ambient19_set_als_gain ( ambient19_t *ctx, uint8_t als_gain );
 
err_t ambient19_read_raw_als ( ambient19_t *ctx, uint16_t *ch_0, uint16_t *ch_1 );
 
err_t ambient19_read_raw_proximity ( ambient19_t *ctx, uint16_t *ps_data, uint16_t *ir_data );
 
err_t ambient19_measure_light_level ( ambient19_t *ctx, uint16_t *lux );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT19_H
 
 // ambient19
 
// ------------------------------------------------------------------------ END