irsense5  2.1.0.0
Modules | Functions
IR Sense 5 Click Driver

API for configuring and manipulating IR Sense 5 Click driver. More...

Modules

 IR Sense 5 Registers List
 List of registers of IR Sense 5 Click driver.
 
 IR Sense 5 Registers Settings
 Settings for registers of IR Sense 5 Click driver.
 
 IR Sense 5 MikroBUS Map
 MikroBUS pin mapping of IR Sense 5 Click driver.
 

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_thp (irsense5_t *ctx, uint16_t *raw_adc)
 IR Sense 5 read thermopile raw ADC value function. More...
 
err_t irsense5_read_raw_adc_thm (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

API for configuring and manipulating IR Sense 5 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

◆ irsense5_cfg_setup()

void irsense5_cfg_setup ( irsense5_cfg_t cfg)

IR Sense 5 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ irsense5_get_amb_temp()

err_t irsense5_get_amb_temp ( irsense5_t ctx,
float *  amb_temp 
)

IR Sense 5 get ambient temperature function.

This function reads and calculate ambient temperature in degree Celsius [degC].

Parameters
[in]ctx: Click context object. See irsense5_t object definition for detailed explanation.
[out]amb_temp: Ambient temperature [degC].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irsense5_get_obj_temp()

err_t irsense5_get_obj_temp ( irsense5_t ctx,
float *  obj_temp 
)

IR Sense 5 get object temperature function.

This function reads and calculate object temperature in degree Celsius [degC].

Parameters
[in]ctx: Click context object. See irsense5_t object definition for detailed explanation.
[out]obj_temp: Object temperature [degC].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irsense5_init()

err_t irsense5_init ( irsense5_t ctx,
irsense5_cfg_t cfg 
)

IR Sense 5 initialization function.

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

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

◆ irsense5_read_raw_adc_thm()

err_t irsense5_read_raw_adc_thm ( irsense5_t ctx,
uint16_t *  raw_adc 
)

IR Sense 5 read thermistor raw ADC value function.

This function reads the thermistor raw ADC value.

Parameters
[in]ctx: Click context object. See irsense5_t object definition for detailed explanation.
[out]raw_adc: Thermistor ADC result.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irsense5_read_raw_adc_thp()

err_t irsense5_read_raw_adc_thp ( irsense5_t ctx,
uint16_t *  raw_adc 
)

IR Sense 5 read thermopile raw ADC value function.

This function reads the thermopile raw ADC value.

Parameters
[in]ctx: Click context object. See irsense5_t object definition for detailed explanation.
[out]raw_adc: Thermopile ADC result.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ irsense5_read_vtg_thm()

err_t irsense5_read_vtg_thm ( irsense5_t ctx,
float *  voltage 
)

IR Sense 5 read thermistor voltage level function.

This function reads raw ADC value and converts it to proportional thermistor voltage level.

Parameters
[in]ctx: Click context object. See irsense5_t object definition for detailed explanation.
[out]voltage: Thermistor voltage level [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered reference voltage.

◆ irsense5_read_vtg_thp()

err_t irsense5_read_vtg_thp ( irsense5_t ctx,
float *  voltage 
)

IR Sense 5 read thermopile voltage level function.

This function reads raw ADC value and converts it to proportional thermopile voltage level.

Parameters
[in]ctx: Click context object. See irsense5_t object definition for detailed explanation.
[out]voltage: Thermopile voltage level [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered reference voltage.

◆ irsense5_set_vref()

err_t irsense5_set_vref ( irsense5_t ctx,
float  vref 
)

IR Sense 5 set vref function.

This function sets the voltage reference for IR Sense 5 Click driver.

Parameters
[in]ctx: Click context object. See irsense5_t object definition for detailed explanation.
[in]vref: Reference voltage (volts).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
The default voltage reference set with irsense5_init is 3.3V.