Visual Basic .NET - Barometer Bricklet 2.0

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

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 2.0

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim b As New BrickletBarometerV2(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() + " hPa")

        ' Get current altitude
        Dim altitude As Integer = b.GetAltitude()
        Console.WriteLine("Altitude: " + (altitude/1000.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
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 2.0

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

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim b As New BrickletBarometerV2(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) without a threshold
        b.SetAirPressureCallbackConfiguration(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 Barometer Bricklet 2.0

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

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

        ' Configure threshold for air pressure "greater than 1025 hPa"
        ' with a debounce period of 1s (1000ms)
        b.SetAirPressureCallbackConfiguration(1000, False, ">"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 BrickletBarometerV2(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim barometerV2 As New BrickletBarometerV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletBarometerV2.GetAirPressure() As Integer
Returns:
  • airPressure – Type: Integer, Unit: 1/1000 hPa, Range: [260000 to 1260000]

Returns the measured air pressure.

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

Function BrickletBarometerV2.GetAltitude() As Integer
Returns:
  • altitude – Type: Integer, Unit: 1 mm, Range: [-231 to 231 - 1]

Returns the relative altitude of the air pressure sensor. The value 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 value periodically, it is recommended to use the AltitudeCallback callback. You can set the callback configuration with SetAltitudeCallbackConfiguration().

Function BrickletBarometerV2.GetTemperature() As Integer
Returns:
  • temperature – Type: Integer, Unit: 1/100 °C, Range: [-4000 to 8500]

Returns the temperature of the air pressure sensor.

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 2.0 or the Temperature IR Bricklet 2.0.

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

Sub BrickletBarometerV2.SetMovingAverageConfiguration(ByVal movingAverageLengthAirPressure As Integer, ByVal movingAverageLengthTemperature As Integer)
Parameters:
  • movingAverageLengthAirPressure – Type: Integer, Range: [1 to 1000], Default: 100
  • movingAverageLengthTemperature – Type: Integer, Range: [1 to 1000], Default: 100

Sets the length of a moving averaging for the air pressure and temperature measurements.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

If you want to do long term measurements the longest moving average will give the cleanest results.

Sub BrickletBarometerV2.GetMovingAverageConfiguration(ByRef movingAverageLengthAirPressure As Integer, ByRef movingAverageLengthTemperature As Integer)
Output Parameters:
  • movingAverageLengthAirPressure – Type: Integer, Range: [1 to 1000], Default: 100
  • movingAverageLengthTemperature – Type: Integer, Range: [1 to 1000], Default: 100

Returns the moving average configuration as set by SetMovingAverageConfiguration().

Sub BrickletBarometerV2.SetReferenceAirPressure(ByVal airPressure As Integer)
Parameters:
  • airPressure – Type: Integer, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000], Default: 1013250

Sets the reference air pressure for the altitude calculation. Setting the reference to the current air pressure results in a calculated altitude of 0mm. 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.

Function BrickletBarometerV2.GetReferenceAirPressure() As Integer
Returns:
  • airPressure – Type: Integer, Unit: 1/1000 hPa, Range: [260000 to 1260000], Default: 1013250

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

Advanced Functions

Sub BrickletBarometerV2.SetCalibration(ByVal measuredAirPressure As Integer, ByVal actualAirPressure As Integer)
Parameters:
  • measuredAirPressure – Type: Integer, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000]
  • actualAirPressure – Type: Integer, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000]

Sets the one point calibration (OPC) values for the air pressure measurement.

Before the Bricklet can be calibrated any previous calibration has to be removed by setting measured air pressure and actual air pressure to 0.

Then the current air pressure has to be measured using the Bricklet (measured air pressure) and with an accurate reference barometer (actual air pressure) at the same time and passed to this function.

After proper calibration the air pressure measurement can achieve an accuracy up to 0.2 hPa.

The calibration is saved in the EEPROM of the Bricklet and only needs to be configured once.

Sub BrickletBarometerV2.GetCalibration(ByRef measuredAirPressure As Integer, ByRef actualAirPressure As Integer)
Output Parameters:
  • measuredAirPressure – Type: Integer, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000]
  • actualAirPressure – Type: Integer, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000]

Returns the air pressure one point calibration values as set by SetCalibration().

Sub BrickletBarometerV2.SetSensorConfiguration(ByVal dataRate As Byte, ByVal airPressureLowPassFilter As Byte)
Parameters:
  • dataRate – Type: Byte, Range: See constants, Default: 4
  • airPressureLowPassFilter – Type: Byte, Range: See constants, Default: 1

