TCP/IP - Piezo Speaker Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das Piezo Speaker Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Piezo Speaker Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletPiezoSpeaker.beep
Funktions-ID:
  • 1
Anfrage:
  • duration – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 232 - 1 bis] mit Bedeutungen
  • frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
Antwort:
  • keine Antwort

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, das 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für duration:

  • 0 = Off
  • 4294967295 = Infinite
BrickletPiezoSpeaker.morse_code
Funktions-ID:
  • 2
Anfrage:
  • morse – Typ: char[60]
  • frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
Antwort:
  • keine Antwort

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
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char
  • hardware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Callbacks

BrickletPiezoSpeaker.CALLBACK_BEEP_FINISHED
Funktions-ID:
  • 4
Antwort:
  • keine Nutzdaten

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

BrickletPiezoSpeaker.CALLBACK_MORSE_CODE_FINISHED
Funktions-ID:
  • 5
Antwort:
  • keine Nutzdaten

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