proximity11.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 PROXIMITY11_H
#define PROXIMITY11_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 PROXIMITY11_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define PROXIMITY11_RETVAL  uint8_t
 
#define PROXIMITY11_OK           0x00
#define PROXIMITY11_INIT_ERROR   0xFF
#define PROXIMITY11_DEVICE_ADDRESS     0x38
#define PROXIMITY11_SYS_CTRL           0x40
#define PROXIMITY11_MODE_CTRL          0x41
#define PROXIMITY11_ALS_PS_CTRL        0x42
#define PROXIMITY11_PS_CTRL            0x43
#define PROXIMITY11_PS_DATA_LSB        0x44
#define PROXIMITY11_PS_DATA_MSB        0x45
#define PROXIMITY11_ALS_DATA0_LSB      0x46
#define PROXIMITY11_ALS_DATA0_MSB      0x47
#define PROXIMITY11_ALS_DATA1_LSB      0x48
#define PROXIMITY11_ALS_DATA1_MSB      0x49
#define PROXIMITY11_INTERRUPT          0x4A
#define PROXIMITY11_PS_TH_LSB          0x4B
#define PROXIMITY11_PS_TH_MSB          0x4C
#define PROXIMITY11_PS_TL_LSB          0x4D
#define PROXIMITY11_PS_TL_MSB          0x4E
#define PROXIMITY11_ALS_DATA0_TH_LSB   0x4F
#define PROXIMITY11_ALS_DATA0_TH_MSB   0x50
#define PROXIMITY11_ALS_DATA0_TL_LSB   0x51
#define PROXIMITY11_ALS_DATA0_TL_MSB   0x52
#define PROXIMITY11_PS_OFFSET_LSB      0x53
#define PROXIMITY11_PS_OFFSET_MSB      0x54
#define PROXIMITY11_MANUFACT_ID        0x92
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
  uint8_t als_data0_gain;
  uint8_t als_data1_gain;
  uint16_t als_measure_time;
 
} als_data_t;
 
typedef struct
{
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
    //als data object
 
    als_data_t als;
 
} proximity11_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;
    
    // als_data default values
 
    uint8_t als_data0_gain_cfg;
    uint8_t als_data1_gain_cfg;
    uint16_t als_measure_time_cfg;
 
} proximity11_cfg_t;
 
 
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void proximity11_cfg_setup ( proximity11_cfg_t *cfg );
 
PROXIMITY11_RETVAL proximity11_init ( proximity11_t *ctx, proximity11_cfg_t *cfg );
 
uint8_t proximity11_default_cfg ( proximity11_t *ctx );
 
void proximity11_generic_write ( proximity11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void proximity11_generic_read ( proximity11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t proximity11_int_get ( proximity11_t *ctx );
 
uint8_t proximity11_get ( proximity11_t *ctx, uint8_t register_address, uint8_t *output_buffer, uint8_t n_bytes );
 
uint8_t proximity11_set ( proximity11_t *ctx, uint8_t register_address, uint8_t *input_buffer, uint8_t n_bytes );
 
void proximity11_update ( proximity11_t *ctx );
 
float proximity11_convert_lx ( proximity11_t *ctx, uint16_t *input_data );
 
void proximity11_get_raw_ps_als_values ( proximity11_t *ctx, uint8_t *data_buffer );
 
void proximity11_get_ps_als_values ( proximity11_t *ctx, uint16_t *ps_value, float *als_value );
 
uint8_t proximity11_set_ps_threshold_high ( proximity11_t *ctx, uint16_t threshold_value );
 
uint8_t proximity11_set_ps_threshold_low ( proximity11_t *ctx, uint16_t threshold_value );
 
void proximity11_set_als_threshold_high ( proximity11_t *ctx, uint16_t threshold_value );
 
void proximity11_set_als_threshold_low ( proximity11_t *ctx, uint16_t threshold_value );
 
uint8_t proximity11_set_ps_offset ( proximity11_t *ctx, uint16_t offset_value );
 
#ifdef __cplusplus
}
#endif
#endif  // _PROXIMITY11_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END