Visual Basic .NET - Sound Pressure Level Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Sound Pressure Level Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Sound Pressure Level Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist 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 Pressure Level Bricklet

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

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

        ' Get current decibel
        Dim decibel As Integer = spl.GetDecibel()
        Console.WriteLine("Decibel: " + (decibel/10.0).ToString() + " dB(A)")

        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 Sound Pressure Level Bricklet

    ' Callback subroutine for decibel callback
    Sub DecibelCB(ByVal sender As BrickletSoundPressureLevel, ByVal decibel As Integer)
        Console.WriteLine("Decibel: " + (decibel/10.0).ToString() + " dB(A)")
    End Sub

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

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

        ' Register decibel callback to subroutine DecibelCB
        AddHandler spl.DecibelCallback, AddressOf DecibelCB

        ' Set period for decibel callback to 1s (1000ms) without a threshold
        spl.SetDecibelCallbackConfiguration(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
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 Pressure Level Bricklet

    ' Callback subroutine for decibel callback
    Sub DecibelCB(ByVal sender As BrickletSoundPressureLevel, ByVal decibel As Integer)
        Console.WriteLine("Decibel: " + (decibel/10.0).ToString() + " dB(A)")
    End Sub

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

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

        ' Register decibel callback to subroutine DecibelCB
        AddHandler spl.DecibelCallback, AddressOf DecibelCB

        ' Configure threshold for decibel "greater than 60 dB(A)"
        ' with a debounce period of 1s (1000ms)
        spl.SetDecibelCallbackConfiguration(1000, False, ">"C, 60*10, 0)

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

API

Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

Class BrickletSoundPressureLevel(ByVal uid As String, ByVal ipcon As IPConnection)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

Dim soundPressureLevel As New BrickletSoundPressureLevel("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Function BrickletSoundPressureLevel.GetDecibel() As Integer
Rückgabe:
  • decibel – Typ: Integer, Einheit: 1/10 dB, Wertebereich: [0 bis 120]

Gibt die gemessenen Schalldruck in Dezibel zurück.

Das Bricklet unterstützt die Gewichtungen dB(A), dB(B), dB(C), dB(D), dB(Z) und ITU-R 468. Die Gewichtungsfunktion kann mittels SetConfiguration() gesetzt werden.

Standardmäßig wird dB(A) genutzt.

Wenn der Wert periodisch benötigt wird, kann auch der DecibelCallback Callback verwendet werden. Der Callback wird mit der Funktion SetDecibelCallbackConfiguration() konfiguriert.

Function BrickletSoundPressureLevel.GetSpectrum() As Integer()
Rückgabe:
  • spectrum – Typ: Integer Array, Länge: variabel, Einheit: ? dB, Wertebereich: [0 bis 216 - 1]

Gibt das Frequenzspektrum zurück. Die Länge des Spektrums liegt zwischen 512 (FFT Größe 1024) und 64 (FFT Größe 128). Siehe SetConfiguration().

Jedes Listen-Element ist eine Gruppe des FFTs. Die erste Gruppe stellt immer das DC Offset dar. Die anderen Gruppen haben eine Größe zwischen 40Hz (FFT Größe 1024) und 320Hz (FFT Größe 128).

Der Frequenzbereich des Spektrums besitzt immer einen Umfang von 0 bis 20480Hz (FFT wird auf Samples mit bis zu 40960Hz angewendet).

Die zurückgegebenen Daten sind bereits ausgeglichen, was bedeutet dass der Mikrofon-Frequenzgang kompensiert wurde, und die Gewichtungsfunktion wurde angewendet (siehe SetConfiguration() für die zur Verfügung stehenden Gewichtungen). Für ein ungewichtets Spektrum kann dB(Z) genutzt werden.

Die Daten sind nicht in dB skaliert. Um diese in einer dB Form darzustellen muss die Formel f(x) = 20*log10(max(1, x/sqrt(2))) auf jeden Wert angewendet werden.

Sub BrickletSoundPressureLevel.SetConfiguration(ByVal fftSize As Byte, ByVal weighting As Byte)
Parameter:
  • fftSize – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3
  • weighting – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die Sound Pressure Level Bricklet Konfiguration.

Verschiedene FFT Größen führen zu unterschiedlichen Abtastraten und FFT Größen. Umso größer die FFT Größe ist, umso genauer ist das Ergebnis der dB(X) Berechnung.

Verfügbare FFT Größen sind:

  • 1024: 512 Gruppen, 10 Samples pro Sekunde, jede Gruppe hat Größe 40Hz
  • 512: 256 Gruppen, 20 Samples per Sekunde, jede Gruppe hat Größe 80Hz
  • 256: 128 Gruppen, 40 Samples per Sekunde, jede Gruppe hat Größe 160Hz
  • 128: 64 Gruppen, 80 Samples pro Sekunde, jede Gruppe hat Größe 320Hz

Das Bricklet unterstützt verschiedene Gewichtungsfunktionen. Es kann zwischen dB(A), dB(B), dB(C), dB(D), dB(Z) und ITU-R 468 gewählt werden.

dB(A/B/C/D) sind Standard-Gewichtungskurven. dB(A) wird of genutzt um Lautstärke in Konzerten zu messen. dB(Z) besitzt keine Gewichtung und gibt die Daten ungewichtet zurück. ITU-R 468 ist ein ITU Gewichtungsstandard der hauptsächlich in UK und Europa verwendet wird.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für fftSize:

  • BrickletSoundPressureLevel.FFT_SIZE_128 = 0
  • BrickletSoundPressureLevel.FFT_SIZE_256 = 1
  • BrickletSoundPressureLevel.FFT_SIZE_512 = 2
  • BrickletSoundPressureLevel.FFT_SIZE_1024 = 3

Für weighting:

  • BrickletSoundPressureLevel.WEIGHTING_A = 0
  • BrickletSoundPressureLevel.WEIGHTING_B = 1
  • BrickletSoundPressureLevel.WEIGHTING_C = 2
  • BrickletSoundPressureLevel.WEIGHTING_D = 3
  • BrickletSoundPressureLevel.WEIGHTING_Z = 4
  • BrickletSoundPressureLevel.WEIGHTING_ITU_R_468 = 5
Sub BrickletSoundPressureLevel.GetConfiguration(ByRef fftSize As Byte, ByRef weighting As Byte)
Ausgabeparameter:
  • fftSize – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3
  • weighting – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration, die mittels SetConfiguration() gesetzt werden kann zurück.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für fftSize:

  • BrickletSoundPressureLevel.FFT_SIZE_128 = 0
  • BrickletSoundPressureLevel.FFT_SIZE_256 = 1
  • BrickletSoundPressureLevel.FFT_SIZE_512 = 2
  • BrickletSoundPressureLevel.FFT_SIZE_1024 = 3

Für weighting:

  • BrickletSoundPressureLevel.WEIGHTING_A = 0
  • BrickletSoundPressureLevel.WEIGHTING_B = 1
  • BrickletSoundPressureLevel.WEIGHTING_C = 2
  • BrickletSoundPressureLevel.WEIGHTING_D = 3
  • BrickletSoundPressureLevel.WEIGHTING_Z = 4
  • BrickletSoundPressureLevel.WEIGHTING_ITU_R_468 = 5

Fortgeschrittene Funktionen

Sub BrickletSoundPressureLevel.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Function BrickletSoundPressureLevel.SetBootloaderMode(ByVal mode As Byte) As Byte
Parameter:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: Byte, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

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

Für status:

  • BrickletSoundPressureLevel.BOOTLOADER_STATUS_OK = 0
  • BrickletSoundPressureLevel.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletSoundPressureLevel.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletSoundPressureLevel.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletSoundPressureLevel.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletSoundPressureLevel.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletSoundPressureLevel.GetBootloaderMode() As Byte
Rückgabe:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

  • BrickletSoundPressureLevel.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSoundPressureLevel.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSoundPressureLevel.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSoundPressureLevel.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSoundPressureLevel.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletSoundPressureLevel.SetWriteFirmwarePointer(ByVal pointer As Long)
Parameter:
  • pointer – Typ: Long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Function BrickletSoundPressureLevel.WriteFirmware(ByVal data() As Byte) As Byte
Parameter:
  • data – Typ: Byte Array, Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: Byte, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Sub BrickletSoundPressureLevel.SetStatusLEDConfig(ByVal config As Byte)
Parameter:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

  • BrickletSoundPressureLevel.STATUS_LED_CONFIG_OFF = 0
  • BrickletSoundPressureLevel.STATUS_LED_CONFIG_ON = 1
  • BrickletSoundPressureLevel.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSoundPressureLevel.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletSoundPressureLevel.GetStatusLEDConfig() As Byte
Rückgabe:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

  • BrickletSoundPressureLevel.STATUS_LED_CONFIG_OFF = 0
  • BrickletSoundPressureLevel.STATUS_LED_CONFIG_ON = 1
  • BrickletSoundPressureLevel.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSoundPressureLevel.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletSoundPressureLevel.GetChipTemperature() As Short
Rückgabe:
  • temperature – Typ: Short, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

Sub BrickletSoundPressureLevel.Reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

Sub BrickletSoundPressureLevel.WriteUID(ByVal uid As Long)
Parameter:
  • uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

Function BrickletSoundPressureLevel.ReadUID() As Long
Rückgabe:
  • uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Sub BrickletSoundPressureLevel.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)
Ausgabeparameter:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: ["a"C bis "h"C, "i"C, "z"C]
  • hardwareVersion – Typ: Byte Array, Länge: 3
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte Array, Länge: 3
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Integer, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

Sub BrickletSoundPressureLevel.SetDecibelCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: Integer, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Die Periode ist die Periode mit der der DecibelCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den DecibelCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletSoundPressureLevel.THRESHOLD_OPTION_OFF = "x"C
  • BrickletSoundPressureLevel.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletSoundPressureLevel.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletSoundPressureLevel.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletSoundPressureLevel.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletSoundPressureLevel.GetDecibelCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)
Ausgabeparameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: Boolean, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Integer, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: Integer, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels SetDecibelCallbackConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletSoundPressureLevel.THRESHOLD_OPTION_OFF = "x"C
  • BrickletSoundPressureLevel.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletSoundPressureLevel.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletSoundPressureLevel.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletSoundPressureLevel.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletSoundPressureLevel.SetSpectrumCallbackConfiguration(ByVal period As Long)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Die Periode ist die Periode mit der der SpectrumCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Jedes gemessene Spektrum wird maximal einmal gesendet. Setze die Periode auf 1 um sicher zu stellen das jedes Spektrum gesendet wird.

Function BrickletSoundPressureLevel.GetSpectrumCallbackConfiguration() As Long
Rückgabe:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels GetSpectrumCallbackConfiguration() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletSoundPressureLevel, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler soundPressureLevel.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

Event BrickletSoundPressureLevel.DecibelCallback(ByVal sender As BrickletSoundPressureLevel, ByVal decibel As Integer)
Callback-Parameter:
  • sender – Typ: BrickletSoundPressureLevel
  • decibel – Typ: Integer, Einheit: 1/10 dB, Wertebereich: [0 bis 120]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetDecibelCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie GetDecibel().

Event BrickletSoundPressureLevel.SpectrumCallback(ByVal sender As BrickletSoundPressureLevel, ByVal spectrum() As Integer)
Callback-Parameter:
  • sender – Typ: BrickletSoundPressureLevel
  • spectrum – Typ: Integer Array, Länge: variabel, Einheit: ? dB, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetSpectrumCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie GetSpectrum().

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit Nothing für spectrum ausgelöst.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

