API for configuring and manipulating Thermo 29 Click driver. More...

Topics
	Thermo 29 Registers List
	List of registers of Thermo 29 Click driver.

	Thermo 29 Registers Settings
	Settings for registers of Thermo 29 Click driver.

	Thermo 29 MikroBUS Map
	MikroBUS pin mapping of Thermo 29 Click driver.

Functions
void	thermo29_cfg_setup (thermo29_cfg_t *cfg)
	Thermo 29 configuration object setup function.

err_t	thermo29_init (thermo29_t ctx, thermo29_cfg_t cfg)
	Thermo 29 initialization function.

err_t	thermo29_default_cfg (thermo29_t *ctx)
	Thermo 29 default configuration function.

err_t	thermo29_write_register (thermo29_t *ctx, uint8_t reg, uint16_t data_in)
	Thermo 29 write register function.

err_t	thermo29_read_register (thermo29_t ctx, uint8_t reg, uint16_t data_out)
	Thermo 29 read register function.

err_t	thermo29_write_registers (thermo29_t ctx, uint8_t reg, uint16_t data_in, uint8_t len)
	Thermo 29 write registers function.

err_t	thermo29_read_registers (thermo29_t ctx, uint8_t reg, uint16_t data_out, uint8_t len)
	Thermo 29 read registers function.

uint8_t	thermo29_get_alert_pin (thermo29_t *ctx)
	Thermo 29 get alert pin function.

void	thermo29_enable_crc (thermo29_t *ctx)
	Thermo 29 enable crc function.

void	thermo29_disable_crc (thermo29_t *ctx)
	Thermo 29 disable crc function.

err_t	thermo29_check_communication (thermo29_t *ctx)
	Thermo 29 check communication function.

err_t	thermo29_read_unique_id (thermo29_t ctx, uint16_t unique_id)
	Thermo 29 read unique id function.

err_t	thermo29_read_temperature (thermo29_t ctx, float temperature)
	Thermo 29 read temperature function.

err_t	thermo29_clear_alert_status (thermo29_t *ctx)
	Thermo 29 clear alert status function.

Detailed Description

API for configuring and manipulating Thermo 29 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

◆ thermo29_cfg_setup()

void thermo29_cfg_setup ( thermo29_cfg_t * cfg )

Thermo 29 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See thermo29_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ thermo29_check_communication()

err_t thermo29_check_communication ( thermo29_t * ctx )

Thermo 29 check communication function.

This function checks the communication by reading and verifying the device ID.

Parameters

[in] ctx : Click context object. See thermo29_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ thermo29_clear_alert_status()

err_t thermo29_clear_alert_status ( thermo29_t * ctx )

Thermo 29 clear alert status function.

This function clears the alert status register.

Parameters

[in] ctx : Click context object. See thermo29_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ thermo29_default_cfg()

err_t thermo29_default_cfg ( thermo29_t * ctx )

Thermo 29 default configuration function.

This function executes a default configuration of Thermo 29 click board.

Parameters

[in] ctx : Click context object. See thermo29_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ thermo29_disable_crc()

void thermo29_disable_crc ( thermo29_t * ctx )

Thermo 29 disable crc function.

This function disables CRC for writing and reading transactions.

Parameters

[in] ctx : Click context object. See thermo29_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ thermo29_enable_crc()

void thermo29_enable_crc ( thermo29_t * ctx )

Thermo 29 enable crc function.

This function enables CRC for writing and reading transactions.

Parameters

[in] ctx : Click context object. See thermo29_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ thermo29_get_alert_pin()

uint8_t thermo29_get_alert_pin ( thermo29_t * ctx )

Thermo 29 get alert pin function.

This function returns the alert pin logic state.

Parameters

[in] ctx : Click context object. See thermo29_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ thermo29_init()

err_t thermo29_init	(	thermo29_t *	ctx,
		thermo29_cfg_t *	cfg )

Thermo 29 initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ thermo29_read_register()

err_t thermo29_read_register	(	thermo29_t *	ctx,
		uint8_t	reg,
		uint16_t *	data_out )

Thermo 29 read register function.

This function reads data from the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See thermo29_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ thermo29_read_registers()

err_t thermo29_read_registers	(	thermo29_t *	ctx,
		uint8_t	reg,
		uint16_t *	data_out,
		uint8_t	len )

Thermo 29 read registers function.

This function reads a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See thermo29_t object definition for detailed explanation.
[in]	reg	: Start register address.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read ( up to 10 bytes ).

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ thermo29_read_temperature()

err_t thermo29_read_temperature	(	thermo29_t *	ctx,
		float *	temperature )

Thermo 29 read temperature function.

This function reads the temperature measurement in degrees Celsius.

Parameters

[in]	ctx	: Click context object. See thermo29_t object definition for detailed explanation.
[out]	temperature	: Temperature in degrees Celsius.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ thermo29_read_unique_id()

err_t thermo29_read_unique_id	(	thermo29_t *	ctx,
		uint16_t *	unique_id )

Thermo 29 read unique id function.

This function reads the device unique ID words (6 bytes in total).

Parameters

[in]	ctx	: Click context object. See thermo29_t object definition for detailed explanation.
[out]	unique_id	: Device unique ID words ( 3 x 16-bit data ).

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ thermo29_write_register()

err_t thermo29_write_register	(	thermo29_t *	ctx,
		uint8_t	reg,
		uint16_t	data_in )

Thermo 29 write register function.

This function writes data to the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See thermo29_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ thermo29_write_registers()

err_t thermo29_write_registers	(	thermo29_t *	ctx,
		uint8_t	reg,
		uint16_t *	data_in,
		uint8_t	len )

Thermo 29 write registers function.

This function writes a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See thermo29_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written ( up to 10 bytes ).

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ thermo29_cfg_setup()

◆ thermo29_check_communication()

◆ thermo29_clear_alert_status()

◆ thermo29_default_cfg()

◆ thermo29_disable_crc()

◆ thermo29_enable_crc()

◆ thermo29_get_alert_pin()

◆ thermo29_init()

◆ thermo29_read_register()

◆ thermo29_read_registers()

◆ thermo29_read_temperature()

◆ thermo29_read_unique_id()

◆ thermo29_write_register()

◆ thermo29_write_registers()