grideye2  2.1.0.0
Modules | Functions
Grid-EYE 2 Click Driver

API for configuring and manipulating Grid-EYE 2 Click driver. More...

Modules

 Grid-EYE 2 Registers List
 List of registers of Grid-EYE 2 Click driver.
 
 Grid-EYE 2 Registers Settings
 Settings for registers of Grid-EYE 2 Click driver.
 
 Grid-EYE 2 MikroBUS Map
 MikroBUS pin mapping of Grid-EYE 2 Click driver.
 

Functions

void grideye2_cfg_setup (grideye2_cfg_t *cfg)
 Grid-EYE 2 configuration object setup function. More...
 
err_t grideye2_init (grideye2_t *ctx, grideye2_cfg_t *cfg)
 Grid-EYE 2 initialization function. More...
 
err_t grideye2_default_cfg (grideye2_t *ctx)
 Grid-EYE 2 default configuration function. More...
 
err_t grideye2_write_reg_bytes (grideye2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 Grid-EYE 2 write reg bytes function. More...
 
err_t grideye2_write_reg_byte (grideye2_t *ctx, uint8_t reg, uint8_t data_in)
 Grid-EYE 2 write reg byte function. More...
 
err_t grideye2_write_reg_word (grideye2_t *ctx, uint8_t reg, uint16_t data_in)
 Grid-EYE 2 write reg word function. More...
 
err_t grideye2_read_reg_bytes (grideye2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 Grid-EYE 2 read reg bytes function. More...
 
err_t grideye2_read_reg_byte (grideye2_t *ctx, uint8_t reg, uint8_t *data_out)
 Grid-EYE 2 read reg byte function. More...
 
err_t grideye2_read_reg_word (grideye2_t *ctx, uint8_t reg, uint16_t *data_out)
 Grid-EYE 2 read reg word function. More...
 
uint8_t grideye2_get_int_pin (grideye2_t *ctx)
 Grid-EYE 2 get INT pin function. More...
 
err_t grideye2_read_grid (grideye2_t *ctx)
 Grid-EYE 2 read grid function. More...
 
err_t grideye2_clear_status (grideye2_t *ctx)
 Grid-EYE 2 clear status function. More...
 

Detailed Description

API for configuring and manipulating Grid-EYE 2 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ grideye2_cfg_setup()

void grideye2_cfg_setup ( grideye2_cfg_t cfg)

Grid-EYE 2 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See grideye2_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ grideye2_clear_status()

err_t grideye2_clear_status ( grideye2_t ctx)

Grid-EYE 2 clear status function.

This function clears the interrupt status flags.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ grideye2_default_cfg()

err_t grideye2_default_cfg ( grideye2_t ctx)

Grid-EYE 2 default configuration function.

This function executes a default configuration of Grid-EYE 2 Click board.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ grideye2_get_int_pin()

uint8_t grideye2_get_int_pin ( grideye2_t ctx)

Grid-EYE 2 get INT pin function.

This function returns the INT pin logic state.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ grideye2_init()

err_t grideye2_init ( grideye2_t ctx,
grideye2_cfg_t cfg 
)

Grid-EYE 2 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters
[out]ctx: Click context object. See grideye2_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See grideye2_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ grideye2_read_grid()

err_t grideye2_read_grid ( grideye2_t ctx)

Grid-EYE 2 read grid function.

This function reads the temperature measurement of an 8x8 pixels grid and stores it in the ctx->grid_temp array.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ grideye2_read_reg_byte()

err_t grideye2_read_reg_byte ( grideye2_t ctx,
uint8_t  reg,
uint8_t *  data_out 
)

Grid-EYE 2 read reg byte function.

This function reads a data byte from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
[in]reg: Register address.
[out]data_out: Output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ grideye2_read_reg_bytes()

err_t grideye2_read_reg_bytes ( grideye2_t ctx,
uint8_t  reg,
uint8_t *  data_out,
uint8_t  len 
)

Grid-EYE 2 read reg bytes function.

This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ grideye2_read_reg_word()

err_t grideye2_read_reg_word ( grideye2_t ctx,
uint8_t  reg,
uint16_t *  data_out 
)

Grid-EYE 2 read reg word function.

This function reads a data word (LSB first) starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: Output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ grideye2_write_reg_byte()

err_t grideye2_write_reg_byte ( grideye2_t ctx,
uint8_t  reg,
uint8_t  data_in 
)

Grid-EYE 2 write reg byte function.

This function writes a data byte to the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
[in]reg: Register address.
[in]data_in: Data to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ grideye2_write_reg_bytes()

err_t grideye2_write_reg_bytes ( grideye2_t ctx,
uint8_t  reg,
uint8_t *  data_in,
uint8_t  len 
)

Grid-EYE 2 write reg bytes function.

This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: Data to be written.
[in]len: Number of bytes to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ grideye2_write_reg_word()

err_t grideye2_write_reg_word ( grideye2_t ctx,
uint8_t  reg,
uint16_t  data_in 
)

Grid-EYE 2 write reg word function.

This function writes a data word (LSB first) starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See grideye2_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: Data word to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.