irgrid  2.0.0.0
Functions
Public function

Functions

void irgrid_cfg_setup (irgrid_cfg_t *cfg)
 Config Object Initialization function. More...
 
IRGRID_RETVAL irgrid_init (irgrid_t *ctx, irgrid_cfg_t *cfg)
 Initialization function. More...
 
uint8_t irgrid_device_init (irgrid_t *ctx, irgrid_data_t *data_str, uint8_t refrate)
 Device Initialization. More...
 
void irgrid_write_ram (irgrid_t *ctx, uint8_t *data_buf, uint8_t len)
 Write function using RAM slave adress. More...
 
void irgrid_read_ram (irgrid_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len)
 Read function using RAM slave adress. More...
 
void irgrid_write_eeprom (irgrid_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Write function using EEPROM slave adress. More...
 
void irgrid_read_eeprom (irgrid_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Read function using EEPROM slave adress. More...
 
uint8_t irgrid_measure (irgrid_t *ctx, irgrid_data_t *data_str)
 Measurement. More...
 
void irgrid_get_ir_raw (irgrid_data_t *data_str, int16_t *buffer)
 Read Raw Temperature buffer. More...
 
void irgrid_get_temperature (irgrid_data_t *data_str, float *buffer)
 Read Calculated Temperature buffer. More...
 
float irgrid_get_amb_temperature (irgrid_t *ctx)
 Read Ambient Temperature. More...
 

Detailed Description

Function Documentation

◆ irgrid_cfg_setup()

void irgrid_cfg_setup ( irgrid_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ irgrid_device_init()

uint8_t irgrid_device_init ( irgrid_t ctx,
irgrid_data_t data_str,
uint8_t  refrate 
)

Device Initialization.

Parameters
ctxClick object.
data_strData click object.
refrateRefresh Rate
Returns
0 - OK

Initializes device, reads eeprom memory and places it inside internal buffers.

◆ irgrid_get_amb_temperature()

float irgrid_get_amb_temperature ( irgrid_t ctx)

Read Ambient Temperature.

Parameters
ctxClick object.
Returns
Ambient temperature.

Read Ambient temperautre.

◆ irgrid_get_ir_raw()

void irgrid_get_ir_raw ( irgrid_data_t data_str,
int16_t *  buffer 
)

Read Raw Temperature buffer.

Parameters
data_strData click object.
bufferOutput data buf.

Populates provided buffer with raw measurements. Buffer must have at least 64 members.

◆ irgrid_get_temperature()

void irgrid_get_temperature ( irgrid_data_t data_str,
float *  buffer 
)

Read Calculated Temperature buffer.

Parameters
data_strData click object.
bufferOutput data buf.

Populates provided buffer with calculated temperatures. Buffer must have at least 64 members.

◆ irgrid_init()

IRGRID_RETVAL irgrid_init ( irgrid_t ctx,
irgrid_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ irgrid_measure()

uint8_t irgrid_measure ( irgrid_t ctx,
irgrid_data_t data_str 
)

Measurement.

Parameters
ctxClick object.
data_strData click object.
Returns
0 - OK

Measures temperature and places it inside internal buffers. This function is needed to be called prior to irgrid_get_ir_raw or irgrid_get_temperature.

◆ irgrid_read_eeprom()

void irgrid_read_eeprom ( irgrid_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Read function using EEPROM slave adress.

Parameters
ctxClick object.
regRegister address pointer.
data_bufOutput data buf
lenNumber of the bytes to be read

This function reads data from the desired register.

◆ irgrid_read_ram()

void irgrid_read_ram ( irgrid_t ctx,
uint8_t *  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Read function using RAM slave adress.

Parameters
ctxClick object.
regRegister address pointer.
data_bufOutput data buf
lenNumber of the bytes to be read

This function reads data from the desired register.

◆ irgrid_write_eeprom()

void irgrid_write_eeprom ( irgrid_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Write function using EEPROM slave adress.

Parameters
ctxData click object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

This function writes data to the desired register.

◆ irgrid_write_ram()

void irgrid_write_ram ( irgrid_t ctx,
uint8_t *  data_buf,
uint8_t  len 
)

Write function using RAM slave adress.

Parameters
ctxData click object.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

This function writes data to the desired register.