ambient8.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 AMBIENT8_H
#define AMBIENT8_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define AMBIENT8_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define AMBIENT8_RETVAL  uint8_t
 
#define AMBIENT8_OK           0x00
#define AMBIENT8_INIT_ERROR   0xFF
#define AMBIENT8_DEVICE_ADDRESS                0x29
 // End group device_address 
 
#define AMBIENT8_ALS_CONTROL                   0x80
#define AMBIENT8_ALS_MEASUREMENT_RATE          0x85
#define AMBIENT8_PART_ID                       0x86
#define AMBIENT8_MANUFACTURER_ID               0x87
#define AMBIENT8_ALS_DATA_CH1_0                0x88
#define AMBIENT8_ALS_DATA_CH1_1                0x89
#define AMBIENT8_ALS_DATA_CH0_0                0x8A
#define AMBIENT8_ALS_DATA_CH0_1                0x8B
#define AMBIENT8_ALS_STATUS                    0x8C
 // End group register_address 
 
#define AMBIENT8_ALS_GAIN_1X                   0x00
#define AMBIENT8_ALS_GAIN_2X                   0x04
#define AMBIENT8_ALS_GAIN_4X                   0x08
#define AMBIENT8_ALS_GAIN_8X                   0x0C
#define AMBIENT8_ALS_GAIN_48X                  0x18
#define AMBIENT8_ALS_GAIN_96X                  0x1C
#define AMBIENT8_SW_RESET                      0x02
#define AMBIENT8_ALS_MODE_STANDBY              0x00
#define AMBIENT8_ALS_MODE_ACTIVE               0x01
 // End group als_control_register 
 
#define AMBIENT8_ALS_INTEGRATION_TIME_100ms    0x00
#define AMBIENT8_ALS_INTEGRATION_TIME_50ms     0x08
#define AMBIENT8_ALS_INTEGRATION_TIME_200ms    0x10
#define AMBIENT8_ALS_INTEGRATION_TIME_400ms    0x18
#define AMBIENT8_ALS_INTEGRATION_TIME_150ms    0x20
#define AMBIENT8_ALS_INTEGRATION_TIME_250ms    0x28
#define AMBIENT8_ALS_INTEGRATION_TIME_300ms    0x30
#define AMBIENT8_ALS_INTEGRATION_TIME_350ms    0x38
#define AMBIENT8_ALS_MEASUREMENT_RATE_50       0x00
#define AMBIENT8_ALS_MEASUREMENT_RATE_100      0x01
#define AMBIENT8_ALS_MEASUREMENT_RATE_200      0x02
#define AMBIENT8_ALS_MEASUREMENT_RATE_500      0x03
#define AMBIENT8_ALS_MEASUREMENT_RATE_1000     0x04
#define AMBIENT8_ALS_MEASUREMENT_RATE_2000     0x07
 // End group als_measurement_rate_register
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} ambient8_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} ambient8_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void ambient8_cfg_setup ( ambient8_cfg_t *cfg );
 
AMBIENT8_RETVAL ambient8_init ( ambient8_t *ctx, ambient8_cfg_t *cfg );
 
void ambient8_set_register ( ambient8_t* ctx, uint8_t* write_buf, uint8_t n_bytes );
 
void ambient8_get_register ( ambient8_t *ctx, uint8_t reg_addr, uint8_t *data_buf, uint8_t n_bytes );
 
void ambient8_set_constants ( ambient8_t* ctx );
 
AMBIENT8_RETVAL ambient8_get_als_data ( ambient8_t* ctx, uint16_t* als_data_ch1,
                                        uint16_t* als_data_ch0);
 
AMBIENT8_RETVAL ambient8_get_lux_level ( ambient8_t* ctx, float* lux_level,
                                         float window_factor, float IR_factor );
 
#ifdef __cplusplus
}
#endif
#endif  // _AMBIENT8_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END