Visual Basic .NET - Sound Intensity Bricklet

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

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

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

        ' Get current intensity
        Dim intensity As Integer = si.GetIntensity()
        Console.WriteLine("Intensity: " + intensity.ToString())

        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 Sound Intensity Bricklet

    ' Callback subroutine for intensity callback
    Sub IntensityCB(ByVal sender As BrickletSoundIntensity, ByVal intensity As Integer)
        Console.WriteLine("Intensity: " + intensity.ToString())
    End Sub

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

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

        ' Register intensity callback to subroutine IntensityCB
        AddHandler si.IntensityCallback, AddressOf IntensityCB

        ' Set period for intensity callback to 0.05s (50ms)
        ' Note: The intensity callback is only called every 0.05 seconds
        '       if the intensity has changed since the last call!
        si.SetIntensityCallbackPeriod(50)

        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 Sound Intensity Bricklet

    ' Callback subroutine for intensity reached callback
    Sub IntensityReachedCB(ByVal sender As BrickletSoundIntensity, _
                           ByVal intensity As Integer)
        Console.WriteLine("Intensity: " + intensity.ToString())
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim si As New BrickletSoundIntensity(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 1 second (1000ms)
        si.SetDebouncePeriod(1000)

        ' Register intensity reached callback to subroutine IntensityReachedCB
        AddHandler si.IntensityReachedCallback, AddressOf IntensityReachedCB

        ' Configure threshold for intensity "greater than 2000"
        si.SetIntensityCallbackThreshold(">"C, 2000, 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 BrickletSoundIntensity(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim soundIntensity As New BrickletSoundIntensity("YOUR_DEVICE_UID", ipcon)

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

Function BrickletSoundIntensity.GetIntensity() As Integer

Returns the current sound intensity. The value has a range of 0 to 4095.

The value corresponds to the upper envelop of the signal of the microphone capsule.

If you want to get the intensity periodically, it is recommended to use the IntensityCallback callback and set the period with SetIntensityCallbackPeriod().

Advanced Functions

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

  • BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2
  • BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4
  • BrickletSoundIntensity.FUNCTION_SET_DEBOUNCE_PERIOD = 6
Sub BrickletSoundIntensity.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

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

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

The IntensityCallback callback is only triggered if the intensity has changed since the last triggering.

The default value is 0.

Function BrickletSoundIntensity.GetIntensityCallbackPeriod() As Long

Returns the period as set by SetIntensityCallbackPeriod().

Sub BrickletSoundIntensity.SetIntensityCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Sets the thresholds for the IntensityReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

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

Returns the threshold as set by SetIntensityCallbackThreshold().

The following constants are available for this function:

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

Sets the period in ms with which the threshold callback

is triggered, if the thresholds

keeps being reached.

The default value is 100.

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

AddHandler soundIntensity.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 BrickletSoundIntensity.IntensityCallback(ByVal sender As BrickletSoundIntensity, ByVal intensity As Integer)

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

The IntensityCallback callback is only triggered if the intensity has changed since the last triggering.

Event BrickletSoundIntensity.IntensityReachedCallback(ByVal sender As BrickletSoundIntensity, ByVal intensity As Integer)

This callback is triggered when the threshold as set by SetIntensityCallbackThreshold() is reached. The parameter is the intensity of the encoder.

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

Constants

Const BrickletSoundIntensity.DEVICE_IDENTIFIER

This constant is used to identify a Sound Intensity 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 BrickletSoundIntensity.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Sound Intensity Bricklet.