Temperature measurement instrument API functions.

The temperature measurement instrument API library functions. More...

Typedefs
typedef void(*	_callback_temp_meas) (int status, float temp)
	Temperature measurement API callback function type definition. More...

Functions
TEMP_MEAS_API int	temp_meas_api_dbg_init (_dbg_params *dbg_params_t)
	Temperature measurement instrument debug session initialize. More...
TEMP_MEAS_API int	temp_meas_api_dbg_close (void)
	Temperature measurement instrument debug session close. More...
TEMP_MEAS_API int	temp_meas_api_init (const char *iface, _callback_temp_meas callback_temp_meas)
	Temperature measurement instrument initialize function. More...
TEMP_MEAS_API int	temp_meas_api_close (void)
	Temperature measurement instrument close function and free allocated resources. More...
TEMP_MEAS_API int	temp_meas_api_measure (void)
	Perform a temperature measurement and return the result with callbacks. More...

Detailed Description

The temperature measurement instrument API library functions.

Typedef Documentation

_callback_temp_meas

typedef void(* _callback_temp_meas) (int status, float temp)

Temperature measurement API callback function type definition.

Parameters

[in]	status	The measurement status taken from _TEMP_MEAS_API_STATUS_CODES.
[in]	temp	Float temperature value returned when _TEMP_MEAS_API_STATUS_CODES TEMP_MEAS_API_READ_OK callback is send to the upper layer software.

Definition at line 139 of file temp_meas_api.h.

Function Documentation

temp_meas_api_close()

TEMP_MEAS_API int temp_meas_api_close

(

void

)

Temperature measurement instrument close function and free allocated resources.

Returns

TEMP_MEAS_API_STATUS_CODES.

temp_meas_api_dbg_close()

TEMP_MEAS_API int temp_meas_api_dbg_close

(

void

)

Temperature measurement instrument debug session close.

Returns

TEMP_MEAS_API_STATUS_CODES.

temp_meas_api_dbg_init()

TEMP_MEAS_API int temp_meas_api_dbg_init

(

_dbg_params *

dbg_params_t

)

Temperature measurement instrument debug session initialize.

Parameters

[in]

dbg_params_t

A pointer to the a __dbg_params.

Returns

TEMP_MEAS_API_STATUS_CODES.

temp_meas_api_init()

TEMP_MEAS_API int temp_meas_api_init	(	const char *	iface,
		_callback_temp_meas	callback_temp_meas
	)

Temperature measurement instrument initialize function.

Parameters

[in]	iface	A string to define the instrument interface, e.g. "COM15".
[in]	callback_temp_meas	A callback function, with _callback_temp_meas type, called whenever the temperature measurement is ready.

Returns

TEMP_MEAS_API_STATUS_CODES.

temp_meas_api_measure()

TEMP_MEAS_API int temp_meas_api_measure

(

void

)

Perform a temperature measurement and return the result with callbacks.

Returns

TEMP_MEAS_API_STATUS_CODES.