This is the description of the Visual Basic .NET API bindings for the Thermocouple Bricklet 2.0. General information and technical specifications for the Thermocouple Bricklet 2.0 are summarized in its hardware description.
An installation guide for the Visual Basic .NET API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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
|
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
|
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
|
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.
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).
Returns: |
|
---|
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().
Parameters: |
|
---|
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:
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:
The following constants are available for this function:
For averaging:
For thermocoupleType:
For filter:
Output Parameters: |
|
---|
Returns the configuration as set by SetConfiguration().
The following constants are available for this function:
For averaging:
For thermocoupleType:
For filter:
Output Parameters: |
|
---|
Returns the current error state. There are two possible errors:
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.
Output Parameters: |
|
---|
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
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.
Parameters: |
|
---|---|
Returns: |
|
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:
For mode:
For status:
Returns: |
|
---|
Returns the current bootloader mode, see SetBootloaderMode().
The following constants are available for this function:
For mode:
Parameters: |
|
---|
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.
Parameters: |
|
---|---|
Returns: |
|
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.
Parameters: |
|
---|
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:
For config:
Returns: |
|
---|
Returns the configuration as set by SetStatusLEDConfig()
The following constants are available for this function:
For config:
Returns: |
|
---|
Returns the temperature 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.
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!
Parameters: |
|
---|
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.
Returns: |
|
---|
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
Output Parameters: |
|
---|
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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.
The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.
Parameters: |
|
---|
The period 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 following constants are available for this function:
For option:
Output Parameters: |
|
---|
Returns the callback configuration as set by SetTemperatureCallbackConfiguration().
The following constants are available for this function:
For option:
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.
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.
Callback Parameters: |
|
---|
This callback is triggered periodically according to the configuration set by SetTemperatureCallbackConfiguration().
The parameter is the same as GetTemperature().
Callback Parameters: |
|
---|
This Callback is triggered every time the error state changes (see GetErrorState()).
Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.
Output Parameters: |
|
---|
Returns the version of the API definition 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.
Parameters: |
|
---|---|
Returns: |
|
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.
The following constants are available for this function:
For functionId:
Parameters: |
|
---|
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 constants are available for this function:
For functionId:
Parameters: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
This constant is used to identify a Thermocouple Bricklet 2.0.
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.
This constant represents the human readable name of a Thermocouple Bricklet 2.0.