Phidget Temperature Sensor
[Specific Phidgets]

Typedefs
typedef struct _CPhidgetTemperatureSensor *	CPhidgetTemperatureSensorHandle
Enumerations
enum	CPhidgetTemperatureSensor_ThermocoupleType { PHIDGET_TEMPERATURE_SENSOR_K_TYPE = 1, PHIDGET_TEMPERATURE_SENSOR_J_TYPE, PHIDGET_TEMPERATURE_SENSOR_E_TYPE, PHIDGET_TEMPERATURE_SENSOR_T_TYPE }
Functions
int	CPhidgetTemperatureSensor_create (CPhidgetTemperatureSensorHandle *phid)
int	CPhidgetTemperatureSensor_getTemperatureInputCount (CPhidgetTemperatureSensorHandle phid, int *count)
int	CPhidgetTemperatureSensor_getTemperature (CPhidgetTemperatureSensorHandle phid, int index, double *temperature)
int	CPhidgetTemperatureSensor_getTemperatureMax (CPhidgetTemperatureSensorHandle phid, int index, double *max)
int	CPhidgetTemperatureSensor_getTemperatureMin (CPhidgetTemperatureSensorHandle phid, int index, double *min)
int	CPhidgetTemperatureSensor_set_OnTemperatureChange_Handler (CPhidgetTemperatureSensorHandle phid, int(*fptr)(CPhidgetTemperatureSensorHandle phid, void *userPtr, int index, double temperature), void *userPtr)
int	CPhidgetTemperatureSensor_getTemperatureChangeTrigger (CPhidgetTemperatureSensorHandle phid, int index, double *trigger)
int	CPhidgetTemperatureSensor_setTemperatureChangeTrigger (CPhidgetTemperatureSensorHandle phid, int index, double trigger)
int	CPhidgetTemperatureSensor_getPotential (CPhidgetTemperatureSensorHandle phid, int index, double *potential)
int	CPhidgetTemperatureSensor_getPotentialMax (CPhidgetTemperatureSensorHandle phid, int index, double *max)
int	CPhidgetTemperatureSensor_getPotentialMin (CPhidgetTemperatureSensorHandle phid, int index, double *min)
int	CPhidgetTemperatureSensor_getAmbientTemperature (CPhidgetTemperatureSensorHandle phid, double *ambient)
int	CPhidgetTemperatureSensor_getAmbientTemperatureMax (CPhidgetTemperatureSensorHandle phid, double *max)
int	CPhidgetTemperatureSensor_getAmbientTemperatureMin (CPhidgetTemperatureSensorHandle phid, double *min)
int	CPhidgetTemperatureSensor_getThermocoupleType (CPhidgetTemperatureSensorHandle phid, int index, CPhidgetTemperatureSensor_ThermocoupleType *type)
int	CPhidgetTemperatureSensor_setThermocoupleType (CPhidgetTemperatureSensorHandle phid, int index, CPhidgetTemperatureSensor_ThermocoupleType type)

---

Detailed Description

These calls are specific to the Phidget Temperature Sensor object. See your device's User Guide for more specific API details, technical information, and revision details. The User Guide, along with other resources, can be found on the product page for your device.

All temperatures are in degrees celcius.

---

Typedef Documentation

typedef struct _CPhidgetTemperatureSensor* CPhidgetTemperatureSensorHandle

A Phidget TemperatureSensor handle

---

Enumeration Type Documentation

enum CPhidgetTemperatureSensor_ThermocoupleType

The Phidget Temperature Sensor supports these types of thermocouples.

Enumerator:

PHIDGET_TEMPERATURE_SENSOR_K_TYPE	K-Type thermocouple
PHIDGET_TEMPERATURE_SENSOR_J_TYPE	J-Type thermocouple
PHIDGET_TEMPERATURE_SENSOR_E_TYPE	E-Type thermocouple
PHIDGET_TEMPERATURE_SENSOR_T_TYPE	T-Type thermocouple

---

Function Documentation

int CPhidgetTemperatureSensor_create

(

CPhidgetTemperatureSensorHandle *

phid

)

