Delphi/Lazarus - Rotary Encoder Bricklet¶

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

program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletRotaryEncoder;

type
  TExample = class
  private
    ipcon: TIPConnection;
    re: TBrickletRotaryEncoder;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  re := TBrickletRotaryEncoder.Create(UID, ipcon);

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

  { Get current count without reset }
  count := re.GetCount(false);
  WriteLn(Format('Count: %d', [count]));

  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

program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletRotaryEncoder;

type
  TExample = class
  private
    ipcon: TIPConnection;
    re: TBrickletRotaryEncoder;
  public
    procedure CountCB(sender: TBrickletRotaryEncoder; const count: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for count callback }
procedure TExample.CountCB(sender: TBrickletRotaryEncoder; const count: longint);
begin
  WriteLn(Format('Count: %d', [count]));
end;

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

  { Create device object }
  re := TBrickletRotaryEncoder.Create(UID, ipcon);

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

  { Register count callback to procedure CountCB }
  re.OnCount := {$ifdef FPC}@{$endif}CountCB;

  { Set period for count callback to 0.05s (50ms)
    Note: The count callback is only called every 0.05 seconds
          if the count has changed since the last call! }
  re.SetCountCallbackPeriod(50);

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

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

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	rotaryEncoder – Typ: TBrickletRotaryEncoder

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

rotaryEncoder := TBrickletRotaryEncoder.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletRotaryEncoder.GetCount(const reset: boolean): longint¶

Parameter:	reset – Typ: boolean
Rückgabe:	count – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Gibt den aktuellen Zählerwert des Encoders zurück. Wenn reset auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurück gesetzt.

Der Encoder hat 24 Schritte pro Umdrehung.

Wenn der Encoder nach links gedreht wird wird der Zählerwert dekrementiert, d.h. negative Zählerwerte sind möglich.

function TBrickletRotaryEncoder.IsPressed: boolean¶

Rückgabe:	pressed – Typ: boolean

Gibt true zurück wenn der Taster gedrückt ist und sonst false.

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

Fortgeschrittene Funktionen¶

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

Konfigurationsfunktionen für Callbacks¶

procedure TBrickletRotaryEncoder.SetCountCallbackPeriod(const period: longword)¶

Parameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Der OnCount Callback wird nur ausgelöst, wenn sich der Zählerwert seit der letzten Auslösung geändert hat.

function TBrickletRotaryEncoder.GetCountCallbackPeriod: longword¶

Rückgabe:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

procedure TBrickletRotaryEncoder.SetCountCallbackThreshold(const option: char; const min: longint; const max: longint)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: longint, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den OnCountReached Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletRotaryEncoder.GetCountCallbackThreshold(out option: char; out min: longint; out max: longint)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: longint, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_ROTARY_ENCODER_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletRotaryEncoder.SetDebouncePeriod(const debounce: longword)¶

Parameter:	debounce – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher der Schwellwert-Callback

• OnCountReached

ausgelöst wird, wenn der Schwellwert

• SetCountCallbackThreshold

weiterhin erreicht bleibt.

function TBrickletRotaryEncoder.GetDebouncePeriod: longword¶

Rückgabe:	debounce – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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

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

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

property TBrickletRotaryEncoder.OnCount¶

procedure(sender: TBrickletRotaryEncoder; const count: longint) of object;

Callback-Parameter:	sender – Typ: TBrickletRotaryEncoder count – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetCountCallbackPeriod, ausgelöst. Der Parameter ist der Zählerwert des Encoders.

Der OnCount Callback wird nur ausgelöst, wenn sich der Zähler seit der letzten Auslösung geändert hat.

property TBrickletRotaryEncoder.OnCountReached¶

procedure(sender: TBrickletRotaryEncoder; const count: longint) of object;

Callback-Parameter:	sender – Typ: TBrickletRotaryEncoder count – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCountCallbackThreshold gesetzt, erreicht wird. Der Parameter ist der Zählerwert des Encoders.

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

property TBrickletRotaryEncoder.OnPressed¶

procedure(sender: TBrickletRotaryEncoder) of object;

Callback-Parameter:	sender – Typ: TBrickletRotaryEncoder

Dieser Callback wird ausgelöst, wenn der Taster gedrückt wird.

property TBrickletRotaryEncoder.OnReleased¶

procedure(sender: TBrickletRotaryEncoder) of object;

Callback-Parameter:	sender – Typ: TBrickletRotaryEncoder

Dieser Callback wird ausgelöst, wenn der Taster losgelassen wird.

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 TBrickletRotaryEncoder.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 TBrickletRotaryEncoder.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_ROTARY_ENCODER_FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
• BRICKLET_ROTARY_ENCODER_FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
• BRICKLET_ROTARY_ENCODER_FUNCTION_SET_DEBOUNCE_PERIOD = 6

procedure TBrickletRotaryEncoder.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_ROTARY_ENCODER_FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
• BRICKLET_ROTARY_ENCODER_FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
• BRICKLET_ROTARY_ENCODER_FUNCTION_SET_DEBOUNCE_PERIOD = 6

procedure TBrickletRotaryEncoder.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_ROTARY_ENCODER_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Rotary Encoder 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_ROTARY_ENCODER_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Rotary Encoder Bricklet dar.