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> -- string
  • <function> -- 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> -- string
  • <callback> -- 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> -- string
  • <function> -- 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> -- string
  • <callback> -- 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> -- int
  • <volume> -- int
  • <duration> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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

Beispiel: Wenn duration auf 1000, volume auf 10 und frequency auf 2000 gesetzt wird, erzeugt der Piezosummer einen Piepton mit maximaler Lautstärke für eine Sekunde mit einer Frequenz von 2 kHz.

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

Die Wertebereiche sind:

  • Frequenz: 50Hz - 15000Hz
  • Lautstärke: 0 - 10
  • Duration: 0ms - 4294967295ms

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

  • beep-duration-off = 0, für <duration>
  • beep-duration-infinite = 4294967295, für <duration>
tinkerforge call piezo-speaker-v2-bricklet <uid> get-beep
Ausgabe:
  • frequency -- int
  • volume -- int
  • duration -- int (hat Symbole)
  • duration-remaining -- int

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:

  • beep-duration-off = 0, für duration
  • beep-duration-infinite = 4294967295, für duration
tinkerforge call piezo-speaker-v2-bricklet <uid> set-alarm <start-frequency> <end-frequency> <step-size> <step-delay> <volume> <duration>
Parameter:
  • <start-frequency> -- int
  • <end-frequency> -- int
  • <step-size> -- int
  • <step-delay> -- int
  • <volume> -- int
  • <duration> -- int (hat Symbole)
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 in Hz.
  • End Frequency: Endfrequenz des Alarms in Hz.
  • Step Size: Schrittgröße eines Schritts im Frequenzdurchlauf zwischen Start-/Endfrequenz in Hz.
  • Step Delay: Zeit zwischen zwei Schritten (Dauer eines Tons im Frequenzdurchlauf) in ms.
  • Duration: Dauer des Alarm in ms

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 Wertebereiche sind:

  • Start Frequency: 50Hz - 14999Hz (muss kleiner als End Frequency sein)
  • End Frequency: 51Hz - 15000Hz (muss größer als Start Frequency sein)
  • Step Size: 1Hz - 65535Hz (muss klein genug sein um in den Frequenzbereich zu passen)
  • Step Delay: 1ms - 65535ms (muss kleiner als Duration sein)
  • Volume: 0 - 10
  • Duration: 0ms - 4294967295ms

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

  • alarm-duration-off = 0, für <duration>
  • alarm-duration-infinite = 4294967295, für <duration>
tinkerforge call piezo-speaker-v2-bricklet <uid> get-alarm
Ausgabe:
  • start-frequency -- int
  • end-frequency -- int
  • step-size -- int
  • step-delay -- int
  • volume -- int
  • duration -- int (hat Symbole)
  • duration-remaining -- int
  • current-frequency -- int

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 in ms sowie die aktuelle Frequenz in Hz 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:

  • alarm-duration-off = 0, für duration
  • alarm-duration-infinite = 4294967295, für duration
tinkerforge call piezo-speaker-v2-bricklet <uid> update-volume <volume>
Parameter:
  • <volume> -- int
Ausgabe:

keine Ausgabe

Aktualisiert die Lautstärke eines aktuell laufenden Beep oder Alarm. Der Wertebereich der Lautstärke ist 0 bis 10.

tinkerforge call piezo-speaker-v2-bricklet <uid> update-frequency <frequency>
Parameter:
  • <frequency> -- int
Ausgabe:

keine Ausgabe

Aktualisiert die Frequenz eines aktuell laufenden Beeps. Der Wertebereich der Frequenz ist 50Hz bis 15000Hz.

Fortgeschrittene Funktionen

tinkerforge call piezo-speaker-v2-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

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> -- int (hat Symbole)
Ausgabe:
  • status -- int (hat 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 Bootlodaer- 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:

  • bootloader-mode-bootloader = 0, für <mode>
  • bootloader-mode-firmware = 1, für <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, für <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, für <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für <mode>
  • bootloader-status-ok = 0, für status
  • bootloader-status-invalid-mode = 1, für status
  • bootloader-status-no-change = 2, für status
  • bootloader-status-entry-function-not-present = 3, für status
  • bootloader-status-device-identifier-incorrect = 4, für status
  • bootloader-status-crc-mismatch = 5, für status
tinkerforge call piezo-speaker-v2-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode -- int (hat Symbole)

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

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

  • bootloader-mode-bootloader = 0, für mode
  • bootloader-mode-firmware = 1, für mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, für mode
  • bootloader-mode-firmware-wait-for-reboot = 3, für mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für mode
tinkerforge call piezo-speaker-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> -- int
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> -- int,int,..61x..,int
Ausgabe:
  • status -- int

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> -- int (hat Symbole)
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:

  • status-led-config-off = 0, für <config>
  • status-led-config-on = 1, für <config>
  • status-led-config-show-heartbeat = 2, für <config>
  • status-led-config-show-status = 3, für <config>
tinkerforge call piezo-speaker-v2-bricklet <uid> get-status-led-config
Ausgabe:
  • config -- int (hat Symbole)

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

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

  • status-led-config-off = 0, für config
  • status-led-config-on = 1, für config
  • status-led-config-show-heartbeat = 2, für config
  • status-led-config-show-status = 3, für config
tinkerforge call piezo-speaker-v2-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature -- int

Gibt die Temperatur in °C, 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> -- int
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 -- int

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 -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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. 

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.