Visual Basic .NET - PTC Bricklet¶

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

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 PTC Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ptc As New BrickletPTC(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 = ptc.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)

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 PTC Bricklet

    ' Callback subroutine for temperature callback
    Sub TemperatureCB(ByVal sender As BrickletPTC, 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 ptc As New BrickletPTC(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 ptc.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!
        ptc.SetTemperatureCallbackPeriod(1000)

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

Threshold¶

Download (ExampleThreshold.vb)

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 PTC Bricklet

    ' Callback subroutine for temperature reached callback
    Sub TemperatureReachedCB(ByVal sender As BrickletPTC, 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 ptc As New BrickletPTC(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)
        ptc.SetDebouncePeriod(10000)

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

        ' Configure threshold for temperature "greater than 30 °C"
        ptc.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 BrickletPTC(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim ptc As New BrickletPTC("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected.

Function BrickletPTC.GetTemperature() As Integer¶

Returns:	temperature – Type: Integer, Unit: 1/100 °C, Range: [-24600 to 84900]

Returns the temperature of connected sensor.

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

Function BrickletPTC.IsSensorConnected() As Boolean¶

Returns:	connected – Type: Boolean

Returns true if the sensor is connected correctly.

If this function returns false, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

Sub BrickletPTC.SetWireMode(ByVal mode As Byte)¶

Parameters:	mode – Type: Byte, Range: See constants, Default: 2

Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.

The following constants are available for this function:

For mode:

BrickletPTC.WIRE_MODE_2 = 2
BrickletPTC.WIRE_MODE_3 = 3
BrickletPTC.WIRE_MODE_4 = 4

Function BrickletPTC.GetWireMode() As Byte¶

Returns:	mode – Type: Byte, Range: See constants, Default: 2

Returns the wire mode as set by SetWireMode()

The following constants are available for this function:

For mode:

BrickletPTC.WIRE_MODE_2 = 2
BrickletPTC.WIRE_MODE_3 = 3
BrickletPTC.WIRE_MODE_4 = 4

Advanced Functions¶

Function BrickletPTC.GetResistance() As Integer¶

Returns:	resistance – Type: Integer, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1]

Returns the value as measured by the MAX31865 precision delta-sigma ADC.

The value can be converted with the following formulas:

Pt100: resistance = (value * 390) / 32768
Pt1000: resistance = (value * 3900) / 32768

If you want to get the resistance periodically, it is recommended to use the ResistanceCallback callback and set the period with SetResistanceCallbackPeriod().

Sub BrickletPTC.SetNoiseRejectionFilter(ByVal filter As Byte)¶

Parameters:	filter – Type: Byte, Range: See constants, Default: 0

Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.

The following constants are available for this function:

For filter:

BrickletPTC.FILTER_OPTION_50HZ = 0
BrickletPTC.FILTER_OPTION_60HZ = 1

Function BrickletPTC.GetNoiseRejectionFilter() As Byte¶

Returns:	filter – Type: Byte, Range: See constants, Default: 0

Returns the noise rejection filter option as set by SetNoiseRejectionFilter()

The following constants are available for this function:

For filter:

BrickletPTC.FILTER_OPTION_50HZ = 0
BrickletPTC.FILTER_OPTION_60HZ = 1

Sub BrickletPTC.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)¶

Output Parameters:

Output Parameters:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a"C to "h"C, "z"C] hardwareVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] firmwareVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] deviceIdentifier – Type: Integer, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: Char, Range: ["a"C to "h"C, "z"C]
hardwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

firmwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

deviceIdentifier – Type: Integer, Range: [0 to 2¹⁶ - 1]

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). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions¶

Sub BrickletPTC.SetTemperatureCallbackPeriod(ByVal period As Long)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period 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.

Function BrickletPTC.GetTemperatureCallbackPeriod() As Long¶

Returns:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by SetTemperatureCallbackPeriod().

Sub BrickletPTC.SetResistanceCallbackPeriod(ByVal period As Long)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

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

The ResistanceCallback callback is only triggered if the resistance has changed since the last triggering.

Function BrickletPTC.GetResistanceCallbackPeriod() As Long¶

Returns:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by SetResistanceCallbackPeriod().

Sub BrickletPTC.SetTemperatureCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Integer, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: Integer, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

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 following constants are available for this function:

For option:

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

Sub BrickletPTC.GetTemperatureCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Output Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Integer, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: Integer, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by SetTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

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

Sub BrickletPTC.SetResistanceCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Integer, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: Integer, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0

Sets the thresholds for the ResistanceReachedCallback 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 following constants are available for this function:

For option:

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

Sub BrickletPTC.GetResistanceCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Output Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Integer, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: Integer, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by SetResistanceCallbackThreshold().

The following constants are available for this function:

For option:

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

Sub BrickletPTC.SetDebouncePeriod(ByVal debounce As Long)¶

Parameters:	debounce – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callback

TemperatureReachedCallback,
ResistanceReachedCallback

is triggered, if the threshold

SetTemperatureCallbackThreshold(),
SetResistanceCallbackThreshold()

keeps being reached.

Function BrickletPTC.GetDebouncePeriod() As Long¶

Returns:	debounce – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Returns the debounce period as set by SetDebouncePeriod().

Sub BrickletPTC.SetSensorConnectedCallbackConfiguration(ByVal enabled As Boolean)¶

Parameters:	enabled – Type: Boolean, Default: false

If you enable this callback, the SensorConnectedCallback callback is triggered every time a Pt sensor is connected/disconnected.

Added in version 2.0.2$nbsp;(Plugin).

Function BrickletPTC.GetSensorConnectedCallbackConfiguration() As Boolean¶

Returns:	enabled – Type: Boolean, Default: false

Returns the configuration as set by SetSensorConnectedCallbackConfiguration().

Added in version 2.0.2$nbsp;(Plugin).

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

AddHandler ptc.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 BrickletPTC.TemperatureCallback(ByVal sender As BrickletPTC, ByVal temperature As Integer)¶

Callback Parameters:	sender – Type: BrickletPTC temperature – Type: Integer, Unit: 1/100 °C, Range: [-24600 to 84900]

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

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

Event BrickletPTC.TemperatureReachedCallback(ByVal sender As BrickletPTC, ByVal temperature As Integer)¶

Callback Parameters:	sender – Type: BrickletPTC temperature – Type: Integer, Unit: 1/100 °C, Range: [-24600 to 84900]

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

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

Event BrickletPTC.ResistanceCallback(ByVal sender As BrickletPTC, ByVal resistance As Integer)¶

Callback Parameters:	sender – Type: BrickletPTC resistance – Type: Integer, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1]

This callback is triggered periodically with the period that is set by SetResistanceCallbackPeriod(). The parameter is the resistance of the connected sensor.

The ResistanceCallback callback is only triggered if the resistance has changed since the last triggering.

Event BrickletPTC.ResistanceReachedCallback(ByVal sender As BrickletPTC, ByVal resistance As Integer)¶

Callback Parameters:	sender – Type: BrickletPTC resistance – Type: Integer, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1]

This callback is triggered when the threshold as set by SetResistanceCallbackThreshold() is reached. The parameter is the resistance of the connected sensor.

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

Event BrickletPTC.SensorConnectedCallback(ByVal sender As BrickletPTC, ByVal connected As Boolean)¶

Callback Parameters:	sender – Type: BrickletPTC connected – Type: Boolean

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

The parameter is the same as IsSensorConnected().

Added in version 2.0.2$nbsp;(Plugin).

Virtual Functions¶

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.

Function BrickletPTC.GetAPIVersion() As Byte()¶

Output Parameters:	apiVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255]

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.

Function BrickletPTC.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameters:	functionId – Type: Byte, Range: See constants
Returns:	responseExpected – Type: 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22

Sub BrickletPTC.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameters:	functionId – Type: Byte, Range: See constants responseExpected – Type: 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.

The following constants are available for this function:

For functionId:

BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22

Sub BrickletPTC.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameters:	responseExpected – Type: Boolean

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

Constants¶

Const BrickletPTC.DEVICE_IDENTIFIER¶

This constant is used to identify a PTC 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 BrickletPTC.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a PTC Bricklet.