Public function

Functions
void	thermoj_cfg_setup (thermoj_cfg_t *cfg)
	Config Object Initialization function.
THERMOJ_RETVAL	thermoj_init (thermoj_t *ctx, thermoj_cfg_t *cfg)
	Initialization function.
void	thermoj_generic_write (thermoj_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	thermoj_generic_read (thermoj_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
void	thermoj_write_byte (thermoj_t *ctx, uint8_t reg_address, uint8_t write_data)
	Write the byte of data function.
uint8_t	thermoj_read_byte (thermoj_t *ctx, uint8_t reg_address)
	Read the byte of data function.
uint8_t	thermoj_get_status (thermoj_t *ctx)
	Get the status function.
uint8_t	thermoj_check_burst_complete (thermoj_t *ctx)
	Check the status of burst complete function.
uint8_t	thermoj_check_data_ready (thermoj_t *ctx)
	Check the status of data ready function.
uint8_t	thermoj_check_over_voltage (thermoj_t *ctx)
	Check the status of over voltage function.
void	thermoj_check_alert_status (thermoj_t *ctx, uint8_t *alert_1, uint8_t *alert_2, uint8_t *alert_3, uint8_t *alert_4)
	Write the byte of data function.
void	thermoj_set_sensor_config (thermoj_t *ctx, uint8_t config_val)
	Set sensor configuration function.
void	thermoj_set_thermocouple_type (thermoj_t *ctx, uint8_t thermocouple_type)
	Set thermocouple type sensor configuration function.
void	thermoj_set_filter_coefficient (thermoj_t *ctx, uint8_t filter_coeff)
	Set filter coefficient sensor configuration function.
uint8_t	thermoj_get_sensor_config (thermoj_t *ctx)
	Get sensor configuration function.
void	thermoj_set_config (thermoj_t *ctx, uint8_t config_val)
	Set configuration function.
void	thermoj_set_cold_junction_resolution (thermoj_t *ctx, uint8_t cj_res)
	Set cold-junction resolution function.
void	thermoj_set_adc_resolution (thermoj_t *ctx, uint8_t adc_res)
	Set ADC measurement resolution function.
void	thermoj_set_number_of_temperature_samples (thermoj_t *ctx, uint8_t num_temp_samp)
	Set number of temperature samples function.
void	thermoj_set_shutdown_modes (thermoj_t *ctx, uint8_t sd_mod)
	Set shutdown modes function.
void	thermoj_write_data (thermoj_t *ctx, uint8_t reg_address, uint16_t write_data)
	Write data function.
uint16_t	thermoj_read_data (thermoj_t *ctx, uint8_t reg_address)
	Read data function.
uint8_t	thermoj_get_device_id (thermoj_t *ctx)
	Get the device ID function.
float	thermoj_get_temperature (thermoj_t *ctx)
	Get temperature function.
float	thermoj_get_temperature_fahrenheit (thermoj_t *ctx)
	Get temperature ( Fahrenheit ) function.
uint8_t	thermoj_get_alert_1 (thermoj_t *ctx)
	Get temperature alert 1 function.
uint8_t	thermoj_get_alert_2 (thermoj_t *ctx)
	Get temperature alert 2 function.
uint8_t	thermoj_get_alert_3 (thermoj_t *ctx)
	Get temperature alert 3 function.
uint8_t	thermoj_get_alert_4 (thermoj_t *ctx)
	Get temperature alert 4 function.
void	thermoj_set_alerts_limits (thermoj_t *ctx, uint8_t pos_alert, float temp_alert_limit)
	Set temperature alert limits function.
void	thermoj_set_alert_config (thermoj_t *ctx, uint8_t pos_alert, uint8_t alert_config)
	Set alert configuration function.
void	thermoj_enable_alert (thermoj_t *ctx, uint8_t pos_alert)
	Enable alerts function.
void	thermoj_disable_alert (thermoj_t *ctx, uint8_t pos_alert)
	Disable alerts function.

Detailed Description

Function Documentation

thermoj_cfg_setup()

void thermoj_cfg_setup

(

thermoj_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

thermoj_check_alert_status()

void thermoj_check_alert_status	(	thermoj_t *	ctx,
		uint8_t *	alert_1,
		uint8_t *	alert_2,
		uint8_t *	alert_3,
		uint8_t *	alert_4 )

Write the byte of data function.

Parameters

ctx	Click object.
alert_1	Pointer of alert 1 status.
alert_2	Pointer of alert 2 status.
alert_3	Pointer of alert 3 status.
alert_4	Pointer of alert 4 status.

@description This function check status of alerts from the target status register of MCP9600 sensor on Thermo J click board.

thermoj_check_burst_complete()

uint8_t thermoj_check_burst_complete

(

thermoj_t *

ctx

)

Check the status of burst complete function.

Parameters

ctx	Click object.

@description This function check the status of burst complete data from the target status register of MCP9600 sensor on Thermo J click board.

thermoj_check_data_ready()

uint8_t thermoj_check_data_ready

(

thermoj_t *

ctx

)

Check the status of data ready function.

Parameters

ctx	Click object.

@description This function check the status of data ready data from the target status register of MCP9600 sensor on Thermo J click board.

thermoj_check_over_voltage()

uint8_t thermoj_check_over_voltage

(

thermoj_t *

ctx

)

Check the status of over voltage function.

Parameters

ctx	Click object.

@description This function check the status of data ready data from the target status register of MCP9600 sensor on Thermo J click board.

thermoj_disable_alert()

void thermoj_disable_alert	(	thermoj_t *	ctx,
		uint8_t	pos_alert )

Disable alerts function.

Parameters

ctx	Click object.
pos_alert	Pos alert.

@description This function disable alert by clear alert bits in the target alert 1, 2, 3 or 4 configuration registers address of MCP9600 sensor on Thermo J click board.

thermoj_enable_alert()

void thermoj_enable_alert	(	thermoj_t *	ctx,
		uint8_t	pos_alert )

Enable alerts function.

Parameters

ctx	Click object.
pos_alert	Pos alert.

@description This function enable alert by set alert bits in the target alert 1, 2, 3 or 4 configuration registers address of MCP9600 sensor on Thermo J click board.

thermoj_generic_read()

void thermoj_generic_read	(	thermoj_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Output data buf
len	Number of the bytes to be read

@description This function reads data from the desired register.

thermoj_generic_write()

void thermoj_generic_write	(	thermoj_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function writes data to the desired register.

thermoj_get_alert_1()

uint8_t thermoj_get_alert_1

(

thermoj_t *

ctx

)

Get temperature alert 1 function.

Parameters

ctx	Click object.

@description This function get temperature alert 1 status of INT pin of MCP9600 sensor on Thermo J click board.

thermoj_get_alert_2()

uint8_t thermoj_get_alert_2

(

thermoj_t *

ctx

)

Get temperature alert 2 function.

Parameters

ctx	Click object.

@description This function get temperature alert 2 status of INT pin of MCP9600 sensor on Thermo J click board.

thermoj_get_alert_3()

uint8_t thermoj_get_alert_3

(

thermoj_t *

ctx

)

Get temperature alert 3 function.

Parameters

ctx	Click object.

@description This function get temperature alert 3 status of INT pin of MCP9600 sensor on Thermo J click board.

thermoj_get_alert_4()

uint8_t thermoj_get_alert_4

(

thermoj_t *

ctx

)

Get temperature alert 4 function.

Parameters

ctx	Click object.

@description This function get temperature alert 4 status of INT pin of MCP9600 sensor on Thermo J click board.

thermoj_get_device_id()

uint8_t thermoj_get_device_id

(

thermoj_t *

ctx

)

Get the device ID function.

Parameters

ctx	Click object.

@description This function read the device ID data from the target 8-bit register address of MCP9600 sensor on Thermo J click board.

thermoj_get_sensor_config()

uint8_t thermoj_get_sensor_config

(

thermoj_t *

ctx

)

Get sensor configuration function.

Parameters

ctx	Click object.

@description This function read sensor configuration data from the target sensor configuration register of MCP9600 sensor on Thermo J click board.

thermoj_get_status()

uint8_t thermoj_get_status

(

thermoj_t *

ctx

)

Get the status function.

Parameters

ctx	Click object.

@description This function read the 8-bit status data from the target status register of MCP9600 sensor on Thermo J click board.

thermoj_get_temperature()

float thermoj_get_temperature

(

thermoj_t *

ctx

)

Get temperature function.

Parameters

ctx	Click object.

@description This function get value of temperature [ �C ] from the target temperature register address of MCP9600 sensor on Thermo J click board.

thermoj_get_temperature_fahrenheit()

float thermoj_get_temperature_fahrenheit

(

thermoj_t *

ctx

)

Get temperature ( Fahrenheit ) function.

Parameters

ctx	Click object.

@description This function get value of temperature [ �F ] from the target temperature register address of MCP9600 sensor on Thermo J click board.

thermoj_init()

THERMOJ_RETVAL thermoj_init	(	thermoj_t *	ctx,
		thermoj_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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

thermoj_read_byte()

uint8_t thermoj_read_byte	(	thermoj_t *	ctx,
		uint8_t	reg_address )

Read the byte of data function.

Parameters

ctx	Click object.
reg_address	Register address.

@description This function read the 8-bit of data from the target 8-bit register address of MCP9600 sensor on Thermo J click board.

thermoj_read_data()

uint16_t thermoj_read_data	(	thermoj_t *	ctx,
		uint8_t	reg_address )

Read data function.

Parameters

ctx	Click object.
reg_address	Register address.

@description This function read the 16-bit of data from the target 8-bit register address of MCP9600 sensor on Thermo J click board.

thermoj_set_adc_resolution()

void thermoj_set_adc_resolution	(	thermoj_t *	ctx,
		uint8_t	adc_res )

Set ADC measurement resolution function.

Parameters

ctx	Click object.
adc_res	ADC measurement resolution.

@description This function write ADC measurement resolution data to the target device configuration register of MCP9600 sensor on Thermo J click board.

thermoj_set_alert_config()

void thermoj_set_alert_config	(	thermoj_t *	ctx,
		uint8_t	pos_alert,
		uint8_t	alert_config )

Set alert configuration function.

Parameters

ctx	Click object.
pos_alert	Pos alert.
alert_config	Alert configuration value.

@description This function set temperature alert limits data to the target alert 1, 2, 3 or 4 configuration registers address of MCP9600 sensor on Thermo J click board.

thermoj_set_alerts_limits()

void thermoj_set_alerts_limits	(	thermoj_t *	ctx,
		uint8_t	pos_alert,
		float	temp_alert_limit )

Set temperature alert limits function.

Parameters

ctx	Click object.
pos_alert	Click object.
temp_alert_limit	Click object.

@description This function set temperature alert limits data to the target temperature alert 1, 2, 3 or 4 limits register address of MCP9600 sensor on Thermo J click board.

thermoj_set_cold_junction_resolution()

void thermoj_set_cold_junction_resolution	(	thermoj_t *	ctx,
		uint8_t	cj_res )

Set cold-junction resolution function.

Parameters

ctx	Click object.
cj_res	Cold-junction resolution.

@description This function write cold-junction resolution data to the target device configuration register of MCP9600 sensor on Thermo J click board.

thermoj_set_config()

void thermoj_set_config	(	thermoj_t *	ctx,
		uint8_t	config_val )

Set configuration function.

Parameters

ctx	Click object.
config_val	Config value.

@description This function write configuration data to the target device configuration register of MCP9600 sensor on Thermo J click board.

thermoj_set_filter_coefficient()

void thermoj_set_filter_coefficient	(	thermoj_t *	ctx,
		uint8_t	filter_coeff )

Set filter coefficient sensor configuration function.

Parameters

ctx	Click object.
filter_coeff	Filter coefficient value.

@description This function write filter coefficient sensor configuration data to the target sensor configuration register of MCP9600 sensor on Thermo J click board.

thermoj_set_number_of_temperature_samples()

void thermoj_set_number_of_temperature_samples	(	thermoj_t *	ctx,
		uint8_t	num_temp_samp )

Set number of temperature samples function.

Parameters

ctx	Click object.
num_temp_samp	Number of Temperature Samples.

@description This function write number of temperature samples data to the target device configuration register of MCP9600 sensor on Thermo J click board.

thermoj_set_sensor_config()

void thermoj_set_sensor_config	(	thermoj_t *	ctx,
		uint8_t	config_val )

Set sensor configuration function.

Parameters

ctx	Click object.
config_val	8-bit configuration value.

@description This function write sensor configuration data to the target sensor configuration register of MCP9600 sensor on Thermo J click board.

thermoj_set_shutdown_modes()

void thermoj_set_shutdown_modes	(	thermoj_t *	ctx,
		uint8_t	sd_mod )

Set shutdown modes function.

Parameters

ctx	Click object.
sd_mod	ADC measurement resolution.

@description This function write shutdown modes data to the target device configuration register of MCP9600 sensor on Thermo J click board.

thermoj_set_thermocouple_type()

void thermoj_set_thermocouple_type	(	thermoj_t *	ctx,
		uint8_t	thermocouple_type )

Set thermocouple type sensor configuration function.

Parameters

ctx	Click object.
thermocouple_type	Thermocouple type value.

@description This function write thermocouple type sensor configuration data to the target sensor configuration register of MCP9600 sensor on Thermo J click board.

thermoj_write_byte()

void thermoj_write_byte	(	thermoj_t *	ctx,
		uint8_t	reg_address,
		uint8_t	write_data )

Write the byte of data function.

Parameters

ctx	Click object.
reg_address	Register address.
write_data	Byte of data to write.

@description This function write the 8-bit of data to the target 8-bit register address of MCP9600 sensor on Thermo J click board.

thermoj_write_data()

void thermoj_write_data	(	thermoj_t *	ctx,
		uint8_t	reg_address,
		uint16_t	write_data )

Write data function.

Parameters

ctx	Click object.
reg_address	Register address.
write_data	16-bit data to write.

@description This function write the 16-bit of data to the target 8-bit register address of MCP9600 sensor on Thermo J click board.