Configures the data rate and air pressure low pass filter. The low pass filter cut-off frequency (if enabled) can be set to 1/9th or 1/20th of the configure data rate to decrease the noise on the air pressure data.

The low pass filter configuration only applies to the air pressure measurement. There is no low pass filter for the temperature measurement.

A higher data rate will result in a less precise temperature because of self-heating of the sensor. If the accuracy of the temperature reading is important to you, we would recommend the 1Hz data rate.

The following constants are available for this function:

For dataRate:

  • BrickletBarometerV2.DATA_RATE_OFF = 0
  • BrickletBarometerV2.DATA_RATE_1HZ = 1
  • BrickletBarometerV2.DATA_RATE_10HZ = 2
  • BrickletBarometerV2.DATA_RATE_25HZ = 3
  • BrickletBarometerV2.DATA_RATE_50HZ = 4
  • BrickletBarometerV2.DATA_RATE_75HZ = 5

For airPressureLowPassFilter:

  • BrickletBarometerV2.LOW_PASS_FILTER_OFF = 0
  • BrickletBarometerV2.LOW_PASS_FILTER_1_9TH = 1
  • BrickletBarometerV2.LOW_PASS_FILTER_1_20TH = 2
Sub BrickletBarometerV2.GetSensorConfiguration(ByRef dataRate As Byte, ByRef airPressureLowPassFilter As Byte)
Output Parameters:
  • dataRate – Type: Byte, Range: See constants, Default: 4
  • airPressureLowPassFilter – Type: Byte, Range: See constants, Default: 1

Returns the sensor configuration as set by SetSensorConfiguration().

The following constants are available for this function:

For dataRate:

  • BrickletBarometerV2.DATA_RATE_OFF = 0
  • BrickletBarometerV2.DATA_RATE_1HZ = 1
  • BrickletBarometerV2.DATA_RATE_10HZ = 2
  • BrickletBarometerV2.DATA_RATE_25HZ = 3
  • BrickletBarometerV2.DATA_RATE_50HZ = 4
  • BrickletBarometerV2.DATA_RATE_75HZ = 5

For airPressureLowPassFilter:

  • BrickletBarometerV2.LOW_PASS_FILTER_OFF = 0
  • BrickletBarometerV2.LOW_PASS_FILTER_1_9TH = 1
  • BrickletBarometerV2.LOW_PASS_FILTER_1_20TH = 2
Sub BrickletBarometerV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)
Output Parameters:
  • errorCountAckChecksum – Type: Long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: Long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: Long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: Long, Range: [0 to 232 - 1]

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 BrickletBarometerV2.SetBootloaderMode(ByVal mode As Byte) As Byte
Parameters:
  • mode – Type: Byte, Range: See constants
Returns:
  • status – Type: Byte, Range: See constants

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:

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

For status:

  • BrickletBarometerV2.BOOTLOADER_STATUS_OK = 0
  • BrickletBarometerV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletBarometerV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletBarometerV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletBarometerV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletBarometerV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletBarometerV2.GetBootloaderMode() As Byte
Returns:
  • mode – Type: Byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

For mode:

  • BrickletBarometerV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletBarometerV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletBarometerV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletBarometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletBarometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletBarometerV2.SetWriteFirmwarePointer(ByVal pointer As Long)
Parameters:
  • pointer – Type: Long, Unit: 1 B, Range: [0 to 232 - 1]

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 BrickletBarometerV2.WriteFirmware(ByVal data() As Byte) As Byte
Parameters:
  • data – Type: Byte Array, Length: 64, Range: [0 to 255]
Returns:
  • status – Type: Byte, Range: [0 to 255]

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 BrickletBarometerV2.SetStatusLEDConfig(ByVal config As Byte)
Parameters:
  • config – Type: Byte, Range: See constants, Default: 3

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:

  • BrickletBarometerV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletBarometerV2.STATUS_LED_CONFIG_ON = 1
  • BrickletBarometerV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletBarometerV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletBarometerV2.GetStatusLEDConfig() As Byte
Returns:
  • config – Type: Byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

For config:

  • BrickletBarometerV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletBarometerV2.STATUS_LED_CONFIG_ON = 1
  • BrickletBarometerV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletBarometerV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletBarometerV2.GetChipTemperature() As Short
Returns:
  • temperature – Type: Short, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

Sub BrickletBarometerV2.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 BrickletBarometerV2.WriteUID(ByVal uid As Long)
Parameters:
  • uid – Type: Long, Range: [0 to 232 - 1]

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 BrickletBarometerV2.ReadUID() As Long
Returns:
  • uid – Type: Long, Range: [0 to 232 - 1]

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

