ambient17.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 AMBIENT17_H
#define AMBIENT17_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 AMBIENT17_REG_ENABLE                0x00
#define AMBIENT17_REG_ATIME                 0x01
#define AMBIENT17_REG_WTIME                 0x03
#define AMBIENT17_REG_AILTL                 0x04
#define AMBIENT17_REG_AILTH                 0x05
#define AMBIENT17_REG_AIHTL                 0x06
#define AMBIENT17_REG_AIHTH                 0x07
#define AMBIENT17_REG_PERS                  0x0C
#define AMBIENT17_REG_CONFIG                0x0D
#define AMBIENT17_REG_CONTROL               0x0F
#define AMBIENT17_REG_ID                    0x12
#define AMBIENT17_REG_STATUS                0x13
#define AMBIENT17_REG_C0DATA                0x14
#define AMBIENT17_REG_C0DATAH               0x15
#define AMBIENT17_REG_C1DATA                0x16
#define AMBIENT17_REG_C1DATAH               0x17
 
 // ambient17_reg
 
#define AMBIENT17_CMD_BIT                   0x80
#define AMBIENT17_TYPE_REPEATED             0x00
#define AMBIENT17_TYPE_AUTO_INC             0x20
#define AMBIENT17_TYPE_SPEC_FUNC            0x60
#define AMBIENT17_SPEC_FUNC_INT_CLEAR       0x06
 
#define AMBIENT17_ENABLE_SLEEP_AFTER_INT    0x40
#define AMBIENT17_ENABLE_ALS_INT            0x10
#define AMBIENT17_ENABLE_WAIT               0x08
#define AMBIENT17_ENABLE_ALS                0x02
#define AMBIENT17_ENABLE_OSC                0x01
 
#define AMBIENT17_STATUS_AINT               0x10
#define AMBIENT17_STATUS_AVALID             0x01
 
#define AMBIENT17_ATIME_MAX                 699.88
#define AMBIENT17_ATIME_MIN                 2.73
#define AMBIENT17_ATIME_STEP                2.73
#define AMBIENT17_DEFAULT_ATIME             200.0
 
#define AMBIENT17_WTIME_MAX                 699.88
#define AMBIENT17_WTIME_MIN                 2.73
#define AMBIENT17_WTIME_STEP                2.73
#define AMBIENT17_DEFAULT_WTIME             200.0
 
#define AMBIENT17_AGAIN_1X                  0x00
#define AMBIENT17_AGAIN_8X                  0x01
#define AMBIENT17_AGAIN_16X                 0x02
#define AMBIENT17_AGAIN_120X                0x03
 
#define AMBIENT17_CH0_COFF0                 1.0
#define AMBIENT17_CH1_COFF0                 1.87
#define AMBIENT17_CH0_COFF1                 0.63
#define AMBIENT17_CH1_COFF1                 1.0
#define AMBIENT17_GA_VALUE                  1.0
#define AMBIENT17_GA_MULTIPLIER             60.0
 
#define AMBIENT17_DEVICE_ID                 0x34
 
#define AMBIENT17_DEVICE_ADDRESS            0x39
 
 // ambient17_set
 
#define AMBIENT17_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ambient17_map
 // ambient17
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;           
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
    float   atime_ms;               
    uint8_t again;                  
    float   cpl;                    
} ambient17_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  int_pin;            
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} ambient17_cfg_t;
 
typedef enum
{
    AMBIENT17_OK = 0,
    AMBIENT17_ERROR = -1
 
} ambient17_return_value_t;
 
void ambient17_cfg_setup ( ambient17_cfg_t *cfg );
 
err_t ambient17_init ( ambient17_t *ctx, ambient17_cfg_t *cfg );
 
err_t ambient17_default_cfg ( ambient17_t *ctx );
 
err_t ambient17_generic_write ( ambient17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t ambient17_generic_read ( ambient17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t ambient17_write_register ( ambient17_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t ambient17_read_register ( ambient17_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t ambient17_check_communication ( ambient17_t *ctx );
 
uint8_t ambient17_get_int_pin ( ambient17_t *ctx );
 
err_t ambient17_clear_interrupts ( ambient17_t *ctx );
 
err_t ambient17_set_atime ( ambient17_t *ctx, float atime_ms );
 
err_t ambient17_set_wtime ( ambient17_t *ctx, float wtime_ms );
 
err_t ambient17_set_again ( ambient17_t *ctx, uint8_t again );
 
err_t ambient17_read_raw_data ( ambient17_t *ctx, uint16_t *ch_0, uint16_t *ch_1 );
 
err_t ambient17_measure_light_level ( ambient17_t *ctx, uint16_t *lux );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT17_H
 
 // ambient17
 
// ------------------------------------------------------------------------ END