ambient22.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 AMBIENT22_H
#define AMBIENT22_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 AMBIENT22_REG_RESULT                    0x00
#define AMBIENT22_REG_CONFIGURATION             0x01
#define AMBIENT22_REG_LOW_LIMIT                 0x02
#define AMBIENT22_REG_HIGH_LIMIT                0x03
#define AMBIENT22_REG_MANUFACTURER_ID           0x7E
#define AMBIENT22_REG_DEVICE_ID                 0x7F
 
 // ambient22_reg
 
#define AMBIENT22_CONFIG_RN_AUTO_SCALE          0xC000u
#define AMBIENT22_CONFIG_RN_MASK                0xF000u
#define AMBIENT22_CONFIG_CT_100_mS              0x0000u
#define AMBIENT22_CONFIG_CT_800_mS              0x0800u
#define AMBIENT22_CONFIG_CT_MASK                0x0800u
#define AMBIENT22_CONFIG_M_SHUTDOWN             0x0000u
#define AMBIENT22_CONFIG_M_SINGLE               0x0200u
#define AMBIENT22_CONFIG_M_CONTINUOUS           0x0400u
#define AMBIENT22_CONFIG_M_MASK                 0x0600u
#define AMBIENT22_CONFIG_OVF_MASK               0x0100u
#define AMBIENT22_CONFIG_CRF_MASK               0x0080u
#define AMBIENT22_CONFIG_FH_MASK                0x0040u
#define AMBIENT22_CONFIG_FL_MASK                0x0020u
#define AMBIENT22_CONFIG_L_TRANSPARENT          0x0000u
#define AMBIENT22_CONFIG_L_LATCH                0x0010u
#define AMBIENT22_CONFIG_L_MASK                 0x0010u
#define AMBIENT22_CONFIG_POL_LOW                0x0000u
#define AMBIENT22_CONFIG_POL_HIGH               0x0008u
#define AMBIENT22_CONFIG_POL_MASK               0x0008u
#define AMBIENT22_CONFIG_ME_MASK                0x0004u
#define AMBIENT22_CONFIG_FC_ONE                 0x0000u
#define AMBIENT22_CONFIG_FC_TWO                 0x0001u
#define AMBIENT22_CONFIG_FC_FOUR                0x0002u
#define AMBIENT22_CONFIG_FC_EIGHT               0x0003u
#define AMBIENT22_CONFIG_FC_MASK                0x0003u
 
#define AMBIENT22_RESULT_EXP                    0xF000u
#define AMBIENT22_RESULT_FRACT                  0x0FFFu
#define AMBIENT22_RESULT_MIN                    0x0000u
#define AMBIENT22_RESULT_MAX                    0xBFFFu
#define AMBIENT22_RESULT_LUX_PER_LSB            0.02f
 
#define AMBIENT22_MANUFACTURER_ID               0x5449u
#define AMBIENT22_DEVICE_ID                     0x3001u
 
#define AMBIENT22_DEVICE_ADDRESS_0              0x44
#define AMBIENT22_DEVICE_ADDRESS_1              0x45
 
 // ambient22_set
 
#define AMBIENT22_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ambient22_map
 // ambient22
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;           
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} ambient22_t;
 
typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
    pin_name_t int_pin;             
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
} ambient22_cfg_t;
 
typedef enum
{
    AMBIENT22_OK = 0,
    AMBIENT22_ERROR = -1
 
} ambient22_return_value_t;
 
void ambient22_cfg_setup ( ambient22_cfg_t *cfg );
 
err_t ambient22_init ( ambient22_t *ctx, ambient22_cfg_t *cfg );
 
err_t ambient22_default_cfg ( ambient22_t *ctx );
 
err_t ambient22_write_register ( ambient22_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t ambient22_read_register ( ambient22_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t ambient22_check_communication ( ambient22_t *ctx );
 
err_t ambient22_read_lux ( ambient22_t *ctx, float *lux );
 
uint8_t ambient22_get_int_pin ( ambient22_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT22_H
 
 // ambient22
 
// ------------------------------------------------------------------------ END