Visual Basic .NET - Temperature Bricklet

This is the description of the Visual Basic .NET API bindings for the Temperature Bricklet. General information and technical specifications for the Temperature 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
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 Bricklet

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

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

        ' Get current temperature
        Dim temperature As Short = t.GetTemperature()
        Console.WriteLine("Temperature: " + (temperature/100.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
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 Bricklet

    ' Callback subroutine for temperature callback
    Sub TemperatureCB(ByVal sender As BrickletTemperature, ByVal temperature As Short)
        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
    End Sub

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

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

        ' Register temperature callback to subroutine TemperatureCB
        AddHandler t.TemperatureCallback, AddressOf TemperatureCB

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

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

Threshold

Download (ExampleThreshold.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
Imports System
Imports Tinkerforge

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

    ' Callback subroutine for temperature reached callback
    Sub TemperatureReachedCB(ByVal sender As BrickletTemperature, _
                             ByVal temperature As Short)
        Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
        Console.WriteLine("It is too hot, we need air conditioning!")
    End Sub

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

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

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

        ' Register temperature reached callback to subroutine TemperatureReachedCB
        AddHandler t.TemperatureReachedCallback, AddressOf TemperatureReachedCB

        ' Configure threshold for temperature "greater than 30 °C"
        t.SetTemperatureCallbackThreshold(">"C, 30*100, 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 BrickletTemperature(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim temperature As New BrickletTemperature("YOUR_DEVICE_UID", ipcon)

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

Function BrickletTemperature.GetTemperature() As Short

Returns the temperature of the sensor. The value has a range of -2500 to 8500 and is given in °C/100, e.g. a value of 4223 means that a temperature of 42.23 °C is measured.

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

Advanced Functions

Sub BrickletTemperature.SetI2CMode(ByVal mode As Byte)

Sets the I2C mode. Possible modes are:

  • 0: Fast (400kHz, default)
  • 1: Slow (100kHz)

If you have problems with obvious outliers in the Temperature Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed.

It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.

The following constants are available for this function:

  • BrickletTemperature.I2C_MODE_FAST = 0
  • BrickletTemperature.I2C_MODE_SLOW = 1

New in version 2.0.1 (Plugin).

Function BrickletTemperature.GetI2CMode() As Byte

Returns the I2C mode as set by SetI2CMode().

The following constants are available for this function:

  • BrickletTemperature.I2C_MODE_FAST = 0
  • BrickletTemperature.I2C_MODE_SLOW = 1

New in version 2.0.1 (Plugin).

Function BrickletTemperature.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 BrickletTemperature.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 BrickletTemperature.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:

  • BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • BrickletTemperature.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletTemperature.FUNCTION_SET_I2C_MODE = 10
Sub BrickletTemperature.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletTemperature.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 BrickletTemperature.SetTemperatureCallbackPeriod(ByVal period As Long)

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

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

The default value is 0.

Function BrickletTemperature.GetTemperatureCallbackPeriod() As Long

Returns the period as set by SetTemperatureCallbackPeriod().

Sub BrickletTemperature.SetTemperatureCallbackThreshold(ByVal option As Char, ByVal min As Short, ByVal max As Short)

Sets the thresholds for the TemperatureReachedCallback callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the temperature is outside the min and max values
'i' Callback is triggered when the temperature is inside the min and max values
'<' Callback is triggered when the temperature is smaller than the min value (max is ignored)
'>' Callback is triggered when the 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:

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

Returns the threshold as set by SetTemperatureCallbackThreshold().

The following constants are available for this function:

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

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

Function BrickletTemperature.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 BrickletTemperature, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler temperature.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 BrickletTemperature.TemperatureCallback(ByVal sender As BrickletTemperature, ByVal temperature As Short)

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

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

Event BrickletTemperature.TemperatureReachedCallback(ByVal sender As BrickletTemperature, ByVal temperature As Short)

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

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

Constants

Const BrickletTemperature.DEVICE_IDENTIFIER

This constant is used to identify a Temperature 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.

Const BrickletTemperature.DEVICE_DISPLAY_NAME

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