Visual Basic .NET - Humidity Bricklet

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

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

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

        ' Get current humidity
        Dim humidity As Integer = h.GetHumidity()
        Console.WriteLine("Humidity: " + (humidity/10.0).ToString() + " %RH")

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

    ' Callback subroutine for humidity callback
    Sub HumidityCB(ByVal sender As BrickletHumidity, ByVal humidity As Integer)
        Console.WriteLine("Humidity: " + (humidity/10.0).ToString() + " %RH")
    End Sub

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

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

        ' Register humidity callback to subroutine HumidityCB
        AddHandler h.HumidityCallback, AddressOf HumidityCB

        ' Set period for humidity callback to 1s (1000ms)
        ' Note: The humidity callback is only called every second
        '       if the humidity has changed since the last call!
        h.SetHumidityCallbackPeriod(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
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 Humidity Bricklet

    ' Callback subroutine for humidity reached callback
    Sub HumidityReachedCB(ByVal sender As BrickletHumidity, ByVal humidity As Integer)
        Console.WriteLine("Humidity: " + (humidity/10.0).ToString() + " %RH")
        Console.WriteLine("Recommended humidity for human comfort is 30 to 60 %RH.")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim h As New BrickletHumidity(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)
        h.SetDebouncePeriod(10000)

        ' Register humidity reached callback to subroutine HumidityReachedCB
        AddHandler h.HumidityReachedCallback, AddressOf HumidityReachedCB

        ' Configure threshold for humidity "outside of 30 to 60 %RH"
        h.SetHumidityCallbackThreshold("o"C, 30*10, 60*10)

        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 BrickletHumidity(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim humidity As New BrickletHumidity("YOUR_DEVICE_UID", ipcon)

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

Function BrickletHumidity.GetHumidity() As Integer
Returns:
  • humidity – Type: Integer, Unit: 1/10 %, Range: [0 to 1000]

Returns the humidity of the sensor.

If you want to get the humidity periodically, it is recommended to use the HumidityCallback callback and set the period with SetHumidityCallbackPeriod().

Advanced Functions

Function BrickletHumidity.GetAnalogValue() As Integer
Returns:
  • value – Type: Integer, Range: [0 to 4095]

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by GetHumidity() is averaged over several samples to yield less noise, while GetAnalogValue() gives back raw unfiltered analog values. The returned humidity value is calibrated for room temperatures, if you use the sensor in extreme cold or extreme warm environments, you might want to calculate the humidity from the analog value yourself. See the HIH 5030 datasheet.

If you want the analog value periodically, it is recommended to use the AnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod().

Function BrickletHumidity.GetAPIVersion() As Byte()
Returns:
  • apiVersion – Type: Byte Array, Length: 3, Range: [0 to 255]

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 BrickletHumidity.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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
  • BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
  • BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletHumidity.FUNCTION_SET_DEBOUNCE_PERIOD = 11
Sub BrickletHumidity.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.

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:

  • BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
  • BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
  • BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletHumidity.FUNCTION_SET_DEBOUNCE_PERIOD = 11
Sub BrickletHumidity.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.

Sub BrickletHumidity.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:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: Char
  • hardwareVersion – Type: Byte Array, Length: 3, Range: [0 to 255]
  • firmwareVersion – Type: Byte Array, Length: 3, Range: [0 to 255]
  • deviceIdentifier – Type: Integer, Range: [0 to 216 - 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' 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 BrickletHumidity.SetHumidityCallbackPeriod(ByVal period As Long)
Parameters:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The HumidityCallback callback is only triggered if the humidity has changed since the last triggering.

Function BrickletHumidity.GetHumidityCallbackPeriod() As Long
Returns:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetHumidityCallbackPeriod().

Sub BrickletHumidity.SetAnalogValueCallbackPeriod(ByVal period As Long)
Parameters:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The AnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

Function BrickletHumidity.GetAnalogValueCallbackPeriod() As Long
Returns:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetAnalogValueCallbackPeriod().

Sub BrickletHumidity.SetHumidityCallbackThreshold(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/10 %, Range: [0 to 216 - 1], Default: 0
  • max – Type: Integer, Unit: 1/10 %, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the HumidityReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • BrickletHumidity.THRESHOLD_OPTION_OFF = "x"C
  • BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletHumidity.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletHumidity.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletHumidity.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletHumidity.GetHumidityCallbackThreshold(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/10 %, Range: [0 to 216 - 1], Default: 0
  • max – Type: Integer, Unit: 1/10 %, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by SetHumidityCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletHumidity.THRESHOLD_OPTION_OFF = "x"C
  • BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletHumidity.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletHumidity.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletHumidity.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletHumidity.SetAnalogValueCallbackThreshold(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, Range: [0 to 216 - 1], Default: 0
  • max – Type: Integer, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the AnalogValueReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • BrickletHumidity.THRESHOLD_OPTION_OFF = "x"C
  • BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletHumidity.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletHumidity.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletHumidity.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletHumidity.GetAnalogValueCallbackThreshold(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, Range: [0 to 216 - 1], Default: 0
  • max – Type: Integer, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletHumidity.THRESHOLD_OPTION_OFF = "x"C
  • BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletHumidity.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletHumidity.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletHumidity.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletHumidity.SetDebouncePeriod(ByVal debounce As Long)
Parameters:
  • debounce – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

Function BrickletHumidity.GetDebouncePeriod() As Long
Returns:
  • debounce – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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

AddHandler humidity.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 BrickletHumidity.HumidityCallback(ByVal sender As BrickletHumidity, ByVal humidity As Integer)
Callback Parameters:
  • sender – Type: BrickletHumidity
  • humidity – Type: Integer, Unit: 1/10 %, Range: [0 to 1000]

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

The HumidityCallback callback is only triggered if the humidity has changed since the last triggering.

Event BrickletHumidity.AnalogValueCallback(ByVal sender As BrickletHumidity, ByVal value As Integer)
Callback Parameters:
  • sender – Type: BrickletHumidity
  • value – Type: Integer, Range: [0 to 4095]

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod(). The parameter is the analog value of the sensor.

The AnalogValueCallback callback is only triggered if the humidity has changed since the last triggering.

Event BrickletHumidity.HumidityReachedCallback(ByVal sender As BrickletHumidity, ByVal humidity As Integer)
Callback Parameters:
  • sender – Type: BrickletHumidity
  • humidity – Type: Integer, Unit: 1/10 %, Range: [0 to 1000]

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

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

Event BrickletHumidity.AnalogValueReachedCallback(ByVal sender As BrickletHumidity, ByVal value As Integer)
Callback Parameters:
  • sender – Type: BrickletHumidity
  • value – Type: Integer, Range: [0 to 4095]

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the sensor.

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

Constants

Const BrickletHumidity.DEVICE_IDENTIFIER

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

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