Visual Basic .NET - Temperature IR Bricklet

This is the description of the Visual Basic .NET 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 Visual Basic .NET API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Temperature IR Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim tir As New BrickletTemperatureIR(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Get current ambient temperature
        Dim ambientTemperature As Short = tir.GetAmbientTemperature()
        Console.WriteLine("Ambient Temperature: " + (ambientTemperature/10.0).ToString() + " °C")

        ' Get current object temperature
        Dim objectTemperature As Short = tir.GetObjectTemperature()
        Console.WriteLine("Object Temperature: " + (objectTemperature/10.0).ToString() + " °C")

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback

Download (ExampleCallback.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Temperature IR Bricklet

    ' Callback subroutine for object temperature callback
    Sub ObjectTemperatureCB(ByVal sender As BrickletTemperatureIR, _
                            ByVal temperature As Short)
        Console.WriteLine("Object Temperature: " + (temperature/10.0).ToString() + " °C")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim tir As New BrickletTemperatureIR(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register object temperature callback to subroutine ObjectTemperatureCB
        AddHandler tir.ObjectTemperatureCallback, AddressOf ObjectTemperatureCB

        ' Set period for object temperature callback to 1s (1000ms)
        ' Note: The object temperature callback is only called every second
        '       if the object temperature has changed since the last call!
        tir.SetObjectTemperatureCallbackPeriod(1000)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Water Boiling

Download (ExampleWaterBoiling.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Imports System
Imports Tinkerforge

Module ExampleWaterBoiling
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Temperature IR Bricklet

    ' Callback subroutine for object temperature reached callback
    Sub ObjectTemperatureReachedCB(ByVal sender As BrickletTemperatureIR, _
                                   ByVal temperature As Short)
        Console.WriteLine("Object Temperature: " + (temperature/10.0).ToString() + " °C")
        Console.WriteLine("The water is boiling!")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim tir As New BrickletTemperatureIR(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
        tir.SetEmissivity(64224)

        ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        tir.SetDebouncePeriod(10000)

        ' Register object temperature reached callback to subroutine
        ' ObjectTemperatureReachedCB
        AddHandler tir.ObjectTemperatureReachedCallback, _
                   AddressOf ObjectTemperatureReachedCB

        ' Configure threshold for object temperature "greater than 100 °C"
        tir.SetObjectTemperatureCallbackThreshold(">"C, 100*10, 0)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

Class BrickletTemperatureIR(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim temperatureIR As New BrickletTemperatureIR("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected (see examples above).

Function BrickletTemperatureIR.GetAmbientTemperature() As Short

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 AmbientTemperatureCallback callback and set the period with SetAmbientTemperatureCallbackPeriod().

Function BrickletTemperatureIR.GetObjectTemperature() As Short

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 ObjectTemperatureCallback callback and set the period with SetObjectTemperatureCallbackPeriod().

Advanced Functions

Sub BrickletTemperatureIR.SetEmissivity(ByVal emissivity As Integer)

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).

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

Function BrickletTemperatureIR.GetEmissivity() As Integer

Returns the emissivity as set by SetEmissivity().

Function BrickletTemperatureIR.GetAPIVersion() As Byte()

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.

Function BrickletTemperatureIR.GetResponseExpected(ByVal functionId As Byte) As 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.

Sub BrickletTemperatureIR.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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.

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
Sub BrickletTemperatureIR.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletTemperatureIR.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

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

Sub BrickletTemperatureIR.SetAmbientTemperatureCallbackPeriod(ByVal period As Long)

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

The AmbientTemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

The default value is 0.

Function BrickletTemperatureIR.GetAmbientTemperatureCallbackPeriod() As Long

Returns the period as set by SetAmbientTemperatureCallbackPeriod().

Sub BrickletTemperatureIR.SetObjectTemperatureCallbackPeriod(ByVal period As Long)

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

The ObjectTemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

The default value is 0.

Function BrickletTemperatureIR.GetObjectTemperatureCallbackPeriod() As Long

Returns the period as set by SetObjectTemperatureCallbackPeriod().

Sub BrickletTemperatureIR.SetAmbientTemperatureCallbackThreshold(ByVal option As Char, ByVal min As Short, ByVal max As Short)

Sets the thresholds for the AmbientTemperatureReachedCallback 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"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletTemperatureIR.GetAmbientTemperatureCallbackThreshold(ByRef option As Char, ByRef min As Short, ByRef max As Short)

Returns the threshold as set by SetAmbientTemperatureCallbackThreshold().

The following constants are available for this function:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletTemperatureIR.SetObjectTemperatureCallbackThreshold(ByVal option As Char, ByVal min As Short, ByVal max As Short)

Sets the thresholds for the ObjectTemperatureReachedCallback 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"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletTemperatureIR.GetObjectTemperatureCallbackThreshold(ByRef option As Char, ByRef min As Short, ByRef max As Short)

Returns the threshold as set by SetObjectTemperatureCallbackThreshold().

The following constants are available for this function:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = "x"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletTemperatureIR.SetDebouncePeriod(ByVal debounce As Long)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

Function BrickletTemperatureIR.GetDebouncePeriod() As Long

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 procedure to an callback property of the device object:

Sub MyCallback(ByVal sender As BrickletTemperatureIR, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler temperatureIR.ExampleCallback, AddressOf MyCallback

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.AmbientTemperatureCallback(ByVal sender As BrickletTemperatureIR, ByVal temperature As Short)

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

The AmbientTemperatureCallback callback is only triggered if the ambient temperature has changed since the last triggering.

Event BrickletTemperatureIR.ObjectTemperatureCallback(ByVal sender As BrickletTemperatureIR, ByVal temperature As Short)

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

The ObjectTemperatureCallback callback is only triggered if the object temperature has changed since the last triggering.

Event BrickletTemperatureIR.AmbientTemperatureReachedCallback(ByVal sender As BrickletTemperatureIR, ByVal temperature As Short)

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.ObjectTemperatureReachedCallback(ByVal sender As BrickletTemperatureIR, ByVal temperature As Short)

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

Const BrickletTemperatureIR.DEVICE_IDENTIFIER

This constant is used to identify a Temperature IR Bricklet.

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

Const BrickletTemperatureIR.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Temperature IR Bricklet.