Delphi/Lazarus - Dual Button Bricklet¶

Callback¶

Download (ExampleCallback.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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletDualButton;

type
  TExample = class
  private
    ipcon: TIPConnection;
    db: TBrickletDualButton;
  public
    procedure StateChangedCB(sender: TBrickletDualButton; const buttonL: byte;
                             const buttonR: byte; const ledL: byte; const ledR: byte);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Dual Button Bricklet }

var
  e: TExample;

{ Callback procedure for state changed callback }
procedure TExample.StateChangedCB(sender: TBrickletDualButton; const buttonL: byte;
                                  const buttonR: byte; const ledL: byte;
                                  const ledR: byte);
begin
  if (buttonL = BRICKLET_DUAL_BUTTON_BUTTON_STATE_PRESSED) then begin
    WriteLn('Left Button: Pressed');
  end
  else if (buttonL = BRICKLET_DUAL_BUTTON_BUTTON_STATE_RELEASED) then begin
    WriteLn('Left Button: Released');
  end;

  if (buttonR = BRICKLET_DUAL_BUTTON_BUTTON_STATE_PRESSED) then begin
    WriteLn('Right Button: Pressed');
  end
  else if (buttonR = BRICKLET_DUAL_BUTTON_BUTTON_STATE_RELEASED) then begin
    WriteLn('Right Button: Released');
  end;

  WriteLn('');
end;

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

  { Create device object }
  db := TBrickletDualButton.Create(UID, ipcon);

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

  { Register state changed callback to procedure StateChangedCB }
  db.OnStateChanged := {$ifdef FPC}@{$endif}StateChangedCB;

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

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

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	dualButton – Typ: TBrickletDualButton

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

dualButton := TBrickletDualButton.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

procedure TBrickletDualButton.SetLEDState(const ledL: byte; const ledR: byte)¶

Parameter:	ledL – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1 ledR – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt den Zustand der LEDs. Möglich Zustände sind:

• 0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
• 1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
• 2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
• 3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit GetLEDState ausgelesen werden oder es kann SetSelectedLEDState genutzt werden.

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

Für ledL:

• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
• BRICKLET_DUAL_BUTTON_LED_STATE_ON = 2
• BRICKLET_DUAL_BUTTON_LED_STATE_OFF = 3

Für ledR:

• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
• BRICKLET_DUAL_BUTTON_LED_STATE_ON = 2
• BRICKLET_DUAL_BUTTON_LED_STATE_OFF = 3

procedure TBrickletDualButton.GetLEDState(out ledL: byte; out ledR: byte)¶

Ausgabeparameter:	ledL – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1 ledR – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den aktuellen Zustand der LEDs zurück, wie von SetLEDState gesetzt.

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

Für ledL:

• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
• BRICKLET_DUAL_BUTTON_LED_STATE_ON = 2
• BRICKLET_DUAL_BUTTON_LED_STATE_OFF = 3

Für ledR:

• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
• BRICKLET_DUAL_BUTTON_LED_STATE_ON = 2
• BRICKLET_DUAL_BUTTON_LED_STATE_OFF = 3

procedure TBrickletDualButton.GetButtonState(out buttonL: byte; out buttonR: byte)¶

Ausgabeparameter:	buttonL – Typ: byte, Wertebereich: Siehe Konstanten buttonR – Typ: byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

• 0 = pressed (gedrückt)
• 1 = released (losgelassen)

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

Für buttonL:

• BRICKLET_DUAL_BUTTON_BUTTON_STATE_PRESSED = 0
• BRICKLET_DUAL_BUTTON_BUTTON_STATE_RELEASED = 1

Für buttonR:

• BRICKLET_DUAL_BUTTON_BUTTON_STATE_PRESSED = 0
• BRICKLET_DUAL_BUTTON_BUTTON_STATE_RELEASED = 1

Fortgeschrittene Funktionen¶

procedure TBrickletDualButton.SetSelectedLEDState(const led: byte; const state: byte)¶

Parameter:	led – Typ: byte, Wertebereich: Siehe Konstanten state – Typ: byte, Wertebereich: Siehe Konstanten

Setzt den Zustand der selektierten LED (0 oder 1).

Die andere LED bleibt unangetastet.

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

Für led:

• BRICKLET_DUAL_BUTTON_LED_LEFT = 0
• BRICKLET_DUAL_BUTTON_LED_RIGHT = 1

Für state:

• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
• BRICKLET_DUAL_BUTTON_LED_STATE_ON = 2
• BRICKLET_DUAL_BUTTON_LED_STATE_OFF = 3

procedure TBrickletDualButton.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)¶

Ausgabeparameter:

uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: word, 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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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: TBrickletDualButton; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

property TBrickletDualButton.OnStateChanged¶

procedure(sender: TBrickletDualButton; const buttonL: byte; const buttonR: byte; const ledL: byte; const ledR: byte) of object;

Callback-Parameter:	sender – Typ: TBrickletDualButton buttonL – Typ: byte, Wertebereich: Siehe Konstanten buttonR – Typ: byte, Wertebereich: Siehe Konstanten ledL – Typ: byte, Wertebereich: Siehe Konstanten ledR – Typ: byte, Wertebereich: Siehe Konstanten

Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

• 0 = pressed (gedrückt)
• 1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

• 0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
• 1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
• 2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
• 3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

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

Für buttonL:

• BRICKLET_DUAL_BUTTON_BUTTON_STATE_PRESSED = 0
• BRICKLET_DUAL_BUTTON_BUTTON_STATE_RELEASED = 1

Für buttonR:

• BRICKLET_DUAL_BUTTON_BUTTON_STATE_PRESSED = 0
• BRICKLET_DUAL_BUTTON_BUTTON_STATE_RELEASED = 1

Für ledL:

• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
• BRICKLET_DUAL_BUTTON_LED_STATE_ON = 2
• BRICKLET_DUAL_BUTTON_LED_STATE_OFF = 3

Für ledR:

• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
• BRICKLET_DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
• BRICKLET_DUAL_BUTTON_LED_STATE_ON = 2
• BRICKLET_DUAL_BUTTON_LED_STATE_OFF = 3

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

function TBrickletDualButton.GetAPIVersion: array [0..2] of byte¶

Ausgabeparameter:	apiVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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 TBrickletDualButton.GetResponseExpected(const functionId: byte): boolean¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: 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.

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

Für functionId:

• BRICKLET_DUAL_BUTTON_FUNCTION_SET_LED_STATE = 1
• BRICKLET_DUAL_BUTTON_FUNCTION_SET_SELECTED_LED_STATE = 5

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

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: 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 Konstanten sind für diese Funktion verfügbar:

Für functionId:

• BRICKLET_DUAL_BUTTON_FUNCTION_SET_LED_STATE = 1
• BRICKLET_DUAL_BUTTON_FUNCTION_SET_SELECTED_LED_STATE = 5

procedure TBrickletDualButton.SetResponseExpectedAll(const responseExpected: boolean)¶

Parameter:	responseExpected – Typ: boolean

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

Konstanten¶

const BRICKLET_DUAL_BUTTON_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Dual Button Bricklet 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_DUAL_BUTTON_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet dar.