Shell - Piezo Speaker Bricklet 2.0

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

Alarm

Download (example-alarm.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 2.0

# 10 seconds of loud annoying fast alarm
tinkerforge call piezo-speaker-v2-bricklet $uid set-alarm 800 2000 10 1 10 10000

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 2.0

# Make 2 second beep with a frequency of 1kHz
tinkerforge call piezo-speaker-v2-bricklet $uid set-beep 1000 0 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-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Piezo Speaker Bricklet 2.0 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 2.0 an und endet dann
tinkerforge dispatch piezo-speaker-v2-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Piezo Speaker Bricklet 2.0 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 2.0 an und endet dann
tinkerforge call piezo-speaker-v2-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-v2-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-v2-bricklet <uid> set-beep <frequency> <volume> <duration>
Parameter:
  • <frequency> – Typ: Int, Einheit: 1 Hz, Wertebereich: [50 bis 15000]
  • <volume> – Typ: Int, Wertebereich: [0 bis 10]
  • <duration> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen
Ausgabe:
  • keine Ausgabe

Erzeugt einen Piepton mit der gegebenen Frequenz und Lautstärke für die angegebene Dauer.

Eine duration von 0 stoppt den aktuellen Piepton. Eine duration von 4294967295 führt zu einem unendlich langen Piepton.

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-v2-bricklet <uid> get-beep
Ausgabe:
  • frequency – Typ: Int, Einheit: 1 Hz, Wertebereich: [50 bis 15000]
  • volume – Typ: Int, Wertebereich: [0 bis 10]
  • duration – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen
  • duration-remaining – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt die letzten Beep-Einstellungen zurück, wie von set-beep gesetzt. Wenn ein Beep aktuell läuft, wird auch die verbleibende Zeit des Beeps zurück gegeben.

Wenn die Frequenz oder Lautstärke während eines Beeps aktualisiert wird (mit update-frequency oder update-volume), gibt diese Funktion die aktualisierten Werte zurück.

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-v2-bricklet <uid> set-alarm <start-frequency> <end-frequency> <step-size> <step-delay> <volume> <duration>
Parameter:
  • <start-frequency> – Typ: Int, Einheit: 1 Hz, Wertebereich: [50 bis 14999]
  • <end-frequency> – Typ: Int, Einheit: 1 Hz, Wertebereich: [51 bis 15000]
  • <step-size> – Typ: Int, Einheit: 1 Hz, Wertebereich: [50 bis 14950]
  • <step-delay> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
  • <volume> – Typ: Int, Wertebereich: [0 bis 10]
  • <duration> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen
Ausgabe:
  • keine Ausgabe

Startet einen Alarm (Einen Ton der zwischen zwei spezifizierten Frequenzen hin und her läuft).

Die folgenden Parameter können genutzt werden:

  • Start Frequency: Startfrequenz des Alarms.
  • End Frequency: Endfrequenz des Alarms.
  • Step Size: Schrittgröße eines Schritts im Frequenzdurchlauf zwischen Start-/Endfrequenz.
  • Step Delay: Zeit zwischen zwei Schritten (Dauer eines Tons im Frequenzdurchlauf).
  • Duration: Dauer des Alarm.

Nachfolgend gibt es zwei Beispiele zum ausprobieren. Diese Beispiele können als Startpunkt genutzt werden um ein Alarm-Signal passend für die eigene Anwendung zu entwerfen.

Beispiel 1: 10 Sekunden eines lauten nervigen schnellen Alarms

  • Start Frequency = 800
  • End Frequency = 2000
  • Step Size = 10
  • Step Delay = 1
  • Volume = 10
  • Duration = 10000

Beispiel 2: 10 Sekunden eines Sirenengeräusches mit langsamen Frequenzdurchlauf

  • Start Frequency = 250
  • End Frequency = 750
  • Step Size = 1
  • Step Delay = 5
  • Volume = 0
  • Duration = 10000

Die folgenden Einschränkungen müssen eingehalten werden:

  • Start Frequency: muss kleiner als End Frequency sein
  • End Frequency: muss größer als Start Frequency sein
  • Step Size: muss klein genug sein um in den Frequenzbereich zu passen
  • Step Delay: muss kleiner als Duration sein

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

Für <duration>:

  • alarm-duration-off = 0
  • alarm-duration-infinite = 4294967295
tinkerforge call piezo-speaker-v2-bricklet <uid> get-alarm
Ausgabe:
  • start-frequency – Typ: Int, Einheit: 1 Hz, Wertebereich: [50 bis 14999]
  • end-frequency – Typ: Int, Einheit: 1 Hz, Wertebereich: [51 bis 15000]
  • step-size – Typ: Int, Einheit: 1 Hz, Wertebereich: [50 bis 14950]
  • step-delay – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
  • volume – Typ: Int, Wertebereich: [0 bis 10]
  • duration – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen
  • duration-remaining – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen
  • current-frequency – Typ: Int, Einheit: 1 Hz, Wertebereich: [50 bis 15000]

Gibt die letzten Alarm-Einstellungen zurück, wie von set-alarm gesetzt. Wenn ein Alarm aktuell läuft, wird auch die verbleibende Zeit des Alarms sowie die aktuelle Frequenz zurück gegeben.

Wenn die Lautstärke während eines Alarms aktualisiert wird (mit update-volume), gibt diese Funktion die aktualisierten Werte zurück.

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

Für duration:

  • alarm-duration-off = 0
  • alarm-duration-infinite = 4294967295

Für duration-remaining:

  • alarm-duration-off = 0
  • alarm-duration-infinite = 4294967295
tinkerforge call piezo-speaker-v2-bricklet <uid> update-volume <volume>
Parameter:
  • <volume> – Typ: Int, Wertebereich: [0 bis 10]
Ausgabe:
  • keine Ausgabe

Aktualisiert die Lautstärke eines aktuell laufenden Beep oder Alarm.

tinkerforge call piezo-speaker-v2-bricklet <uid> update-frequency <frequency>
Parameter:
  • <frequency> – Typ: Int, Einheit: 1 Hz, Wertebereich: [50 bis 15000]
Ausgabe:
  • keine Ausgabe

Aktualisiert die Frequenz eines aktuell laufenden Beeps.

Fortgeschrittene Funktionen

tinkerforge call piezo-speaker-v2-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-overflow – Typ: Int, 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.

tinkerforge call piezo-speaker-v2-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • status – Typ: Int, Wertebereich: Siehe Symbole

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

Für <mode>:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

  • bootloader-status-ok = 0
  • bootloader-status-invalid-mode = 1
  • bootloader-status-no-change = 2
  • bootloader-status-entry-function-not-present = 3
  • bootloader-status-device-identifier-incorrect = 4
  • bootloader-status-crc-mismatch = 5
tinkerforge call piezo-speaker-v2-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

Für mode:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4
tinkerforge call piezo-speaker-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

Setzt den Firmware-Pointer für write-firmware. 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.

tinkerforge call piezo-speaker-v2-bricklet <uid> write-firmware <data>
Parameter:
  • <data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:
  • status – Typ: Int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von set-write-firmware-pointer 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.

tinkerforge call piezo-speaker-v2-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

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

Für <config>:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call piezo-speaker-v2-bricklet <uid> get-status-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

Für config:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call piezo-speaker-v2-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature – Typ: Int, 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.

tinkerforge call piezo-speaker-v2-bricklet <uid> reset
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call piezo-speaker-v2-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call piezo-speaker-v2-bricklet <uid> read-uid
Ausgabe:
  • uid – Typ: Int, 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.

tinkerforge call piezo-speaker-v2-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 h, 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-v2-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-v2-bricklet <uid> beep-finished
Ausgabe:
  • keine Ausgabe

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

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

Dieser Callback wird ausgelöst, wenn ein Alarm, wie von set-alarm gesetzt, beendet wurde.