irgesture.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 IRGESTURE_H
#define IRGESTURE_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 IRGESTURE_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl     = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda     = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ) 
#define IRGESTURE_RETVAL  uint8_t
 
#define IRGESTURE_OK               0x00
#define IRGESTURE_INIT_ERROR       0xFF
#define  IRGESTURE_I2C_ADDR        0x39
#define IRGESTURE_ENABLE           0x80
#define IRGESTURE_ATIME            0x81
#define IRGESTURE_WTIME            0x83
#define IRGESTURE_AILTL            0x84
#define IRGESTURE_AILTH            0x85
#define IRGESTURE_AIHTL            0x86
#define IRGESTURE_AIHTH            0x87
#define IRGESTURE_PILT             0x89
#define IRGESTURE_PIHT             0x8B
#define IRGESTURE_PERS             0x8C
#define IRGESTURE_CONFIG1          0x8D
#define IRGESTURE_PPULSE           0x8E
#define IRGESTURE_CONTROL          0x8F
#define IRGESTURE_CONFIG2          0x90
#define IRGESTURE_ID               0x92
#define IRGESTURE_STATUS           0x93
#define IRGESTURE_CDATAL           0x94
#define IRGESTURE_CDATAH           0x95
#define IRGESTURE_RDATAL           0x96
#define IRGESTURE_RDATAH           0x97
#define IRGESTURE_GDATAL           0x98
#define IRGESTURE_GDATAH           0x99
#define IRGESTURE_BDATAL           0x9A
#define IRGESTURE_BDATAH           0x9B
#define IRGESTURE_PDATA            0x9C
#define IRGESTURE_POFFSET_UR       0x9D
#define IRGESTURE_POFFSET_DL       0x9E
#define IRGESTURE_CONFIG3          0x9F
#define IRGESTURE_GPENTH           0xA0
#define IRGESTURE_GEXTH            0xA1
#define IRGESTURE_GCONF1           0xA2
#define IRGESTURE_GCONF2           0xA3
#define IRGESTURE_GOFFSET_U        0xA4
#define IRGESTURE_GOFFSET_D        0xA5
#define IRGESTURE_GOFFSET_L        0xA7
#define IRGESTURE_GOFFSET_R        0xA9
#define IRGESTURE_GPULSE           0xA6
#define IRGESTURE_GCONF3           0xAA
#define IRGESTURE_GCONF4           0xAB
#define IRGESTURE_GFLVL            0xAE
#define IRGESTURE_GSTATUS          0xAF
#define IRGESTURE_IFORCE           0xE4
#define IRGESTURE_PICLEAR          0xE5
#define IRGESTURE_CICLEAR          0xE6
#define IRGESTURE_AICLEAR          0xE7
#define IRGESTURE_GFIFO_U          0xFC
#define IRGESTURE_GFIFO_D          0xFD
#define IRGESTURE_GFIFO_L          0xFE
#define IRGESTURE_GFIFO_R          0xFF
#define DEFAULT_ATIME              219     
#define DEFAULT_WTIME              246     
#define DEFAULT_PROX_PPULSE        0x87    
#define DEFAULT_GESTURE_PPULSE     0x89    
#define DEFAULT_POFFSET_UR         0       
#define DEFAULT_POFFSET_DL         0       
#define DEFAULT_CONFIG1            0x60    
#define DEFAULT_LDRIVE             0     
#define DEFAULT_PGAIN              2       
#define DEFAULT_AGAIN              1       
#define DEFAULT_PILT               0       
#define DEFAULT_PIHT               50      
#define DEFAULT_AILT               0xFFFF  
#define DEFAULT_AIHT               0
#define DEFAULT_PERS               0x11    
#define DEFAULT_CONFIG2            0x01   
#define DEFAULT_CONFIG3            0       
#define DEFAULT_GPENTH             40      
#define DEFAULT_GEXTH              30      
#define DEFAULT_GCONF1             0x40    
#define DEFAULT_GGAIN              2      
#define DEFAULT_GLDRIVE            0      
#define DEFAULT_GWTIME             1      
#define DEFAULT_GOFFSET            0       
#define DEFAULT_GPULSE             0xC9    
#define DEFAULT_GCONF3             0     
#define DEFAULT_GIEN               0      
#define IRGESTURE_PON              0b00000001
#define IRGESTURE_AEN              0b00000010
#define IRGESTURE_PEN              0b00000100
#define IRGESTURE_WEN              0b00001000
#define IRGESTURE_AIEN             0b00010000
#define IRGESTURE_PIEN             0b00100000
#define IRGESTURE_GEN              0b01000000
#define IRGESTURE_GVALID           0b00000001
#define IRGESTURE_FAR              0x00
#define IRGESTURE_RIGHT            0x01
#define IRGESTURE_LEFT             0x02
#define IRGESTURE_UP               0x03
#define IRGESTURE_DOWN             0x04
#define IRGESTURE_NEAR             0x05
 // 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;
 
} irgesture_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;
 
} irgesture_cfg_t;
 
