irsense5  2.1.0.0
Data Structures | Macros | Enumerations | Functions
irsense5.h File Reference

This file contains API for IR Sense 5 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  irsense5_t
 IR Sense 5 Click context object. More...
 
struct  irsense5_cfg_t
 IR Sense 5 Click configuration object. More...
 

Macros

#define IRSENSE5_ROOM_TEMP_IN_K   298.15f
 IR Sense 5 temperature calculation data values. More...
 
#define IRSENSE5_THERMISOR_BETA   3960.00f
 
#define IRSENSE5_INVERTED_VALUE   1.0f
 
#define IRSENSE5_TEMP_K_TO_C   273.15f
 
#define IRSENSE5_VREF_GAIN_X10   10.0f
 
#define IRSENSE5_LIN_FUN_MULT   10.121f
 
#define IRSENSE5_LIN_FUN_ADD   18.818f
 
#define IRSENSE5_ADC_RESOLUTION   0x0FFF
 IR Sense 5 ADC setting. More...
 
#define IRSENSE5_VREF_3V3   3.3
 
#define IRSENSE5_VREF_5V   5.0
 
#define IRSENSE5_SET_DEV_ADDR   0x4D
 IR Sense 5 device address setting. More...
 
#define IRSENSE5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  irsense5_return_value_t { IRSENSE5_OK = 0, IRSENSE5_ERROR = -1 }
 IR Sense 5 Click return value data. More...
 

Functions

void irsense5_cfg_setup (irsense5_cfg_t *cfg)
 IR Sense 5 configuration object setup function. More...
 
err_t irsense5_init (irsense5_t *ctx, irsense5_cfg_t *cfg)
 IR Sense 5 initialization function. More...
 
err_t irsense5_read_raw_adc_thermopile (irsense5_t *ctx, uint16_t *raw_adc)
 IR Sense 5 read thermopile raw ADC value function. More...
 
err_t irsense5_read_raw_adc_thermistor (irsense5_t *ctx, uint16_t *raw_adc)
 IR Sense 5 read thermistor raw ADC value function. More...
 
err_t irsense5_read_vtg_thp (irsense5_t *ctx, float *voltage)
 IR Sense 5 read thermopile voltage level function. More...
 
err_t irsense5_read_vtg_thm (irsense5_t *ctx, float *voltage)
 IR Sense 5 read thermistor voltage level function. More...
 
err_t irsense5_set_vref (irsense5_t *ctx, float vref)
 IR Sense 5 set vref function. More...
 
err_t irsense5_get_amb_temp (irsense5_t *ctx, float *amb_temp)
 IR Sense 5 get ambient temperature function. More...
 
err_t irsense5_get_obj_temp (irsense5_t *ctx, float *obj_temp)
 IR Sense 5 get object temperature function. More...
 

Detailed Description

This file contains API for IR Sense 5 Click Driver.

Enumeration Type Documentation

◆ irsense5_return_value_t

IR Sense 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
IRSENSE5_OK 
IRSENSE5_ERROR