Delphi/Lazarus - Tilt Bricklet

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Tilt Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Tilt Bricklet 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).

Simple

Download (ExampleSimple.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
program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletTilt;

type
  TExample = class
  private
    ipcon: TIPConnection;
    t: TBrickletTilt;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  t := TBrickletTilt.Create(UID, ipcon);

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

  { Get current tilt state }
  state := t.GetTiltState;

  if (state = BRICKLET_TILT_TILT_STATE_CLOSED) then begin
    WriteLn('Tilt State: Closed');
  end
  else if (state = BRICKLET_TILT_TILT_STATE_OPEN) then begin
    WriteLn('Tilt State: Open');
  end
  else if (state = BRICKLET_TILT_TILT_STATE_CLOSED_VIBRATING) then begin
    WriteLn('Tilt State: Closed Vibrating');
  end;

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

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

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
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletTilt;

type
  TExample = class
  private
    ipcon: TIPConnection;
    t: TBrickletTilt;
  public
    procedure TiltStateCB(sender: TBrickletTilt; const state: byte);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for tilt state callback }
procedure TExample.TiltStateCB(sender: TBrickletTilt; const state: byte);
begin
  if (state = BRICKLET_TILT_TILT_STATE_CLOSED) then begin
    WriteLn('Tilt State: Closed');
  end
  else if (state = BRICKLET_TILT_TILT_STATE_OPEN) then begin
    WriteLn('Tilt State: Open');
  end
  else if (state = BRICKLET_TILT_TILT_STATE_CLOSED_VIBRATING) then begin
    WriteLn('Tilt State: Closed Vibrating');
  end;
end;

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

  { Create device object }
  t := TBrickletTilt.Create(UID, ipcon);

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

  { Enable tilt state callback }
  t.EnableTiltStateCallback;

  { Register tilt state callback to procedure TiltStateCB }
  t.OnTiltState := {$ifdef FPC}@{$endif}TiltStateCB;

  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 TBrickletTilt.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • tilt – Typ: TBrickletTilt

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

tilt := TBrickletTilt.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletTilt.GetTiltState: byte
Rückgabe:
  • state – Typ: byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:

  • 0 = Closed: Der Ball im Neigungsschalter schließt den Stromkreis.
  • 1 = Open: Der Ball im Neigungsschalter schließt den Stromkreis nicht.
  • 2 = Closed Vibrating: Der Neigungsschalter ist in Bewegung (schnelle Änderungen zwischen open und close).
Tilt-Zustände

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

Für state:

  • BRICKLET_TILT_TILT_STATE_CLOSED = 0
  • BRICKLET_TILT_TILT_STATE_OPEN = 1
  • BRICKLET_TILT_TILT_STATE_CLOSED_VIBRATING = 2

Fortgeschrittene Funktionen

function TBrickletTilt.GetAPIVersion: array [0..2] of byte
Rückgabe:
  • apiVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]

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 TBrickletTilt.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_TILT_FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
  • BRICKLET_TILT_FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
procedure TBrickletTilt.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_TILT_FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
  • BRICKLET_TILT_FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
procedure TBrickletTilt.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.

procedure TBrickletTilt.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
  • hardwareVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of 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 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.

Konfigurationsfunktionen für Callbacks

procedure TBrickletTilt.EnableTiltStateCallback

Aktiviert den OnTiltState Callback.

procedure TBrickletTilt.DisableTiltStateCallback

Deaktiviert den OnTiltState Callback.

function TBrickletTilt.IsTiltStateCallbackEnabled: boolean
Rückgabe:
  • enabled – Typ: boolean

Gibt true zurück wenn der OnTiltState Callback aktiviert ist.

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: TBrickletTilt; const param: word);
begin
  WriteLn(param);
end;

tilt.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 TBrickletTilt.OnTiltState
procedure(sender: TBrickletTilt; const state: byte) of object;
Callback-Parameter:
  • sender – Typ: TBrickletTilt
  • state – Typ: byte, Wertebereich: Siehe Konstanten

Dieser Callback übergibt den aktuellen Tilt-Status. Der Callback wird aufgerufen wenn sich der Status ändert.

Siehe GetTiltState für eine Beschreibung der Zustände.

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

Für state:

  • BRICKLET_TILT_TILT_STATE_CLOSED = 0
  • BRICKLET_TILT_TILT_STATE_OPEN = 1
  • BRICKLET_TILT_TILT_STATE_CLOSED_VIBRATING = 2

Konstanten

const BRICKLET_TILT_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Tilt 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_TILT_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Tilt Bricklet dar.