Function BrickletSoundPressureLevel.GetAPIVersion() As Byte()
Ausgabeparameter:
  • apiVersion – Typ: Byte Array, Länge: 3
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

Function BrickletSoundPressureLevel.GetResponseExpected(ByVal functionId As Byte) As Boolean
Parameter:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: Boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

  • BrickletSoundPressureLevel.FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
  • BrickletSoundPressureLevel.FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
  • BrickletSoundPressureLevel.FUNCTION_SET_CONFIGURATION = 9
  • BrickletSoundPressureLevel.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSoundPressureLevel.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSoundPressureLevel.FUNCTION_RESET = 243
  • BrickletSoundPressureLevel.FUNCTION_WRITE_UID = 248
Sub BrickletSoundPressureLevel.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)
Parameter:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: Boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

  • BrickletSoundPressureLevel.FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
  • BrickletSoundPressureLevel.FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
  • BrickletSoundPressureLevel.FUNCTION_SET_CONFIGURATION = 9
  • BrickletSoundPressureLevel.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSoundPressureLevel.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSoundPressureLevel.FUNCTION_RESET = 243
  • BrickletSoundPressureLevel.FUNCTION_WRITE_UID = 248
Sub BrickletSoundPressureLevel.SetResponseExpectedAll(ByVal responseExpected As Boolean)
Parameter:
  • responseExpected – Typ: Boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

Const BrickletSoundPressureLevel.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Sound Pressure Level Bricklet zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Const BrickletSoundPressureLevel.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Sound Pressure Level Bricklet dar.