Perl - Piezo Speaker Bricklet

Dies ist die Beschreibung der Perl 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 Perl API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Beep

Download (example_beep.pl)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletPiezoSpeaker;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Piezo Speaker Bricklet

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ps = Tinkerforge::BrickletPiezoSpeaker->new(&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);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Morse Code

Download (example_morse_code.pl)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletPiezoSpeaker;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Piezo Speaker Bricklet

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ps = Tinkerforge::BrickletPiezoSpeaker->new(&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->morse_code("... --- ...", 2000);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

API

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletPiezoSpeaker->new($uid, $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $piezo_speaker – Typ: BrickletPiezoSpeaker

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

$piezo_speaker = BrickletPiezoSpeaker->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletPiezoSpeaker->beep($duration, $frequency)
Parameter:
  • $duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Konstanten
  • $frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
Rückgabe:
  • undef

Erzeugt einen Piepton mit der gegebenen Frequenz für die angegebene Dauer.

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

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:

Für $duration:

  • BrickletPiezoSpeaker->BEEP_DURATION_OFF = 0
  • BrickletPiezoSpeaker->BEEP_DURATION_INFINITE = 4294967295
BrickletPiezoSpeaker->morse_code($morse, $frequency)
Parameter:
  • $morse – Typ: string, Länge: bis zu 60
  • $frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
Rückgabe:
  • undef

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.

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".

Fortgeschrittene Funktionen

BrickletPiezoSpeaker->calibrate()
Rückgabe:
  • $calibration – Typ: bool

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.

BrickletPiezoSpeaker->get_identity()
Rückgabe-Array:
  • 0: $uid – Typ: string, Länge: bis zu 8
  • 1: $connected_uid – Typ: string, Länge: bis zu 8
  • 2: $position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • 3: @hardware_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]
  • 4: @firmware_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]
  • 5: $device_identifier – Typ: int, 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

BrickletPiezoSpeaker->register_callback($callback_id, $function)
Parameter:
  • $callback_id – Typ: int
  • $function – Typ: string
Rückgabe:
  • undef

Registriert den $function Namen für die gegebene $callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

sub my_callback
{
    print "@_[0]";
}

$piezo_speaker->register_callback(BrickletPiezoSpeaker->CALLBACK_EXAMPLE, 'my_callback')

Die Callback Funktion wird dann von einem internen Thread der IP Connection aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch die Dokumentation des threads::shared Perl Moduls für weitere Details.

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletPiezoSpeaker->CALLBACK_BEEP_FINISHED
Callback-Parameter:
  • keine Parameter

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

BrickletPiezoSpeaker->CALLBACK_MORSE_CODE_FINISHED
Callback-Parameter:
  • keine Parameter

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

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.

BrickletPiezoSpeaker->get_api_version()
Rückgabe-Array:
  • 0: @api_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, 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.

BrickletPiezoSpeaker->get_response_expected($function_id)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $response_expected – Typ: bool

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 set_response_expected(). 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 $function_id:

  • BrickletPiezoSpeaker->FUNCTION_BEEP = 1
  • BrickletPiezoSpeaker->FUNCTION_MORSE_CODE = 2
BrickletPiezoSpeaker->set_response_expected($function_id, $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool
Rückgabe:
  • undef

Ä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 $function_id:

  • BrickletPiezoSpeaker->FUNCTION_BEEP = 1
  • BrickletPiezoSpeaker->FUNCTION_MORSE_CODE = 2
BrickletPiezoSpeaker->set_response_expected_all($response_expected)
Parameter:
  • $response_expected – Typ: bool
Rückgabe:
  • undef

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

Konstanten

BrickletPiezoSpeaker->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Piezo Speaker Bricklet zu identifizieren.

Die get_identity() Funktion und der IPConnection->CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletPiezoSpeaker->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Piezo Speaker Bricklet dar.