irgrid 2.0.0.0
irgrid.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  irgrid_t
 IR Grid Click context object. More...
 
struct  irgrid_cfg_t
 IR Grid Click configuration object. More...
 
struct  irgrid_data_t
 Click data object definition. More...
 

Macros

#define IRGRID_CAL_ACOMMON_L   0xD0
 IR Grid description register.
 
#define IRGRID_CAL_ACOMMON_H   0xD1
 
#define IRGRID_CAL_ACP_L   0xD3
 
#define IRGRID_CAL_ACP_H   0xD4
 
#define IRGRID_CAL_BCP   0xD5
 
#define IRGRID_CAL_ALPHA_CP_L   0xD6
 
#define IRGRID_CAL_ALPHA_CP_H   0xD7
 
#define IRGRID_CAL_TGC   0xD8
 
#define IRGRID_CAL_AI_SCALE   0xD9
 
#define IRGRID_CAL_BI_SCALE   0xD9
 
#define IRGRID_VTH_L   0xDA
 
#define IRGRID_VTH_H   0xDB
 
#define IRGRID_KT1_L   0xDC
 
#define IRGRID_KT1_H   0xDD
 
#define IRGRID_KT2_L   0xDE
 
#define IRGRID_KT2_H   0xDF
 
#define IRGRID_KT_SCALE   0xD2
 
#define IRGRID_CAL_A0_L   0xE0
 
#define IRGRID_CAL_A0_H   0xE1
 
#define IRGRID_CAL_A0_SCALE   0xE2
 
#define IRGRID_CAL_DELTA_A_SCALE   0xE3
 
#define IRGRID_CAL_EMIS_L   0xE4
 
#define IRGRID_CAL_EMIS_H   0xE5
 
#define IRGRID_OSC_TRIM_VALUE   0xF7
 
#define IRGRID_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  irgrid_return_value_t { IRGRID_OK = 0 , IRGRID_ERROR = -1 }
 IR Grid Click return value data. More...
 

Functions

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

Detailed Description

This file contains API for IR Grid Click Driver.

Enumeration Type Documentation

◆ irgrid_return_value_t

IR Grid Click return value data.

Predefined enum values for driver return values.

Enumerator
IRGRID_OK 
IRGRID_ERROR