Sub BrickletBarometerV2.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, Range: ["a"C to "h"C, "i"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 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', '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.

Callback Configuration Functions

Sub BrickletBarometerV2.SetAirPressureCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)
Parameters:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: false
  • option – Type: Char, Range: See constants, Default: "x"C
  • min – Type: Integer, Unit: 1/1000 hPa, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/1000 hPa, Range: [-231 to 231 - 1], Default: 0

The period is the period with which the AirPressureCallback 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 AirPressureCallback 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:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletBarometerV2.GetAirPressureCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)
Output Parameters:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: false
  • option – Type: Char, Range: See constants, Default: "x"C
  • min – Type: Integer, Unit: 1/1000 hPa, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/1000 hPa, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetAirPressureCallbackConfiguration().

The following constants are available for this function:

For option:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletBarometerV2.SetAltitudeCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)
Parameters:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: false
  • option – Type: Char, Range: See constants, Default: "x"C
  • min – Type: Integer, Unit: 1 mm, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1 mm, Range: [-231 to 231 - 1], Default: 0

The period is the period with which the AltitudeCallback 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 AltitudeCallback 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:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletBarometerV2.GetAltitudeCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)
Output Parameters:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: false
  • option – Type: Char, Range: See constants, Default: "x"C
  • min – Type: Integer, Unit: 1 mm, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1 mm, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetAltitudeCallbackConfiguration().

The following constants are available for this function:

For option:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletBarometerV2.SetTemperatureCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)
Parameters:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: false
  • option – Type: Char, Range: See constants, Default: "x"C
  • min – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

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:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletBarometerV2.GetTemperatureCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)
Output Parameters:
  • period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: false
  • option – Type: Char, Range: See constants, Default: "x"C
  • min – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetTemperatureCallbackConfiguration().

The following constants are available for this function:

For option:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletBarometerV2.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 BrickletBarometerV2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler barometerV2.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 BrickletBarometerV2.AirPressureCallback(ByVal sender As BrickletBarometerV2, ByVal airPressure As Integer)
Callback Parameters:
  • sender – Type: BrickletBarometerV2
  • airPressure – Type: Integer, Unit: 1/1000 hPa, Range: [260000 to 1260000]

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

The parameter is the same as GetAirPressure().

Event BrickletBarometerV2.AltitudeCallback(ByVal sender As BrickletBarometerV2, ByVal altitude As Integer)
Callback Parameters:
  • sender – Type: BrickletBarometerV2
  • altitude – Type: Integer, Unit: 1 mm, Range: [-231 to 231 - 1]

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

The parameter is the same as GetAltitude().

Event BrickletBarometerV2.TemperatureCallback(ByVal sender As BrickletBarometerV2, ByVal temperature As Integer)
Callback Parameters:
  • sender – Type: BrickletBarometerV2
  • temperature – Type: Integer, Unit: 1/100 °C, Range: [-4000 to 8500]

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

The parameter is the same as GetTemperature().

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 BrickletBarometerV2.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 BrickletBarometerV2.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:

  • BrickletBarometerV2.FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
  • BrickletBarometerV2.FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
  • BrickletBarometerV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BrickletBarometerV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
  • BrickletBarometerV2.FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
  • BrickletBarometerV2.FUNCTION_SET_CALIBRATION = 17
  • BrickletBarometerV2.FUNCTION_SET_SENSOR_CONFIGURATION = 19
  • BrickletBarometerV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletBarometerV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletBarometerV2.FUNCTION_RESET = 243
  • BrickletBarometerV2.FUNCTION_WRITE_UID = 248
Sub BrickletBarometerV2.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:

  • BrickletBarometerV2.FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
  • BrickletBarometerV2.FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
  • BrickletBarometerV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BrickletBarometerV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
  • BrickletBarometerV2.FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
  • BrickletBarometerV2.FUNCTION_SET_CALIBRATION = 17
  • BrickletBarometerV2.FUNCTION_SET_SENSOR_CONFIGURATION = 19
  • BrickletBarometerV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletBarometerV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletBarometerV2.FUNCTION_RESET = 243
  • BrickletBarometerV2.FUNCTION_WRITE_UID = 248
Sub BrickletBarometerV2.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 BrickletBarometerV2.DEVICE_IDENTIFIER

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

Const BrickletBarometerV2.DEVICE_DISPLAY_NAME

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