View source for 1051 User Guide

[[Category:UserGuide]]
{{UserguideTOC|1051.jpg|1051}}
==Getting Started==

===Checking the Contents===
{{UGbox|
'''You should have received:'''
* A PhidgetTemperatureSensor 1-Input
* A Mini-USB Cable
|
'''In order to test your new Phidget you will also need:'''
* A Thermocouple with stripped end
||}}

===Connecting the Pieces===
{{UGbox|
# Connect the thermocouple to the input terminal block on the 1051. Make sure that the thermocouple ground wire goes into the ground terminal (-). For example, if you are using a 2007 - Phidget K-type Thermocouple, the white wire is the ground wire.
# Connect the 1051 to your PC using the Mini-USB cable.
|
[[File:1051_2_Connecting_The_Hardware.jpg|400px|link=]]
||}}

===Testing Using Windows 2000 / XP / Vista / 7===

{{UGwin}}

===Running Phidgets Sample Program===

{{UGwin2|'''TemperatureSensor-full '''}}

{{UGbox|
Double Click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that the '''Phidget Temperature Sensor''' is properly attached  to your PC.
|[[File:1051_2_Control_Panel_Screen.jpg|400px|link=]]
|
# Double Click on Phidget Temperature Sensor in the Phidget Control Panel to bring up TemperatureSensor-full and check that the box labelled Attached contains the word True.
# Select the thermocouple type (In this example, we're using a K-Type thermocouple). If you don't choose the correct type, your temperature results will be incorrect.
# Touch a source of heat (light bulb, candle or lighter flame) with the thermocouple probe and watch the Thermocouple temperature increase.
# The potential value will also increase as the thermocouple temperature increases.
# The ambient temperature gives you the board temperature.
# You can adjust the data sensitivity by moving the slider pointer.
|[[File:1051_2_Temperature_Screen.jpg|400px|link=]]
}}

===Testing Using Mac OS X===

{{UGmac|e Phidget Temperature Sensor 1-Input|TemperatureSensor-full}}

===Using Linux===

{{UGlinux}}

===Using Windows Mobile / CE 5.0 / CE 6.0===

{{UGce}}

==Technical Details==

{{Coldjunctioncomp}}

For more information on thermocouples, check out the [[Thermocouple Primer]].

==API==
{{UGapih}}

===Functions===

{{UGapi|int TemperatureInputCount () [get] : Constant
|Returns the number of thermocouples that can be read by this PhidgetTemperatureSensor.
}}

{{UGapi|double Temperature (int ProbeIndex) [get] : Celsius
|Returns the temperature of a thermocouple. This value is returned in degrees Celsius but can easily be converted into other units. This value will always be between TemperatureMin and TemperatureMax.  Please refer to the device specifications for noise and accuracy details.
}}

{{UGapi|double TemperatureMax (int ProbeIndex) [get] : Constant, Celsius
|Returns the maximum temperature that can be returned by a thermocouple input. This value depends on the thermocouple type.
}}

{{UGapi|double TemperatureMin (int ProbeIndex) [get] : Constant, Celsius
|Returns the minimum temperature that can be returned by a thermocouple input. This value depends on the thermocouple type.
}}

{{UGapi|double TemperatureChangeTrigger(int ProbeIndex) [get,set] : Celsius
|Sets the change trigger for an input. This is the amount by which the sensed temperature must change between TemperatureChangeEvents. By default this is set to 0.5. 

:Setting TemperatureChangeTrigger to 0 will cause all temperature updates to fire events.This is helpful for applications that are implementing their own filtering.
}}

{{UGapi|double Potential (int ProbeIndex) [get] : Millivolts
|Returns the potential of a thermocouple input. This value is returned in millivolts, and will always be between getPotentialMin and getPotentialMax. This is the value that is internally used to calculate temperature in the library.
}}

{{UGapi|double PotentialMax (int ProbeIndex) [get] : Constant, Millivolts
|Returns the maximum voltage that can be measured by the 1051.
}}

{{UGapi|double PotentialMin (int ProbeIndex) [get] : Constant, Millivolts
|Returns the minimum voltage that can be measured by the 1051.
}}

{{UGapi|double AmbientTemperature () [get] : Celsius
|Returns the temperature of the 1051 board, measured near the thermocouple connector. This temperature is used as a reference for the thermocouple voltage.  This value will always be between getAmbientTemperatureMin and getAmbientTemperatureMax. 
}}

{{UGapi|double AmbientTemperatureMax () [get] : Constant, Celsius
|Returns the maximum temperature that can be returned by the ambient sensor.
}}

{{UGapi|double AmbientTemperatureMin () [get] : Constant, Celsius
|Returns the minimum temperature that can be returned by the ambient sensor.
}}

{{UGapi|int ThermocoupleType(int ProbeIndex) [get,set]
|Returns/Sets the thermocouple type for an input. The possible values are J, K, E, and T, corresponding to K, E, J and T-Type Thermocouples.  Support for other thermocouple types, and voltage sources other then thermocouples in the valid range (between getPotentialMin and getPotentialMax) can be achieved using getPotential. Note that this function will vary widely between APIs.  Please refer to the Manual for the API you are programming against for exact calling conventions.
}}

===Events===
{{UGapi| | }}
{{UGapi|OnTemperatureChange(int ProbeIndex, double Temperature) [event]
|Event that fires whenever the temperature changes by more than the TemperatureChangeTrigger.
}}

{{UGapi|OnError(int code, String description) [event]
|PhidgetTemperatureSensor returns EEPHIDGET_OUTOFRANGE when an input goes out of the range specified by PotentialMin-PotentialMax or TemperatureMin-TemperatureMax. The event is reported once per input per out-of-range type. until the value has gone back into range. The description specifies the input, the type of out-of-range error and the out of range value that was read.

This should only happen for inputs which don’t have a thermocouple attached.
}}
==Product History==
{{UGhist}}
{{UGrow|October 2003|0|100|Product Release}}
{{UGrow|January 2005|0|200|Noise performance improved to 2 Celsius}}
{{UGrow|October 2008|1|300|More accurate ambient temperature sensor. Added support for E, J, and T-type thermocouples in the API library, on-board noise filtering.}}
{{UGrow|April 2010  |2|400|Mini USB connector, new thermocouple connector}}
{{UGrow|May 2010    |2|401|Fixed setLabel}}
{{UGrow|May 2011    |2|402|getLabelString fixed for labels longer than 7 characters}}