grideye.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 GRIDEYE_H
#define GRIDEYE_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define GRIDEYE_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define GRIDEYE_RETVAL  int8_t
 
#define GRIDEYE_OK            0
#define GRIDEYE_INIT_ERROR  (-1)
#define GRIDEYE_I2C_ADDR     0x68
#define GRIDEYE_PCLT                 0x00
#define GRIDEYE_RST                  0x01
#define GRIDEYE_FPSC                 0x02
#define GRIDEYE_INTC                 0x03
#define GRIDEYE_STAT                 0x04
#define GRIDEYE_SCLR                 0x05
#define GRIDEYE_AVE                  0x07
 
#define GRIDEYE_INTHL                0x08
#define GRIDEYE_INTHH                0x09
#define GRIDEYE_INTLL                0x0A
#define GRIDEYE_INTLH                0x0B
#define GRIDEYE_IHYSL                0x0C
#define GRIDEYE_IHYSH                0x0D
#define GRIDEYE_TTHL                 0x0E
#define GRIDEYE_TTHH                 0x0F
#define GRIDEYE_INT0                 0x10
#define GRIDEYE_INT1                 0x11
#define GRIDEYE_INT2                 0x12
#define GRIDEYE_INT3                 0x13
#define GRIDEYE_INT4                 0x14
#define GRIDEYE_INT5                 0x15
#define GRIDEYE_INT6                 0x16
#define GRIDEYE_INT7                 0x17
#define GRIDEYE_PCLT_NORMAL          0x00
#define GRIDEYE_PCLT_SLEEP           0x10
#define GRIDEYE_PCLT_STANDBY_60      0x20
#define GRIDEYE_PCLT_STANDBY_10      0x21
#define GRIDEYE_RST_FLAG             0x30
#define GRIDEYE_RST_INIT             0x3F
#define GRIDEYE_FPSC_1FPS            0x01
#define GRIDEYE_FPSC_10FPS           0x00
#define GRIDEYE_INTC_INTEN_ACTIVE            0x01
#define GRIDEYE_INTC_INTEN_INACTIVE          0x00
#define GRIDEYE_INTC_INTMOD_ABSO             0x10
#define GRIDEYE_INTC_INTMOD_DIFE             0x00
#define GRIDEYE_SCLR_INTCLR                  0x02
#define GRIDEYE_SCLR_OVS_CLR                 0x04
#define GRIDEYE_SCLR_OVT_CLR                 0x08
#define GRIDEYE_AVE_MAMOD_ACTIVE             0x20
#define GRIDEYE_AVE_MAMOD_INACTIVE           0x00
#define GRIDEYE_PIXELS                       0x80
 // 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;
 
} grideye_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;
 
} grideye_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void grideye_cfg_setup ( grideye_cfg_t *cfg );
 
GRIDEYE_RETVAL grideye_init ( grideye_t *ctx, grideye_cfg_t *cfg );
 
void grideye_default_cfg ( grideye_t *ctx );
 
void grideye_generic_write ( grideye_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void grideye_generic_read ( grideye_t *ctx,  uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void grideye_write_data ( grideye_t *ctx, uint8_t wr_addr, uint16_t wr_data );
 
uint16_t grideye_read_data ( grideye_t *ctx, uint8_t rd_addr );
 
void grideye_read_grid ( grideye_t *ctx, int16_t *buffer );
 
uint8_t grideye_check_interrupt ( grideye_t *ctx );
 
void grideye_set_power_control ( grideye_t *ctx, uint8_t pow_cnt );
 
uint8_t grideye_read_power_control ( grideye_t *ctx );
 
void grideye_flag_reset ( grideye_t *ctx );
 
void grideye_initial_reset ( grideye_t *ctx );
 
void grideye_set_fps1 ( grideye_t *ctx );
 
void grideye_set_fps10 ( grideye_t *ctx );
 
uint8_t grideye_check_fps ( grideye_t *ctx );
 
void grideye_set_int_ctl_reg ( grideye_t *ctx, uint8_t int_cnt );
 
uint8_t grideye_read_int_ctl_reg ( grideye_t *ctx );
 
uint8_t grideye_read_stat_reg ( grideye_t *ctx );
 
void grideye_set_stat_clr_reg ( grideye_t *ctx, uint8_t int_cnt );
 
void grideye_set_ave_reg ( grideye_t *ctx, uint8_t mamod );
 
uint8_t grideye_read_ave_reg ( grideye_t *ctx );
 
void grideye_write_int_lvl_high ( grideye_t *ctx, uint16_t wr_data );
 
void grideye_write_int_lvl_low( grideye_t *ctx, uint16_t wr_data );
 
uint16_t grideye_read_int_lvl_high ( grideye_t *ctx );
 
uint16_t grideye_read_int_lvl_low ( grideye_t *ctx );
 
void grideye_write_int_hyst_lvl ( grideye_t *ctx, uint16_t wr_data );
 
uint16_t grideye_read_int_hyst_lvl ( grideye_t *ctx );
 
float grideye_read_therm_temp_reg ( grideye_t *ctx );
 
uint8_t grideye_read_int0 ( grideye_t *ctx );
 
uint8_t grideye_read_int1 ( grideye_t *ctx );
uint8_t grideye_read_int2 ( grideye_t *ctx );
 
uint8_t grideye_read_int3 ( grideye_t *ctx );
 
uint8_t grideye_read_int4 ( grideye_t *ctx );
 
uint8_t grideye_read_int5 ( grideye_t *ctx );
 
uint8_t grideye_read_int6 ( grideye_t *ctx );
 
uint8_t grideye_read_int7 ( grideye_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // GRIDEYE_H
 
 // End public_function group
 // End click Driver group
 
// ------------------------------------------------------------------------ END