irgrid4  2.1.0.0
Modules | Functions
IR Grid 4 Click Driver

API for configuring and manipulating IR Grid 4 Click driver. More...

Modules

 IR Grid 4 Registers List
 List of registers of IR Grid 4 Click driver.
 
 IR Grid 4 Registers Settings
 Settings for registers of IR Grid 4 Click driver.
 
 IR Grid 4 MikroBUS Map
 MikroBUS pin mapping of IR Grid 4 Click driver.
 

Functions

void irgrid4_cfg_setup (irgrid4_cfg_t *cfg)
 IR Grid 4 configuration object setup function. More...
 
err_t irgrid4_init (irgrid4_t *ctx, irgrid4_cfg_t *cfg)
 IR Grid 4 initialization function. More...
 
err_t irgrid4_default_cfg (irgrid4_t *ctx)
 IR Grid 4 default configuration function. More...
 
err_t irgrid4_write_data (irgrid4_t *ctx, uint16_t addr, uint16_t data_in)
 IR Grid 4 write data function. More...
 
err_t irgrid4_read_data (irgrid4_t *ctx, uint16_t addr, uint16_t *data_out, uint8_t len)
 IR Grid 4 read data function. More...
 
err_t irgrid4_general_reset (irgrid4_t *ctx)
 IR Grid 4 general reset function. More...
 
void irgrid4_enable_led1 (irgrid4_t *ctx)
 IR Grid 4 enable LED1 function. More...
 
void irgrid4_disable_led1 (irgrid4_t *ctx)
 IR Grid 4 disable LED1 function. More...
 
void irgrid4_enable_led2 (irgrid4_t *ctx)
 IR Grid 4 enable LED2 function. More...
 
void irgrid4_disable_led2 (irgrid4_t *ctx)
 IR Grid 4 disable LED2 function. More...
 
err_t irgrid4_dump_eeprom (irgrid4_t *ctx)
 IR Grid 4 dump EEPROM function. More...
 
err_t irgrid4_sync_frame (irgrid4_t *ctx)
 IR Grid 4 sync frame function. More...
 
err_t irgrid4_trigger_measurement (irgrid4_t *ctx)
 IR Grid 4 trigger measurement function. More...
 
err_t irgrid4_get_frame_data (irgrid4_t *ctx, uint16_t *frame_data)
 IR Grid 4 get frame data function. More...
 
err_t irgrid4_get_parameters (irgrid4_t *ctx)
 IR Grid 4 get parameters function. More...
 
float irgrid4_get_vdd (irgrid4_t *ctx, uint16_t *frame_data)
 IR Grid 4 get VDD function. More...
 
float irgrid4_get_ta (irgrid4_t *ctx, uint16_t *frame_data)
 IR Grid 4 get TA function. More...
 
void irgrid4_get_to (irgrid4_t *ctx, uint16_t *frame_data, float tr_val, float *result)
 IR Grid 4 get TO function. More...
 
err_t irgrid4_set_resolution (irgrid4_t *ctx, uint8_t resolution)
 IR Grid 4 set resolution function. More...
 
err_t irgrid4_get_resolution (irgrid4_t *ctx, uint8_t *resolution)
 IR Grid 4 get resolution function. More...
 
err_t irgrid4_set_refresh_rate (irgrid4_t *ctx, uint8_t refresh_rate)
 IR Grid 4 set refresh rate function. More...
 
err_t irgrid4_get_refresh_rate (irgrid4_t *ctx, uint8_t *refresh_rate)
 IR Grid 4 get refresh rate function. More...
 
err_t irgrid4_get_measurement (irgrid4_t *ctx, float *t_amb, float *t_obj)
 IR Grid 4 get measurement function. More...
 

Detailed Description

API for configuring and manipulating IR Grid 4 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

◆ irgrid4_cfg_setup()

void irgrid4_cfg_setup ( irgrid4_cfg_t cfg)

IR Grid 4 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ irgrid4_default_cfg()

err_t irgrid4_default_cfg ( irgrid4_t ctx)

IR Grid 4 default configuration function.

This function executes a default configuration of IR Grid 4 Click board.

Parameters
[in]ctx: Click context object. See irgrid4_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.

◆ irgrid4_disable_led1()

void irgrid4_disable_led1 ( irgrid4_t ctx)

IR Grid 4 disable LED1 function.

This function disables the LED1.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ irgrid4_disable_led2()

void irgrid4_disable_led2 ( irgrid4_t ctx)

IR Grid 4 disable LED2 function.

This function disables the LED2.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ irgrid4_dump_eeprom()

err_t irgrid4_dump_eeprom ( irgrid4_t ctx)

IR Grid 4 dump EEPROM function.

This function reads the entire EEPROM memory and stores it in ctx->eeprom.

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

◆ irgrid4_enable_led1()

void irgrid4_enable_led1 ( irgrid4_t ctx)

IR Grid 4 enable LED1 function.

This function enables the LED1.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ irgrid4_enable_led2()

void irgrid4_enable_led2 ( irgrid4_t ctx)

IR Grid 4 enable LED2 function.

This function enables the LED2.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ irgrid4_general_reset()

err_t irgrid4_general_reset ( irgrid4_t ctx)

IR Grid 4 general reset function.

This function performs the device general reset.

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

◆ irgrid4_get_frame_data()

