LabVIEW - Temperature IR Bricklet

This is the description of the LabVIEW API bindings for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR Bricklet are summarized in its hardware description.

An installation guide for the LabVIEW API bindings is part of their general description.

API

Generally, every method of the LabVIEW bindings that outputs a value can report a Tinkerforge.TimeoutException. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletTemperatureIR(uid, ipcon) → temperatureIR
Input:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Output:
  • temperatureIR -- .NET Refnum (BrickletTemperatureIR)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected (see examples above).

BrickletTemperatureIR.GetAmbientTemperature() → temperature
Output:
  • temperature -- Int16

Returns the ambient temperature of the sensor. The value has a range of -400 to 1250 and is given in °C/10, e.g. a value of 423 means that an ambient temperature of 42.3 °C is measured.

If you want to get the ambient temperature periodically, it is recommended to use the callback AmbientTemperature and set the period with SetAmbientTemperatureCallbackPeriod().

BrickletTemperatureIR.GetObjectTemperature() → temperature
Output:
  • temperature -- Int16

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at. The value has a range of -700 to 3800 and is given in °C/10, e.g. a value of 3001 means that a temperature of 300.1 °C is measured on the surface of the object.

The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with SetEmissivity().

If you want to get the object temperature periodically, it is recommended to use the callback ObjectTemperature and set the period with SetObjectTemperatureCallbackPeriod().

Advanced Functions

BrickletTemperatureIR.SetEmissivity(emissivity)
Input:
  • emissivity -- Int32

Sets the emissivity that is used to calculate the surface temperature as returned by GetObjectTemperature().

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.

The parameter of SetEmissivity() has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

Note

If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The default emissivity is 1.0 (value of 65535) and the minimum emissivity the sensor can handle is 0.1 (value of 6553).

BrickletTemperatureIR.GetEmissivity() → emissivity
Output:
  • emissivity -- Int32

Returns the emissivity as set by SetEmissivity().

BrickletTemperatureIR.GetAPIVersion() → apiVersion
Output:
  • apiVersion -- Byte[3]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletTemperatureIR.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId -- Byte
Output:
  • responseExpected -- Boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected() for the list of function ID constants available for this function.

BrickletTemperatureIR.SetResponseExpected(functionId, responseExpected)
Input:
  • functionId -- Byte
  • responseExpected -- Boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled and callbacks it is always disabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletTemperatureIR.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected -- Boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletTemperatureIR.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletTemperatureIR.SetAmbientTemperatureCallbackPeriod(period)
Input:
  • period -- Int64

Sets the period in ms with which the AmbientTemperature callback is triggered periodically. A value of 0 turns the callback off.

AmbientTemperature is only triggered if the temperature has changed since the last triggering.

The default value is 0.

BrickletTemperatureIR.GetAmbientTemperatureCallbackPeriod() → period
Output:
  • period -- Int64

Returns the period as set by SetAmbientTemperatureCallbackPeriod().

BrickletTemperatureIR.SetObjectTemperatureCallbackPeriod(period)
Input:
  • period -- Int64

Sets the period in ms with which the ObjectTemperature callback is triggered periodically. A value of 0 turns the callback off.

ObjectTemperature is only triggered if the temperature has changed since the last triggering.

The default value is 0.

BrickletTemperatureIR.GetObjectTemperatureCallbackPeriod() → period
Output:
  • period -- Int64

Returns the period as set by SetObjectTemperatureCallbackPeriod().

BrickletTemperatureIR.SetAmbientTemperatureCallbackThreshold(option, min, max)
Input:
  • option -- Char
  • min -- Int16
  • max -- Int16

Sets the thresholds for the AmbientTemperatureReached callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the ambient temperature is outside the min and max values
'i' Callback is triggered when the ambient temperature is inside the min and max values
'<' Callback is triggered when the ambient temperature is smaller than the min value (max is ignored)
'>' Callback is triggered when the ambient temperature is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
BrickletTemperatureIR.GetAmbientTemperatureCallbackThreshold() → option, min, max
Output:
  • option -- Char
  • min -- Int16
  • max -- Int16

Returns the threshold as set by SetAmbientTemperatureCallbackThreshold().

The following constants are available for this function:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
BrickletTemperatureIR.SetObjectTemperatureCallbackThreshold(option, min, max)
Input:
  • option -- Char
  • min -- Int16
  • max -- Int16

Sets the thresholds for the ObjectTemperatureReached callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the object temperature is outside the min and max values
'i' Callback is triggered when the object temperature is inside the min and max values
'<' Callback is triggered when the object temperature is smaller than the min value (max is ignored)
'>' Callback is triggered when the object temperature is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
BrickletTemperatureIR.GetObjectTemperatureCallbackThreshold() → option, min, max
Output:
  • option -- Char
  • min -- Int16
  • max -- Int16

Returns the threshold as set by SetObjectTemperatureCallbackThreshold().

The following constants are available for this function:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
BrickletTemperatureIR.SetDebouncePeriod(debounce)
Input:
  • debounce -- Int64

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletTemperatureIR.GetDebouncePeriod() → debounce
Output:
  • debounce -- Int64

Returns the debounce period as set by SetDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event BrickletTemperatureIR.AmbientTemperature(sender, temperature)
Input:
  • sender -- .NET Refnum (BrickletTemperatureIR)
  • temperature -- Int16

This callback is triggered periodically with the period that is set by SetAmbientTemperatureCallbackPeriod(). The parameter is the ambient temperature of the sensor.

AmbientTemperature is only triggered if the ambient temperature has changed since the last triggering.

event BrickletTemperatureIR.ObjectTemperature(sender, temperature)
Input:
  • sender -- .NET Refnum (BrickletTemperatureIR)
  • temperature -- Int16

This callback is triggered periodically with the period that is set by SetObjectTemperatureCallbackPeriod(). The parameter is the object temperature of the sensor.

ObjectTemperature is only triggered if the object temperature has changed since the last triggering.

event BrickletTemperatureIR.AmbientTemperatureReached(sender, temperature)
Input:
  • sender -- .NET Refnum (BrickletTemperatureIR)
  • temperature -- Int16

This callback is triggered when the threshold as set by SetAmbientTemperatureCallbackThreshold() is reached. The parameter is the ambient temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

event BrickletTemperatureIR.ObjectTemperatureReached(sender, temperature)
Input:
  • sender -- .NET Refnum (BrickletTemperatureIR)
  • temperature -- Int16

This callback is triggered when the threshold as set by SetObjectTemperatureCallbackThreshold() is reached. The parameter is the object temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

Constants

BrickletTemperatureIR.DEVICE_IDENTIFIER

This constant is used to identify a Temperature IR Bricklet.

The GetIdentity() function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

Creative Commons Licence The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.