Visual Basic .NET - Thermocouple Bricklet 2.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 Thermocouple Bricklet 2.0

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim t As New BrickletThermocoupleV2(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 Integer = 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

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 Thermocouple Bricklet 2.0

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

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim t As New BrickletThermocoupleV2(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) without a threshold
        t.SetTemperatureCallbackConfiguration(1000, False, "x"C, 0, 0)

        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

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 Thermocouple Bricklet 2.0

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

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim t As New BrickletThermocoupleV2(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

        ' Configure threshold for temperature "greater than 30 °C"
        ' with a debounce period of 10s (10000ms)
        t.SetTemperatureCallbackConfiguration(10000, False, ">"C, 30*100, 0)

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

Basic Functions¶

Class BrickletThermocoupleV2(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim thermocoupleV2 As New BrickletThermocoupleV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletThermocoupleV2.GetTemperature() As Integer¶

Returns the temperature of the thermocouple. The value 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 SetTemperatureCallbackConfiguration().

If you want to get the value periodically, it is recommended to use the TemperatureCallback callback. You can set the callback configuration with SetTemperatureCallbackConfiguration().

Advanced Functions¶

Sub BrickletThermocoupleV2.SetConfiguration(ByVal averaging As Byte, ByVal thermocoupleType As Byte, ByVal filter As Byte)¶

You can configure averaging size, thermocouple type and frequency filtering.

Available averaging sizes are 1, 2, 4, 8 and 16 samples.

As thermocouple type you can use B, E, J, K, N, R, S and T. If you have a different thermocouple or a custom thermocouple you can also use G8 and G32. With these types the returned value will not be in °C/100, it will be calculated by the following formulas:

• G8: value = 8 * 1.6 * 2^17 * Vin
• G32: value = 32 * 1.6 * 2^17 * Vin

where Vin is the thermocouple input voltage.

The frequency filter can be either configured to 50Hz or to 60Hz. You should configure it according to your utility frequency.

The conversion time depends on the averaging and filter configuration, it can be calculated as follows:

• 60Hz: time = 82 + (samples - 1) * 16.67
• 50Hz: time = 98 + (samples - 1) * 20

The default configuration is 16 samples, K type and 50Hz.

The following constants are available for this function:

• BrickletThermocoupleV2.AVERAGING_1 = 1
• BrickletThermocoupleV2.AVERAGING_2 = 2
• BrickletThermocoupleV2.AVERAGING_4 = 4
• BrickletThermocoupleV2.AVERAGING_8 = 8
• BrickletThermocoupleV2.AVERAGING_16 = 16
• BrickletThermocoupleV2.TYPE_B = 0
• BrickletThermocoupleV2.TYPE_E = 1
• BrickletThermocoupleV2.TYPE_J = 2
• BrickletThermocoupleV2.TYPE_K = 3
• BrickletThermocoupleV2.TYPE_N = 4
• BrickletThermocoupleV2.TYPE_R = 5
• BrickletThermocoupleV2.TYPE_S = 6
• BrickletThermocoupleV2.TYPE_T = 7
• BrickletThermocoupleV2.TYPE_G8 = 8
• BrickletThermocoupleV2.TYPE_G32 = 9
• BrickletThermocoupleV2.FILTER_OPTION_50HZ = 0
• BrickletThermocoupleV2.FILTER_OPTION_60HZ = 1

Sub BrickletThermocoupleV2.GetConfiguration(ByRef averaging As Byte, ByRef thermocoupleType As Byte, ByRef filter As Byte)¶

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

• BrickletThermocoupleV2.AVERAGING_1 = 1
• BrickletThermocoupleV2.AVERAGING_2 = 2
• BrickletThermocoupleV2.AVERAGING_4 = 4
• BrickletThermocoupleV2.AVERAGING_8 = 8
• BrickletThermocoupleV2.AVERAGING_16 = 16
• BrickletThermocoupleV2.TYPE_B = 0
• BrickletThermocoupleV2.TYPE_E = 1
• BrickletThermocoupleV2.TYPE_J = 2
• BrickletThermocoupleV2.TYPE_K = 3
• BrickletThermocoupleV2.TYPE_N = 4
• BrickletThermocoupleV2.TYPE_R = 5
• BrickletThermocoupleV2.TYPE_S = 6
• BrickletThermocoupleV2.TYPE_T = 7
• BrickletThermocoupleV2.TYPE_G8 = 8
• BrickletThermocoupleV2.TYPE_G32 = 9
• BrickletThermocoupleV2.FILTER_OPTION_50HZ = 0
• BrickletThermocoupleV2.FILTER_OPTION_60HZ = 1

Sub BrickletThermocoupleV2.GetErrorState(ByRef overUnder As Boolean, ByRef openCircuit As Boolean)¶

Returns the current error state. There are two possible errors:

• Over/Under Voltage and
• Open Circuit.

Over/Under Voltage happens for voltages below 0V or above 3.3V. In this case it is very likely that your thermocouple is defective. An Open Circuit error indicates that there is no thermocouple connected.

You can use the ErrorStateCallback callback to automatically get triggered when the error state changes.

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

• BrickletThermocoupleV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
• BrickletThermocoupleV2.FUNCTION_SET_CONFIGURATION = 5
• BrickletThermocoupleV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletThermocoupleV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletThermocoupleV2.FUNCTION_RESET = 243
• BrickletThermocoupleV2.FUNCTION_WRITE_UID = 248

Sub BrickletThermocoupleV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

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

Sub BrickletThermocoupleV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

Function BrickletThermocoupleV2.SetBootloaderMode(ByVal mode As Byte) As Byte¶

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

• BrickletThermocoupleV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletThermocoupleV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletThermocoupleV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletThermocoupleV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletThermocoupleV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
• BrickletThermocoupleV2.BOOTLOADER_STATUS_OK = 0
• BrickletThermocoupleV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletThermocoupleV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletThermocoupleV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletThermocoupleV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletThermocoupleV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletThermocoupleV2.GetBootloaderMode() As Byte¶

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

• BrickletThermocoupleV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletThermocoupleV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletThermocoupleV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletThermocoupleV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletThermocoupleV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Sub BrickletThermocoupleV2.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Sets the firmware pointer for WriteFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Function BrickletThermocoupleV2.WriteFirmware(ByVal data() As Byte) As Byte¶

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Sub BrickletThermocoupleV2.SetStatusLEDConfig(ByVal config As Byte)¶

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

• BrickletThermocoupleV2.STATUS_LED_CONFIG_OFF = 0
• BrickletThermocoupleV2.STATUS_LED_CONFIG_ON = 1
• BrickletThermocoupleV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletThermocoupleV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletThermocoupleV2.GetStatusLEDConfig() As Byte¶

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

• BrickletThermocoupleV2.STATUS_LED_CONFIG_OFF = 0
• BrickletThermocoupleV2.STATUS_LED_CONFIG_ON = 1
• BrickletThermocoupleV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletThermocoupleV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletThermocoupleV2.GetChipTemperature() As Short¶

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

Sub BrickletThermocoupleV2.Reset()¶

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

Sub BrickletThermocoupleV2.WriteUID(ByVal uid As Long)¶

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

Function BrickletThermocoupleV2.ReadUID() As Long¶

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Sub BrickletThermocoupleV2.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 BrickletThermocoupleV2.SetTemperatureCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the TemperatureCallback callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

The following constants are available for this function:

• BrickletThermocoupleV2.THRESHOLD_OPTION_OFF = "x"C
• BrickletThermocoupleV2.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletThermocoupleV2.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletThermocoupleV2.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletThermocoupleV2.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletThermocoupleV2.GetTemperatureCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Returns the callback configuration as set by SetTemperatureCallbackConfiguration().

The following constants are available for this function:

• BrickletThermocoupleV2.THRESHOLD_OPTION_OFF = "x"C
• BrickletThermocoupleV2.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletThermocoupleV2.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletThermocoupleV2.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletThermocoupleV2.THRESHOLD_OPTION_GREATER = ">"C

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

AddHandler thermocoupleV2.ExampleCallback, AddressOf MyCallback

The available callback property and their type of parameters are described below.

Event BrickletThermocoupleV2.TemperatureCallback(ByVal sender As BrickletThermocoupleV2, ByVal temperature As Integer)¶

This callback is triggered periodically according to the configuration set by SetTemperatureCallbackConfiguration().

The parameter is the same as GetTemperature().

Event BrickletThermocoupleV2.ErrorStateCallback(ByVal sender As BrickletThermocoupleV2, ByVal overUnder As Boolean, ByVal openCircuit As Boolean)¶

This Callback is triggered every time the error state changes (see GetErrorState()).

Constants¶

Const BrickletThermocoupleV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Thermocouple Bricklet 2.0.

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 BrickletThermocoupleV2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Thermocouple Bricklet 2.0.