typedef enum
{
    NA_STATE,
    NEAR_STATE,
    FAR_STATE,
    ALL_STATE
 
} gesture_prox_t;
 
typedef enum
{
    DIR_NONE,
    DIR_LEFT,
    DIR_RIGHT,
    DIR_UP,
    DIR_DOWN,
    DIR_NEAR,
    DIR_FAR,
    DIR_ALL
 
} gesture_dir_t;
 
typedef struct
{
    uint8_t u_data[ 32 ];
    uint8_t d_data[ 32 ];
    uint8_t l_data[ 32 ];
    uint8_t r_data[ 32 ];
    uint8_t index;
    uint8_t total_gestures;
    uint8_t in_threshold;
    uint8_t out_threshold;
    uint16_t ud_delta;
    uint16_t lr_delta;
    uint16_t ud_count;
    uint16_t lr_count;
    uint16_t near_count;
    uint16_t far_count;
    gesture_prox_t state;
    gesture_dir_t motion;
 
} gesture_data_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void irgesture_cfg_setup ( irgesture_cfg_t *cfg );
 
IRGESTURE_RETVAL irgesture_init ( irgesture_t *ctx, irgesture_cfg_t *cfg );
 
void irgesture_default_cfg ( irgesture_t *ctx );
 
void irgesture_write_data ( irgesture_t *ctx, uint8_t reg_addr, uint8_t write_data );
 
uint8_t irgesture_read_data ( irgesture_t *ctx, uint8_t reg_addr );
 
uint8_t irgesture_get_interrupt ( irgesture_t *ctx );
 
gesture_dir_t irgesture_gesture_read_gesture ( irgesture_t *ctx );
 
void irgesture_set_gesture_mode ( irgesture_t *ctx );
 
void irgesture_enable_power ( irgesture_t *ctx );
 
void irgesture_disable_power ( irgesture_t *ctx );
 
void irgesture_set_ambient_light_gain ( irgesture_t *ctx, uint8_t gain_val );
 
uint8_t irgesture_get_ambient_light_gain ( irgesture_t *ctx );
 
void irgesture_enable_light_sensor ( irgesture_t *ctx );
 
void irgesture_disable_light_sensor ( irgesture_t *ctx );
 
uint16_t irgesture_read_ambient_light ( irgesture_t *ctx );
 
uint16_t irgesture_read_red_light ( irgesture_t *ctx );
 
uint16_t irgesture_read_green_light ( irgesture_t *ctx );
 
uint16_t irgesture_read_blue_light ( irgesture_t *ctx );
 
void irgesture_set_led_boost ( irgesture_t *ctx, uint8_t boost );
 
uint8_t irgesture_get_led_boost ( irgesture_t *ctx );
 
uint8_t irgesture_available ( irgesture_t *ctx );
 
void irgesture_set_gesture_gain ( irgesture_t *ctx, uint8_t gain_val );
 
uint8_t irgesture_get_gesture_gain ( irgesture_t *ctx );
 
void irgesture_enable_gesture_sensor ( irgesture_t *ctx );
 
void irgesture_disable_gesture_sensor ( irgesture_t *ctx );
 
uint8_t irgesture_detect_gesture ( irgesture_t *ctx );
 
void irgesture_set_proximity_gain ( irgesture_t *ctx, uint8_t gain_val );
 
uint8_t irgesture_get_proximity_gain ( irgesture_t *ctx );
 
void irgesture_enable_proximity_sensor ( irgesture_t *ctx );
 
void irgesture_disable_proximity_sensor ( irgesture_t *ctx );
 
uint8_t irgesture_get_proxy_photo_mask ( irgesture_t *ctx );
 
void irgesture_set_proxy_photo_mask ( irgesture_t *ctx, uint8_t mask );
 
uint8_t irgesture_read_proximity_data ( irgesture_t *ctx );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _IRGESTURE_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END