Delphi/Lazarus - Joystick Bricklet

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

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

uses
  SysUtils, IPConnection, BrickletJoystick;

type
  TExample = class
  private
    ipcon: TIPConnection;
    j: TBrickletJoystick;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var x, y: smallint;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  j := TBrickletJoystick.Create(UID, ipcon);

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

  { Get current position }
  j.GetPosition(x, y);

  WriteLn(Format('Position [X]: %d', [x]));
  WriteLn(Format('Position [Y]: %d', [y]));

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

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

uses
  SysUtils, IPConnection, BrickletJoystick;

type
  TExample = class
  private
    ipcon: TIPConnection;
    j: TBrickletJoystick;
  public
    procedure PressedCB(sender: TBrickletJoystick);
    procedure ReleasedCB(sender: TBrickletJoystick);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for pressed callback }
procedure TExample.PressedCB(sender: TBrickletJoystick);
begin
  WriteLn('Pressed');
end;

{ Callback procedure for released callback }
procedure TExample.ReleasedCB(sender: TBrickletJoystick);
begin
  WriteLn('Released');
end;

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

  { Create device object }
  j := TBrickletJoystick.Create(UID, ipcon);

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

  { Register pressed callback to procedure PressedCB }
  j.OnPressed := {$ifdef FPC}@{$endif}PressedCB;

  { Register released callback to procedure ReleasedCB }
  j.OnReleased := {$ifdef FPC}@{$endif}ReleasedCB;

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

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

Find Borders

Download (ExampleFindBorders.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
75
76
77
program ExampleFindBorders;

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

uses
  SysUtils, IPConnection, BrickletJoystick;

type
  TExample = class
  private
    ipcon: TIPConnection;
    j: TBrickletJoystick;
  public
    procedure PositionReachedCB(sender: TBrickletJoystick; const x: smallint;
                                const y: smallint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for position reached callback }
procedure TExample.PositionReachedCB(sender: TBrickletJoystick; const x: smallint;
                                     const y: smallint);
begin
  if (y = 100) then begin
    WriteLn('Top');
  end
  else if (y = -100) then begin
    WriteLn('Bottom');
  end;
  if (x = 100) then begin
    WriteLn('Right');
  end
  else if (x = -100) then begin
    WriteLn('Left');
  end;
  WriteLn('');
end;

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

  { Create device object }
  j := TBrickletJoystick.Create(UID, ipcon);

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

  { Get threshold callbacks with a debounce time of 0.2 seconds (200ms) }
  j.SetDebouncePeriod(200);

  { Register position reached callback to procedure PositionReachedCB }
  j.OnPositionReached := {$ifdef FPC}@{$endif}PositionReachedCB;

  { Configure threshold for position "outside of -99, -99 to 99, 99" }
  j.SetPositionCallbackThreshold('o', -99, 99, -99, 99);

  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 TBrickletJoystick.Create(const uid: string; ipcon: TIPConnection)

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

joystick := TBrickletJoystick.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletJoystick.GetPosition(out x: smallint; out y: smallint)

Gibt die Position des Joystick zurück. Der Wertebereich ist von -100 bis 100 für beide Achsen. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe Calibrate).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den OnPosition Callback zu nutzen und die Periode mit SetPositionCallbackPeriod vorzugeben.

function TBrickletJoystick.IsPressed: boolean

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Es wird empfohlen die OnPressed und OnReleased Callbacks zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen

procedure TBrickletJoystick.GetAnalogValue(out x: word; out y: word)

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von GetPosition zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den OnAnalogValue Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod vorzugeben.

procedure TBrickletJoystick.Calibrate

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

function TBrickletJoystick.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 TBrickletJoystick.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.

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

  • BRICKLET_JOYSTICK_FUNCTION_CALIBRATE = 4
  • BRICKLET_JOYSTICK_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
  • BRICKLET_JOYSTICK_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BRICKLET_JOYSTICK_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
  • BRICKLET_JOYSTICK_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BRICKLET_JOYSTICK_FUNCTION_SET_DEBOUNCE_PERIOD = 13
