IrThermo 3V3 Click Driver

API for configuring and manipulating IrThermo 3V3 Click driver. More...

Topics
	IrThermo 3V3 Registers Settings
	Settings for registers of IrThermo 3V3 Click driver.
	IrThermo 3V3 MikroBUS Map
	MikroBUS pin mapping of IrThermo 3V3 Click driver.

Functions
void	irthermo3v3_cfg_setup (irthermo3v3_cfg_t *cfg)
	IrThermo 3V3 configuration object setup function.
err_t	irthermo3v3_init (irthermo3v3_t *ctx, irthermo3v3_cfg_t *cfg)
	IrThermo 3V3 initialization function.
float	irthermo3v3_get_t_ambient (irthermo3v3_t *ctx)
	Reads Temperature ambient from sensor.
float	irthermo3v3_get_t_object (irthermo3v3_t *ctx)
	Reads Temperature object1 from sensor.
uint16_t	irthermo3v3_read_reg (irthermo3v3_t *ctx, uint8_t address)
	Generic function for reading values from RAM.

Detailed Description

API for configuring and manipulating IrThermo 3V3 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

irthermo3v3_cfg_setup()

void irthermo3v3_cfg_setup

(

irthermo3v3_cfg_t *

cfg

)

IrThermo 3V3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See irthermo3v3_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

irthermo3v3_get_t_ambient()

float irthermo3v3_get_t_ambient

(

irthermo3v3_t *

ctx

)

Reads Temperature ambient from sensor.

Function returns ambient temperature value in Celsius.

Parameters

[in]

ctx

: Click context object. See irthermo3v3_t object definition for detailed explanation.

Returns

Ambient temperature value in Celsius.

Note

None.

irthermo3v3_get_t_object()

float irthermo3v3_get_t_object

(

irthermo3v3_t *

ctx

)

Reads Temperature object1 from sensor.

Function returns object temperature value in Celsius.

Parameters

[in]

ctx

: Click context object. See irthermo3v3_t object definition for detailed explanation.

Returns

Object temperature value in Celsius.

Note

None.

irthermo3v3_init()

err_t irthermo3v3_init	(	irthermo3v3_t *	ctx,
		irthermo3v3_cfg_t *	cfg )

IrThermo 3V3 initialization function.

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

Parameters

[out]	ctx	: Click context object. See irthermo3v3_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See irthermo3v3_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

irthermo3v3_read_reg()

uint16_t irthermo3v3_read_reg	(	irthermo3v3_t *	ctx,
		uint8_t	address )

Generic function for reading values from RAM.

Function returns 16bit value of register.

Parameters

[in]	ctx	: Click context object. See irthermo3v3_t object definition for detailed explanation.
[in]	address	: Address of register

Returns

16bit value of register.

Note

None.