ambient23.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 AMBIENT23_H
#define AMBIENT23_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 AMBIENT23_REG_CONFIG                    0x00
#define AMBIENT23_REG_WHITE_DATA                0x04
#define AMBIENT23_REG_ALS_DATA                  0x05
#define AMBIENT23_REG_DEVICE_ID                 0x09
 
 // ambient23_reg
 
#define AMBIENT23_GAIN_1                    0x0000u
#define AMBIENT23_GAIN_2                    0x0800u
#define AMBIENT23_GAIN_4                    0x1800u
#define AMBIENT23_GAIN_MSK                  0x1800u
 
#define AMBIENT23_DATA_GAIN_1               0x0000u
#define AMBIENT23_DATA_GAIN_2               0x2000u
#define AMBIENT23_DATA_GAIN_MASK            0x2000u
 
#define AMBIENT23_SDO_SHUTDOWN_ON           0x8000u
#define AMBIENT23_SDO_SHUTDOWN_OFF          0x0000u
#define AMBIENT23_SHUTDOWN_ON               0x0001u
#define AMBIENT23_SHUTDOWN_OFF              0x0000u
 
#define AMBIENT23_TRIGGER_ON                0x0004u
#define AMBIENT23_TRIGGER_OFF               0x0000u
 
#define AMBIENT23_AUTO_FORCE_MODE           0x0800u
#define AMBIENT23_MANUAL_FORCE_MODE         0x0000u
 
#define AMBIENT23_INTEGRATION_50_MS         0x0000u
#define AMBIENT23_INTEGRATION_100_MS        0x0010u
#define AMBIENT23_INTEGRATION_200_MS        0x0020u
#define AMBIENT23_INTEGRATION_400_MS        0x0030u
#define AMBIENT23_INTEGRATION_800_MS        0x0040u
#define AMBIENT23_INTEGRATION_TIME_MSK      0x0070u
 
#define AMBIENT23_CONFIG_DEF_VAL            0x0100u
 
#define AMBIENT23_PART_ID                   0x35
 
#define AMBIENT23_TYPICAL_RESOLUTION        0.27264f
 
#define AMBIENT23_DEVICE_ADDRESS            0x10
 
 // ambient23_set
 
#define AMBIENT23_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); 
 
 // ambient23_map
 // ambient23
 
typedef struct
{
    // Modules
    i2c_master_t i2c;            
    // I2C slave address
    uint8_t slave_address;       
} ambient23_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} ambient23_cfg_t;
 
typedef enum
{
    AMBIENT23_OK = 0,
    AMBIENT23_ERROR = -1
 
} ambient23_return_value_t;
 
void ambient23_cfg_setup ( ambient23_cfg_t *cfg );
 
err_t ambient23_init ( ambient23_t *ctx, ambient23_cfg_t *cfg );
 
err_t ambient23_default_cfg ( ambient23_t *ctx );
 
err_t ambient23_generic_write ( ambient23_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t ambient23_generic_read ( ambient23_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t ambient23_reg_write ( ambient23_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t ambient23_reg_read ( ambient23_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t ambient23_calculate_res ( ambient23_t *ctx, float *conversion_mul );
 
err_t ambient23_read_light_data ( ambient23_t *ctx, float *light_data );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT23_H
 
 // ambient23
 
// ------------------------------------------------------------------------ END