Visual Basic .NET - Barometer Bricklet

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

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

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

        ' Get current air pressure
        Dim airPressure As Integer = b.GetAirPressure()
        Console.WriteLine("Air Pressure: " + (airPressure/1000.0).ToString() + " mbar")

        ' Get current altitude
        Dim altitude As Integer = b.GetAltitude()
        Console.WriteLine("Altitude: " + (altitude/100.0).ToString() + " m")

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

    ' Callback subroutine for air pressure callback
    Sub AirPressureCB(ByVal sender As BrickletBarometer, ByVal airPressure As Integer)
        Console.WriteLine("Air Pressure: " + (airPressure/1000.0).ToString() + " mbar")
    End Sub

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

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

        ' Register air pressure callback to subroutine AirPressureCB
        AddHandler b.AirPressureCallback, AddressOf AirPressureCB

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

    ' Callback subroutine for air pressure reached callback
    Sub AirPressureReachedCB(ByVal sender As BrickletBarometer, _
                             ByVal airPressure As Integer)
        Console.WriteLine("Air Pressure: " + (airPressure/1000.0).ToString() + " mbar")
        Console.WriteLine("Enjoy the potentially good weather!")
    End Sub

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

        ' Register air pressure reached callback to subroutine AirPressureReachedCB
        AddHandler b.AirPressureReachedCallback, AddressOf AirPressureReachedCB

        ' Configure threshold for air pressure "greater than 1025 mbar"
        b.SetAirPressureCallbackThreshold(">"C, 1025*1000, 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 BrickletBarometer(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim barometer As New BrickletBarometer("YOUR_DEVICE_UID", ipcon)

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

Function BrickletBarometer.GetAirPressure() As Integer

Returns the air pressure of the air pressure sensor. The value has a range of 10000 to 1200000 and is given in mbar/1000, i.e. a value of 1001092 means that an air pressure of 1001.092 mbar is measured.

If you want to get the air pressure periodically, it is recommended to use the AirPressureCallback callback and set the period with SetAirPressureCallbackPeriod().

Function BrickletBarometer.GetAltitude() As Integer

Returns the relative altitude of the air pressure sensor. The value is given in cm and is calculated based on the difference between the current air pressure and the reference air pressure that can be set with SetReferenceAirPressure().

If you want to get the altitude periodically, it is recommended to use the AltitudeCallback callback and set the period with SetAltitudeCallbackPeriod().

Sub BrickletBarometer.SetReferenceAirPressure(ByVal airPressure As Integer)

Sets the reference air pressure in mbar/1000 for the altitude calculation. Valid values are between 10000 and 1200000. Setting the reference to the current air pressure results in a calculated altitude of 0cm. Passing 0 is a shortcut for passing the current air pressure as reference.

Well known reference values are the Q codes QNH and QFE used in aviation.

The default value is 1013.25mbar.

Function BrickletBarometer.GetReferenceAirPressure() As Integer

Returns the reference air pressure as set by SetReferenceAirPressure().

Advanced Functions

Function BrickletBarometer.GetChipTemperature() As Short

Returns the temperature of the air pressure sensor. The value has a range of -4000 to 8500 and is given in °C/100, i.e. a value of 2007 means that a temperature of 20.07 °C is measured.

This temperature is used internally for temperature compensation of the air pressure measurement. It is not as accurate as the temperature measured by the Temperature Bricklet or the Temperature IR Bricklet.

Sub BrickletBarometer.SetAveraging(ByVal movingAveragePressure As Byte, ByVal averagePressure As Byte, ByVal averageTemperature As Byte)

Sets the different averaging parameters. It is possible to set the length of a normal averaging for the temperature and pressure, as well as an additional length of a moving average for the pressure. The moving average is calculated from the normal averages. There is no moving average for the temperature.

The maximum length for the pressure average is 10, for the temperature average is 255 and for the moving average is 25.

Setting the all three parameters to 0 will turn the averaging completely off. If the averaging is off, there is lots of noise on the data, but the data is without delay. Thus we recommend to turn the averaging off if the Barometer Bricklet data is to be used for sensor fusion with other sensors.

The default values are 10 for the normal averages and 25 for the moving average.

New in version 2.0.1 (Plugin).

Sub BrickletBarometer.GetAveraging(ByRef movingAveragePressure As Byte, ByRef averagePressure As Byte, ByRef averageTemperature As Byte)

Returns the averaging configuration as set by SetAveraging().

New in version 2.0.1 (Plugin).

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

  • BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BrickletBarometer.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletBarometer.FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BrickletBarometer.FUNCTION_SET_AVERAGING = 20
Sub BrickletBarometer.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

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

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

The AirPressureCallback callback is only triggered if the air pressure has changed since the last triggering.

The default value is 0.

Function BrickletBarometer.GetAirPressureCallbackPeriod() As Long

Returns the period as set by SetAirPressureCallbackPeriod().

Sub BrickletBarometer.SetAltitudeCallbackPeriod(ByVal period As Long)

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

The AltitudeCallback callback is only triggered if the altitude has changed since the last triggering.

The default value is 0.

Function BrickletBarometer.GetAltitudeCallbackPeriod() As Long

Returns the period as set by SetAltitudeCallbackPeriod().

Sub BrickletBarometer.SetAirPressureCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Sets the thresholds for the AirPressureReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

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

Returns the threshold as set by SetAirPressureCallbackThreshold().

The following constants are available for this function:

  • BrickletBarometer.THRESHOLD_OPTION_OFF = "x"C
  • BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletBarometer.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletBarometer.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletBarometer.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletBarometer.SetAltitudeCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Sets the thresholds for the AltitudeReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

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

Returns the threshold as set by SetAltitudeCallbackThreshold().

The following constants are available for this function:

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

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

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

AddHandler barometer.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 BrickletBarometer.AirPressureCallback(ByVal sender As BrickletBarometer, ByVal airPressure As Integer)

This callback is triggered periodically with the period that is set by SetAirPressureCallbackPeriod(). The parameter is the air pressure of the air pressure sensor.

The AirPressureCallback callback is only triggered if the air pressure has changed since the last triggering.

Event BrickletBarometer.AltitudeCallback(ByVal sender As BrickletBarometer, ByVal altitude As Integer)

This callback is triggered periodically with the period that is set by SetAltitudeCallbackPeriod(). The parameter is the altitude of the air pressure sensor.

The AltitudeCallback callback is only triggered if the altitude has changed since the last triggering.

Event BrickletBarometer.AirPressureReachedCallback(ByVal sender As BrickletBarometer, ByVal airPressure As Integer)

This callback is triggered when the threshold as set by SetAirPressureCallbackThreshold() is reached. The parameter is the air pressure of the air pressure sensor.

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

Event BrickletBarometer.AltitudeReachedCallback(ByVal sender As BrickletBarometer, ByVal altitude As Integer)

This callback is triggered when the threshold as set by SetAltitudeCallbackThreshold() is reached. The parameter is the altitude of the air pressure sensor.

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

Constants

Const BrickletBarometer.DEVICE_IDENTIFIER

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

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