irgrid3.h File Reference

This file contains API for IR Grid 3 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	irgrid3_params_t
	IR Grid 3 Click params definition. More...
struct	irgrid3_t
	IR Grid 3 Click context object. More...
struct	irgrid3_cfg_t
	IR Grid 3 Click configuration object. More...

Macros
#define	IRGRID3_SET_DEV_ADDR   0x33
	IR Grid 3 device address setting.
#define	IRGRID3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	irgrid3_return_value_t {   IRGRID3_OK = 0 , IRGRID3_ERROR = -1 , IRGRID3_INIT_ERROR = 0xFF , IRGRID3_EEPROM_OK = 0x00 ,   IRGRID3_EEPROM_ERROR = 0xF0 , IRGRID3_ADJ_PIXELS_ERROR = 0xF1 , IRGRID3_ADJ_PIXELS_OK = 0x00 , IRGRID3_BROKEN_PIX_ERROR = 0xF2 ,   IRGRID3_OUTLIER_PIX_ERROR = 0xF3 , IRGRID3_2_PIX_ERROR = 0xF4 }
	IR Grid 3 Click return value data. More...

Functions
void	irgrid3_cfg_setup (irgrid3_cfg_t *cfg)
	IR Grid 3 configuration object setup function.
err_t	irgrid3_init (irgrid3_t *ctx, irgrid3_cfg_t *cfg)
	IR Grid 3 initialization function.
void	irgrid3_default_cfg (irgrid3_t *ctx)
	IR Grid 3 default configuration function.
void	irgrid3_generic_write (irgrid3_t *ctx, uint16_t reg, uint8_t *data_buf, uint16_t len)
	IR Grid 3 I2C writing function.
void	irgrid3_generic_read (irgrid3_t *ctx, uint16_t reg, uint8_t *rx_buf, uint16_t rx_len)
	IR Grid 3 I2C reading function.
void	irgrid3_read_eeprom (irgrid3_t *ctx, uint16_t *eeprom_data)
	Function for reading EEPROM.
uint8_t	irgrid3_extract_parameters (irgrid3_t *ctx, uint16_t *eeprom_data)
	Parameters storage function.
void	irgrid3_set_refresh_rate (irgrid3_t *ctx, uint8_t refresh_rate)
	Function for setting refresh rate.
uint16_t	irgrid3_get_frame_data (irgrid3_t *ctx, uint16_t *frame_data)
	Function for getting frame data.
void	irgrid3_set_resolution (irgrid3_t *ctx, uint8_t resolution)
	Function for setting resolution.
uint16_t	irgrid3_get_current_res (irgrid3_t *ctx)
	Function for getting current resolution.
uint16_t	irgrid3_get_refresh_rate (irgrid3_t *ctx)
	Function for getting current refresh Rate.
void	irgrid3_set_interleaved_mode (irgrid3_t *ctx)
	Function for setting interleaved mode.
void	irgrid3_set_chess_mode (irgrid3_t *ctx)
	Function for setting chess mode.
uint16_t	irgrid3_get_current_mode (irgrid3_t *ctx)
	Function for getting current mode.
void	irgrid3_get_pixel_temperature (irgrid3_t *ctx, float *temp_ambient, float *pixel_temp)
	Function for getting pixels temperature.
float	irgrid3_get_temp_ambient (irgrid3_t *ctx, uint16_t *frame_data)
	Function for getting Ambient temperature.
uint16_t	irgrid3_get_subpage_number (uint16_t *frame_data)
	Function for getting sub page number.
float	irgrid3_get_vdd (irgrid3_t *ctx, uint16_t *frame_data)
	Function for getting Vdd.
void	irgrid3_calculate_temp_obj (irgrid3_t *ctx, uint16_t *frame_data, float tr_data, float *px_matrix)
	Function for calculating temperature objects.
void	irgrid3_get_image (irgrid3_t *ctx, uint16_t *frame_data, float *px_matrix)
	Function for getting Image.

Detailed Description

This file contains API for IR Grid 3 Click Driver.

Enumeration Type Documentation

irgrid3_return_value_t

enum irgrid3_return_value_t

IR Grid 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
IRGRID3_OK
IRGRID3_ERROR
IRGRID3_INIT_ERROR
IRGRID3_EEPROM_OK
IRGRID3_EEPROM_ERROR
IRGRID3_ADJ_PIXELS_ERROR
IRGRID3_ADJ_PIXELS_OK
IRGRID3_BROKEN_PIX_ERROR
IRGRID3_OUTLIER_PIX_ERROR
IRGRID3_2_PIX_ERROR