Creates a Phidget TemperatureSensor handle.

Parameters:

phid

A pointer to an unallocated Phidget TemperatureSensor handle.

int CPhidgetTemperatureSensor_getTemperatureInputCount	(	CPhidgetTemperatureSensorHandle	phid,
		int *	count
	)

Gets the number of thermocouple inputs supported by this board.

Parameters:

	phid	An attached phidget themperature sensor handle.
	count	The thermocouple input count.

int CPhidgetTemperatureSensor_getTemperature	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		double *	temperature
	)

Gets the temperature measured by a thermocouple input.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	temperature	The temperature.

int CPhidgetTemperatureSensor_getTemperatureMax	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		double *	max
	)

Gets the maximum temperature that can be measured by a thermocouple input. This depends on the type of thermocouple attached, as well as the ambient temperature.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	max	The maximum temperature.

int CPhidgetTemperatureSensor_getTemperatureMin	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		double *	min
	)

Gets the minimum temperature that can be measured by a thermocouple input. This depends on the type of thermocouple attached, as well as the ambient temperature.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	min	The minimum temperature.

int CPhidgetTemperatureSensor_set_OnTemperatureChange_Handler	(	CPhidgetTemperatureSensorHandle	phid,
		int(*)(CPhidgetTemperatureSensorHandle phid, void *userPtr, int index, double temperature)	fptr,
		void *	userPtr
	)

Set a temperature change handler. This is called when the temperature changes by more then the change trigger.

Parameters:

	phid	An attached phidget temperature sensor handle.
	fptr	Callback function pointer.
	userPtr	A pointer for use by the user - this value is passed back into the callback function.

int CPhidgetTemperatureSensor_getTemperatureChangeTrigger	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		double *	trigger
	)

Gets the change trigger for a thermocouple input.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	trigger	The change trigger.

int CPhidgetTemperatureSensor_setTemperatureChangeTrigger	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		double	trigger
	)

Sets the change trigger for a thermocouple input.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	trigger	The change trigger.

int CPhidgetTemperatureSensor_getPotential	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		double *	potential
	)

Gets the currently sensed potential for a thermocouple input.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	potential	The potential.

int CPhidgetTemperatureSensor_getPotentialMax	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		double *	max
	)

Gets the maximum potential that a thermocouple input can measure.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	max	The maximum potential.

int CPhidgetTemperatureSensor_getPotentialMin	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		double *	min
	)

Gets the minimum potential that a thermocouple input can measure.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	min	The minimum potential.

int CPhidgetTemperatureSensor_getAmbientTemperature	(	CPhidgetTemperatureSensorHandle	phid,
		double *	ambient
	)

Gets the ambient (board) temperature.

Parameters:

	phid	An attached phidget themperature sensor handle.
	ambient	The ambient (board) temperature.

int CPhidgetTemperatureSensor_getAmbientTemperatureMax	(	CPhidgetTemperatureSensorHandle	phid,
		double *	max
	)

Gets the maximum temperature that the ambient onboard temperature sensor can measure.

Parameters:

	phid	An attached phidget themperature sensor handle.
	max	The maximum temperature.

int CPhidgetTemperatureSensor_getAmbientTemperatureMin	(	CPhidgetTemperatureSensorHandle	phid,
		double *	min
	)

Gets the minimum temperature that the ambient onboard temperature sensor can measure.

Parameters:

	phid	An attached phidget themperature sensor handle.
	min	The minimum temperature.

int CPhidgetTemperatureSensor_getThermocoupleType	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		CPhidgetTemperatureSensor_ThermocoupleType *	type
	)

Gets the type of thermocouple set to be at a thermocouple input. By default this is K-Type.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	type	The thermocouple type.

int CPhidgetTemperatureSensor_setThermocoupleType	(	CPhidgetTemperatureSensorHandle	phid,
		int	index,
		CPhidgetTemperatureSensor_ThermocoupleType	type
	)

Sets the type of thermocouple plugged into a thermocouple input. By default this is K-Type.

Parameters:

	phid	An attached phidget themperature sensor handle.
	index	The thermocouple index.
	type	The thermocouple type.