Delphi/Lazarus - Piezo Speaker Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Alarm

Download (ExampleAlarm.pas)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
program ExampleAlarm;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletPiezoSpeakerV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ps: TBrickletPiezoSpeakerV2;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Piezo Speaker Bricklet 2.0 }

var
  e: TExample;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  ps := TBrickletPiezoSpeakerV2.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { 10 seconds of loud annoying fast alarm }
  ps.SetAlarm(800, 2000, 10, 1, 10, 10000);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Beep

Download (ExampleBeep.pas)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
program ExampleBeep;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletPiezoSpeakerV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ps: TBrickletPiezoSpeakerV2;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Piezo Speaker Bricklet 2.0 }

var
  e: TExample;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  ps := TBrickletPiezoSpeakerV2.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Make 2 second beep with a frequency of 1kHz }
  ps.SetBeep(1000, 0, 2000);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

API

Da Delphi nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

constructor TBrickletPiezoSpeakerV2.Create(const uid: string; ipcon: TIPConnection)

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

piezoSpeakerV2 := TBrickletPiezoSpeakerV2.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletPiezoSpeakerV2.SetBeep(const frequency: word; const volume: byte; const duration: longword)

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

  • BRICKLET_PIEZO_SPEAKER_V2_BEEP_DURATION_OFF = 0
  • BRICKLET_PIEZO_SPEAKER_V2_BEEP_DURATION_INFINITE = 4294967295
procedure TBrickletPiezoSpeakerV2.GetBeep(out frequency: word; out volume: byte; out duration: longword; out durationRemaining: longword)

Gibt die letzten Beep-Einstellungen zurück, wie von SetBeep 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 UpdateFrequency oder UpdateVolume), gibt diese Funktion die aktualisierten Werte zurück.

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

  • BRICKLET_PIEZO_SPEAKER_V2_BEEP_DURATION_OFF = 0
  • BRICKLET_PIEZO_SPEAKER_V2_BEEP_DURATION_INFINITE = 4294967295
procedure TBrickletPiezoSpeakerV2.SetAlarm(const startFrequency: word; const endFrequency: word; const stepSize: word; const stepDelay: word; const volume: byte; const duration: longword)

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

  • BRICKLET_PIEZO_SPEAKER_V2_ALARM_DURATION_OFF = 0
  • BRICKLET_PIEZO_SPEAKER_V2_ALARM_DURATION_INFINITE = 4294967295
procedure TBrickletPiezoSpeakerV2.GetAlarm(out startFrequency: word; out endFrequency: word; out stepSize: word; out stepDelay: word; out volume: byte; out duration: longword; out durationRemaining: longword; out currentFrequency: word)

Gibt die letzten Alarm-Einstellungen zurück, wie von SetAlarm 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 UpdateVolume), gibt diese Funktion die aktualisierten Werte zurück.

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

  • BRICKLET_PIEZO_SPEAKER_V2_ALARM_DURATION_OFF = 0
  • BRICKLET_PIEZO_SPEAKER_V2_ALARM_DURATION_INFINITE = 4294967295
procedure TBrickletPiezoSpeakerV2.UpdateVolume(const volume: byte)

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

procedure TBrickletPiezoSpeakerV2.UpdateFrequency(const frequency: word)

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

Fortgeschrittene Funktionen

function TBrickletPiezoSpeakerV2.GetAPIVersion: array [0..2] of byte

Gibt die Version der API Definition (Major, Minor, Revision) 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.

function TBrickletPiezoSpeakerV2.GetResponseExpected(const functionId: byte): boolean

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

Siehe SetResponseExpected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

procedure TBrickletPiezoSpeakerV2.SetResponseExpected(const functionId: byte; const responseExpected: boolean)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BRICKLET_PIEZO_SPEAKER_V2_FUNCTION_SET_BEEP = 1
  • BRICKLET_PIEZO_SPEAKER_V2_FUNCTION_SET_ALARM = 3
  • BRICKLET_PIEZO_SPEAKER_V2_FUNCTION_UPDATE_VOLUME = 5
  • BRICKLET_PIEZO_SPEAKER_V2_FUNCTION_UPDATE_FREQUENCY = 6
  • BRICKLET_PIEZO_SPEAKER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_PIEZO_SPEAKER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_PIEZO_SPEAKER_V2_FUNCTION_RESET = 243
  • BRICKLET_PIEZO_SPEAKER_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletPiezoSpeakerV2.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletPiezoSpeakerV2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)

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.

function TBrickletPiezoSpeakerV2.SetBootloaderMode(const mode: byte): byte

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

  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletPiezoSpeakerV2.GetBootloaderMode: byte

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode.

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

  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletPiezoSpeakerV2.SetWriteFirmwarePointer(const pointer: longword)

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

function TBrickletPiezoSpeakerV2.WriteFirmware(const data: array [0..63] of byte): byte

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer 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.

procedure TBrickletPiezoSpeakerV2.SetStatusLEDConfig(const config: byte)

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

  • BRICKLET_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletPiezoSpeakerV2.GetStatusLEDConfig: byte

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig gesetzt.

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

  • BRICKLET_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletPiezoSpeakerV2.GetChipTemperature: smallint

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.

procedure TBrickletPiezoSpeakerV2.Reset

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.

procedure TBrickletPiezoSpeakerV2.WriteUID(const uid: longword)

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.

function TBrickletPiezoSpeakerV2.ReadUID: longword

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

procedure TBrickletPiezoSpeakerV2.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletPiezoSpeakerV2; const param: word);
begin
  WriteLn(param);
end;

piezoSpeakerV2.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

Die verfügbaren Callback Properties und ihre Parametertypen 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.

property TBrickletPiezoSpeakerV2.OnBeepFinished
procedure(sender: TBrickletPiezoSpeakerV2) of object;

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

property TBrickletPiezoSpeakerV2.OnAlarmFinished
procedure(sender: TBrickletPiezoSpeakerV2) of object;

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

Konstanten

const BRICKLET_PIEZO_SPEAKER_V2_DEVICE_IDENTIFIER

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

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_PIEZO_SPEAKER_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Piezo Speaker Bricklet 2.0 dar.