Visual Basic .NET - Piezo Speaker Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Piezo Speaker Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Piezo Speaker 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).

Beep

Download (ExampleBeep.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Imports System
Imports Tinkerforge

Module ExampleBeep
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Piezo Speaker Bricklet

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

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

        ' Make 2 second beep with a frequency of 1kHz
        ps.Beep(2000, 1000)

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

Morse Code

Download (ExampleMorseCode.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Imports System
Imports Tinkerforge

Module ExampleMorseCode
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Piezo Speaker Bricklet

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

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

        ' Morse SOS with a frequency of 2kHz
        ps.MorseCode("... --- ...", 2000)

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

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

Dim piezoSpeaker As New BrickletPiezoSpeaker("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletPiezoSpeaker.Beep(ByVal duration As Long, ByVal frequency As Integer)

Erzeugt einen Piepton mit der gegebenen Frequenz für die angegebene Dauer in ms. Beispiel: Wenn duration auf 1000 und frequency auf 2000 gesetzt wird, erzeugt der Piezosummer einen Piepton für eine Sekunde mit einer Frequenz von ca. 2 kHz.

Geändert in Version 2.0.2 (Plugin): Eine durarion von 0 stoppt den aktuellen Piepton, das frequency Parameter wird ignoriert. Eine durarion von 4294967295 führt zu einem unendlich langen Piepton.

Das frequency Parameter kann Werte von 585 bis 7100 annehmen.

Das Piezo Speaker Bricklet kann die angegebenen Frequenzen nur approximieren, es wählt die bestmögliche Zuordnung anhand der Kalibrierung (siehe Calibrate()).

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

  • BrickletPiezoSpeaker.BEEP_DURATION_OFF = 0
  • BrickletPiezoSpeaker.BEEP_DURATION_INFINITE = 4294967295
Sub BrickletPiezoSpeaker.MorseCode(ByVal morse As String, ByVal frequency As Integer)

Setzt Morsecode welcher vom Piezosummer abgespielt wird. Der Morsecode wird als Zeichenkette, mit den Zeichen "." (Punkt), "-" (Minus) und " " (Leerzeichen) für kurzes Signale, langes Signale und Pausen. Alle anderen Zeichen werden ignoriert. Der zweite Parameter ist die Frequenz (siehe Beep()).

Beispiel: Wenn die Zeichenkette "...---..." gesetzt wird, gibt der Piezosummer neun Pieptöne aus mit den Dauern "kurz kurz kurz lang lang lang kurz kurz kurz".

Die maximale Zeichenkettenlänge ist 60.

Fortgeschrittene Funktionen

Function BrickletPiezoSpeaker.Calibrate() As Boolean

Das Piezo Speaker Bricklet kann 512 unterschiedliche Töne spielen. Diese Funktion spielt jeden Ton einmal und misst die exakte Frequenz zurück. Das Ergebnis ist eine Zuordnung von Stellwerten zu Frequenzen. Diese Zuordnung wird im EEPROM gespeichert und bei jedem start des Bricklets geladen.

Das Bricklet sollte bei Auslieferung bereits kalibriert sein. Diese Funktion muss lediglich (einmalig) nach jedem neuflashen des Bricklet-Plugins ausgeführt werden.

Gibt true nach Abschluss der Kalibrierung zurück.

Function BrickletPiezoSpeaker.GetAPIVersion() As Byte()

Gibt die Version der API Definition (Major, Minor, Revision) 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 BrickletPiezoSpeaker.GetResponseExpected(ByVal functionId As Byte) As 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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickletPiezoSpeaker.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletPiezoSpeaker.FUNCTION_BEEP = 1
  • BrickletPiezoSpeaker.FUNCTION_MORSE_CODE = 2
Sub BrickletPiezoSpeaker.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletPiezoSpeaker.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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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

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

AddHandler piezoSpeaker.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 BrickletPiezoSpeaker.BeepFinishedCallback(ByVal sender As BrickletPiezoSpeaker)

Dieser Callback wird ausgelöst, wenn ein Piepton, wie von Beep() gesetzt, beendet wurde.

Event BrickletPiezoSpeaker.MorseCodeFinishedCallback(ByVal sender As BrickletPiezoSpeaker)

Dieser Callback wird ausgelöst, wenn die Wiedergabe des Morsecodes, wie von MorseCode() gesetzt, beendet wurde.

Konstanten

Const BrickletPiezoSpeaker.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Piezo Speaker 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 BrickletPiezoSpeaker.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Piezo Speaker Bricklet dar.