err_t irgrid4_get_frame_data ( irgrid4_t ctx,
uint16_t *  frame_data 
)

IR Grid 4 get frame data function.

This function reads and validates RAM data frame.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[out]frame_data: RAM data frame read [242 words in total].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irgrid4_get_measurement()

err_t irgrid4_get_measurement ( irgrid4_t ctx,
float *  t_amb,
float *  t_obj 
)

IR Grid 4 get measurement function.

This function reads the RAM frame data and calculates ambient temperature and a 16x12 IR grid object temperature.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[out]t_amb: Ambient temperature in degrees Celsius.
[out]t_obj: 16x12 IR Grid object temperature in degrees Celsius [array of 192 float].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irgrid4_get_parameters()

err_t irgrid4_get_parameters ( irgrid4_t ctx)

IR Grid 4 get parameters function.

This function validates EEPROM data and extracts calibration parameters from it.

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

◆ irgrid4_get_refresh_rate()

err_t irgrid4_get_refresh_rate ( irgrid4_t ctx,
uint8_t *  refresh_rate 
)

IR Grid 4 get refresh rate function.

This function gets the IR data refresh rate.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[out]refresh_rate: Refresh rate:
  • 0 - 0.5 Hz,
  • 1 - 1 Hz,
  • 2 - 2 Hz,
  • 3 - 4 Hz,
  • 4 - 8 Hz,
  • 5 - 16 Hz,
  • 6 - 32 Hz,
  • 7 - 64 Hz.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irgrid4_get_resolution()

err_t irgrid4_get_resolution ( irgrid4_t ctx,
uint8_t *  resolution 
)

IR Grid 4 get resolution function.

This function gets the ADC measurement data resolution.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[out]resolution: Resolution:
  • 0 - 16 bit,
  • 1 - 17 bit,
  • 2 - 18 bit,
  • 3 - 19 bit.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irgrid4_get_ta()

float irgrid4_get_ta ( irgrid4_t ctx,
uint16_t *  frame_data 
)

IR Grid 4 get TA function.

This function calculates the ambient temperature from data frame buffer.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[in]frame_data: RAM data frame buffer.
Returns
Ambient temperature in degrees Celsius.
Note
None.

◆ irgrid4_get_to()

void irgrid4_get_to ( irgrid4_t ctx,
uint16_t *  frame_data,
float  tr_val,
float *  result 
)

IR Grid 4 get TO function.

This function calculates the 16x12 IR grid object temperature from data frame buffer.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[in]frame_data: RAM data frame buffer.
[in]tr_val: Room temperature in degrees Celsius.
[out]result: Result 16x12 IR Grid object temperature in degrees Celsius.
Returns
None.
Note
None.

◆ irgrid4_get_vdd()

float irgrid4_get_vdd ( irgrid4_t ctx,
uint16_t *  frame_data 
)

IR Grid 4 get VDD function.

This function calculates the VDD system voltage from data frame buffer.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[in]frame_data: RAM data frame buffer.
Returns
VDD system voltage.
Note
None.

◆ irgrid4_init()

err_t irgrid4_init ( irgrid4_t ctx,
irgrid4_cfg_t cfg 
)

IR Grid 4 initialization function.

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

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

◆ irgrid4_read_data()

err_t irgrid4_read_data ( irgrid4_t ctx,
uint16_t  addr,
uint16_t *  data_out,
uint8_t  len 
)

IR Grid 4 read data function.

This function reads a desired number of data words starting from the selected memory address by using I2C serial interface.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[in]addr: 16-bit start memory address.
[out]data_out: Output read data words.
[in]len: Number of words to be read.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irgrid4_set_refresh_rate()

err_t irgrid4_set_refresh_rate ( irgrid4_t ctx,
uint8_t  refresh_rate 
)

IR Grid 4 set refresh rate function.

This function sets the IR data refresh rate.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[in]refresh_rate: Refresh rate:
  • 0 - 0.5 Hz,
  • 1 - 1 Hz,
  • 2 - 2 Hz,
  • 3 - 4 Hz,
  • 4 - 8 Hz,
  • 5 - 16 Hz,
  • 6 - 32 Hz,
  • 7 - 64 Hz.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irgrid4_set_resolution()

err_t irgrid4_set_resolution ( irgrid4_t ctx,
uint8_t  resolution 
)

IR Grid 4 set resolution function.

This function sets the ADC measurement data resolution.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[in]resolution: Resolution:
  • 0 - 16 bit,
  • 1 - 17 bit,
  • 2 - 18 bit,
  • 3 - 19 bit.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irgrid4_sync_frame()

err_t irgrid4_sync_frame ( irgrid4_t ctx)

IR Grid 4 sync frame function.

This function synchronize data frame.

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

◆ irgrid4_trigger_measurement()

err_t irgrid4_trigger_measurement ( irgrid4_t ctx)

IR Grid 4 trigger measurement function.

This function triggers data measurement.

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

◆ irgrid4_write_data()

err_t irgrid4_write_data ( irgrid4_t ctx,
uint16_t  addr,
uint16_t  data_in 
)

IR Grid 4 write data function.

This function writes a desired data word to the selected memory address by using I2C serial interface.

Parameters
[in]ctx: Click context object. See irgrid4_t object definition for detailed explanation.
[in]addr: 16-bit memory address.
[in]data_in: 16-bit data word to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.