procedure TBrickletJoystick.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 Konstanten sind für diese Funktion verfügbar:

  • BRICKLET_JOYSTICK_FUNCTION_CALIBRATE = 4
  • BRICKLET_JOYSTICK_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
  • BRICKLET_JOYSTICK_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BRICKLET_JOYSTICK_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
  • BRICKLET_JOYSTICK_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BRICKLET_JOYSTICK_FUNCTION_SET_DEBOUNCE_PERIOD = 13
procedure TBrickletJoystick.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletJoystick.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.

Konfigurationsfunktionen für Callbacks

procedure TBrickletJoystick.SetPositionCallbackPeriod(const period: longword)

Setzt die Periode in ms mit welcher der OnPosition Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

The OnPosition Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

function TBrickletJoystick.GetPositionCallbackPeriod: longword

Gibt die Periode zurück, wie von SetPositionCallbackPeriod gesetzt.

procedure TBrickletJoystick.SetAnalogValueCallbackPeriod(const period: longword)

Setzt die Periode in ms mit welcher der OnAnalogValue Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der OnAnalogValue Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

function TBrickletJoystick.GetAnalogValueCallbackPeriod: longword

Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod gesetzt.

procedure TBrickletJoystick.SetPositionCallbackThreshold(const option: char; const minX: smallint; const maxX: smallint; const minY: smallint; const maxY: smallint)

Setzt den Schwellwert für den OnPositionReached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Position außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Position innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Position kleiner als die min Werte ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Position größer als die min Werte ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0, 0, 0).

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

  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletJoystick.GetPositionCallbackThreshold(out option: char; out minX: smallint; out maxX: smallint; out minY: smallint; out maxY: smallint)

Gibt den Schwellwert zurück, wie von SetPositionCallbackThreshold gesetzt.

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

  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletJoystick.SetAnalogValueCallbackThreshold(const option: char; const minX: word; const maxX: word; const minY: word; const maxY: word)

Setzt den Schwellwert für den OnAnalogValueReached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Analogwerte außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Analogwerte innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Analogwerte kleiner als die min Werte ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Analogwerte größer als die min Werte ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0, 0, 0).

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

  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletJoystick.GetAnalogValueCallbackThreshold(out option: char; out minX: word; out maxX: word; out minY: word; out maxY: word)

Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold gesetzt.

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

  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_JOYSTICK_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletJoystick.SetDebouncePeriod(const debounce: longword)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

function TBrickletJoystick.GetDebouncePeriod: longword

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod gesetzt.

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

joystick.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 TBrickletJoystick.OnPosition
procedure(sender: TBrickletJoystick; const x: smallint; const y: smallint) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetPositionCallbackPeriod, ausgelöst. Der Parameter ist die Position des Joysticks.

Der OnPosition Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

property TBrickletJoystick.OnAnalogValue
procedure(sender: TBrickletJoystick; const x: word; const y: word) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod, ausgelöst. Der Parameter sind die Analogwerte des Joysticks.

Der OnAnalogValue Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

property TBrickletJoystick.OnPositionReached
procedure(sender: TBrickletJoystick; const x: smallint; const y: smallint) of object;

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetPositionCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Position des Joysticks.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod gesetzt, ausgelöst.

property TBrickletJoystick.OnAnalogValueReached
procedure(sender: TBrickletJoystick; const x: word; const y: word) of object;

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAnalogValueCallbackThreshold gesetzt, erreicht wird. Der Parameter sind die Analogwerte des Joystick.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod gesetzt, ausgelöst.

property TBrickletJoystick.OnPressed
procedure(sender: TBrickletJoystick) of object;

Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.

property TBrickletJoystick.OnReleased
procedure(sender: TBrickletJoystick) of object;

Dieser Callback wird ausgelöst, wenn die Taste losgelassen wird.

Konstanten

const BRICKLET_JOYSTICK_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Joystick 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_JOYSTICK_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.