proximity3.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 PROXIMITY3_H
#define PROXIMITY3_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 PROXIMITY3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define PROXIMITY3_OK                           0
#define PROXIMITY3_ERROR                       -1
#define PROXIMITY3_I2CADDR                      0x51     // I2C ADDRESS
#define PROXIMITY3_ALS_CONF_REG                 0x00     // Ambient Light Sensor Interrupt Threshold
#define PROXIMITY3_ALS_THDH_REG                 0x01     // Ambient Light Sensor Threshold Data High
#define PROXIMITY3_ALS_THDL_REG                 0x02     // Ambient Light Sensor Threshold Data Low
#define PROXIMITY3_PS_CONF1_CONF2_REG           0x03     // Proximity Conf1 and Conf2
#define PROXIMITY3_PS_CONF3_MS_REG              0x04     // Proximity Conf3 and Mode Select
#define PROXIMITY3_PS_CANC_REG                  0x05     // Proximity Cancellation Level Setting
#define PROXIMITY3_PS_THDL_REG                  0x06     // Proximity Sensor Threshold Data Low
#define PROXIMITY3_PS_THDH_REG                  0x07     // Proximity Sensor Threshold Data High
#define PROXIMITY3_PROXIMITY_REG                0x08     // Proximity output data
#define PROXIMITY3_AMBIENT_REG                  0x09     // Ambient Light Sensor output data
#define PROXIMITY3_WHITE_REG                    0x0A     // White output data
#define PROXIMITY3_INT_FLAG_REG                 0x0D     // Ambient Light Sensor and Proximity interrupt flags
#define PROXIMITY3_DEVICE_ID_REG                0x0E     // Device ID
#define PROXIMITY3_DEVICE_ID_VALUE              0x1058
#define PROXIMITY3_ALS_CONF_CONFIG              0x0040   // Default Startup Options Ambient Light Sensor
#define PROXIMITY3_PS_CONF1_CONF2_CONFIG        0x0A2A   // Default Startup Options Proximity Conf1 & Conf2
#define PROXIMITY3_PS_CONF3_MS_CONFIG           0x0770   // Default Startup Options Proximity Conf3 & MS
#define PROXIMITY3_PS_THDL_CONFIG               0x1388   // Proximity Interrupt Levels Threshold Data Low
#define PROXIMITY3_PS_THDH_CONFIG               0x2EE0   // Proximity Interrupt Levels Threshold Data High  
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
    digital_in_t int_pin;
    
    // Modules 
    i2c_master_t i2c;
 
    // ctx variable 
    uint8_t slave_address;
 
} proximity3_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
    pin_name_t int_pin;
 
    // static variable 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} proximity3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void proximity3_cfg_setup ( proximity3_cfg_t *cfg );
 
err_t proximity3_init ( proximity3_t *ctx, proximity3_cfg_t *cfg );
 
err_t proximity3_default_cfg ( proximity3_t *ctx );
 
err_t proximity3_write_16 ( proximity3_t *ctx, uint8_t reg_address, uint16_t data_in );
 
uint16_t proximity3_read_16 ( proximity3_t *ctx, uint8_t reg_address );
 
uint16_t proximity3_read_als ( proximity3_t *ctx );
 
uint16_t proximity3_read_proximity ( proximity3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _PROXIMITY3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END