Shell - Piezo Speaker Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Beep

Download (example-beep.sh)

1
2
3
4
5
6
7
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Piezo Speaker Bricklet

# Make 2 second beep with a frequency of 1kHz
tinkerforge call piezo-speaker-bricklet $uid beep 2000 1000

Morse Code

Download (example-morse-code.sh)

1
2
3
4
5
6
7
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Piezo Speaker Bricklet

# Morse SOS with a frequency of 2kHz
tinkerforge call piezo-speaker-bricklet $uid morse-code "... --- ..." 2000

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call piezo-speaker-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Piezo Speaker Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des Piezo Speaker Bricklet an und endet dann
tinkerforge dispatch piezo-speaker-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Piezo Speaker Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des Piezo Speaker Bricklet an und endet dann
tinkerforge call piezo-speaker-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch piezo-speaker-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call piezo-speaker-bricklet <uid> beep <duration> <frequency>
Parameter:
  • <duration> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen
  • <frequency> – Typ: Int, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
Ausgabe:
  • keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <duration>:

  • beep-duration-off = 0
  • beep-duration-infinite = 4294967295
tinkerforge call piezo-speaker-bricklet <uid> morse-code <morse> <frequency>
Parameter:
  • <morse> – Typ: String, Länge: bis zu 60
  • <frequency> – Typ: Int, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
Ausgabe:
  • keine Ausgabe

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

tinkerforge call piezo-speaker-bricklet <uid> calibrate
Ausgabe:
  • 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.

tinkerforge call piezo-speaker-bricklet <uid> get-identity
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connected-uid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: [a bis i, z]
  • hardware-version – Typ: Int Array, 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]
  • firmware-version – Typ: Int Array, 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]
  • 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. 

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch piezo-speaker-bricklet <uid> example

Die verfügbaren Callbacks 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.

tinkerforge dispatch piezo-speaker-bricklet <uid> beep-finished
Ausgabe:
  • keine Ausgabe

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

tinkerforge dispatch piezo-speaker-bricklet <uid> morse-code-finished
Ausgabe:
  • keine Ausgabe

Dieser Callback wird ausgelöst, wenn die Wiedergabe des Morsecodes, wie von morse-code gesetzt, beendet wurde.