Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Rotary Poti Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Rotary Poti Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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, BrickletRotaryPotiV2;
type
TExample = class
private
ipcon: TIPConnection;
rp: TBrickletRotaryPotiV2;
public
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your Rotary Poti Bricklet 2.0 }
var
e: TExample;
procedure TExample.Execute;
var position: smallint;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
rp := TBrickletRotaryPotiV2.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Get current position }
position := rp.GetPosition;
WriteLn(Format('Position: %d °', [position]));
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
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 | program ExampleCallback;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletRotaryPotiV2;
type
TExample = class
private
ipcon: TIPConnection;
rp: TBrickletRotaryPotiV2;
public
procedure PositionCB(sender: TBrickletRotaryPotiV2; const position: smallint);
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your Rotary Poti Bricklet 2.0 }
var
e: TExample;
{ Callback procedure for position callback }
procedure TExample.PositionCB(sender: TBrickletRotaryPotiV2; const position: smallint);
begin
WriteLn(Format('Position: %d °', [position]));
end;
procedure TExample.Execute;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
rp := TBrickletRotaryPotiV2.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Register position callback to procedure PositionCB }
rp.OnPosition := {$ifdef FPC}@{$endif}PositionCB;
{ Set period for position callback to 0.25s (250ms) without a threshold }
rp.SetPositionCallbackConfiguration(250, false, 'x', 0, 0);
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
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.
TBrickletRotaryPotiV2.
Create
(const uid: string; ipcon: TIPConnection)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
rotaryPotiV2 := TBrickletRotaryPotiV2.Create('YOUR_DEVICE_UID', ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
TBrickletRotaryPotiV2.
GetPosition
: smallint¶Rückgabe: |
|
---|
Gibt die Position des Drehpotentiometers zurück. Der Wertebereich ist von -150° (links gedreht) und 150° (rechts gedreht).
Wenn der Wert periodisch benötigt wird, kann auch der OnPosition
Callback
verwendet werden. Der Callback wird mit der Funktion
SetPositionCallbackConfiguration
konfiguriert.
TBrickletRotaryPotiV2.
GetSPITFPErrorCount
(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶Ausgabeparameter: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
TBrickletRotaryPotiV2.
SetStatusLEDConfig
(const config: byte)¶Parameter: |
|
---|
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:
Für config:
TBrickletRotaryPotiV2.
GetStatusLEDConfig
: byte¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
TBrickletRotaryPotiV2.
GetChipTemperature
: smallint¶Rückgabe: |
|
---|
Gibt die Temperatur, 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.
TBrickletRotaryPotiV2.
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.
TBrickletRotaryPotiV2.
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: |
|
---|
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.
TBrickletRotaryPotiV2.
SetPositionCallbackConfiguration
(const period: longword; const valueHasToChange: boolean; const option: char; const min: smallint; const max: smallint)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnPosition
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den OnPosition
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
TBrickletRotaryPotiV2.
GetPositionCallbackConfiguration
(out period: longword; out valueHasToChange: boolean; out option: char; out min: smallint; out max: smallint)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetPositionCallbackConfiguration
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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: TBrickletRotaryPotiV2; const value: longint); begin WriteLn(Format('Value: %d', [value])); end; rotaryPotiV2.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.
TBrickletRotaryPotiV2.
OnPosition
¶procedure(sender: TBrickletRotaryPotiV2; const position: smallint) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
SetPositionCallbackConfiguration
gesetzten Konfiguration
Der Parameter ist der gleiche wie GetPosition
.
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.
TBrickletRotaryPotiV2.
GetAPIVersion
: array [0..2] of byte¶Ausgabeparameter: |
|
---|
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.
TBrickletRotaryPotiV2.
GetResponseExpected
(const functionId: byte): boolean¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
TBrickletRotaryPotiV2.
SetResponseExpected
(const functionId: byte; const responseExpected: boolean)¶Parameter: |
|
---|
Ä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:
TBrickletRotaryPotiV2.
SetResponseExpectedAll
(const responseExpected: boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
TBrickletRotaryPotiV2.
SetBootloaderMode
(const mode: byte): byte¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Bootloader- 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:
Für mode:
Für status:
TBrickletRotaryPotiV2.
GetBootloaderMode
: byte¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
TBrickletRotaryPotiV2.
SetWriteFirmwarePointer
(const pointer: longword)¶Parameter: |
|
---|
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.
TBrickletRotaryPotiV2.
WriteFirmware
(const data: array [0..63] of byte): byte¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
TBrickletRotaryPotiV2.
WriteUID
(const uid: longword)¶Parameter: |
|
---|
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.
TBrickletRotaryPotiV2.
ReadUID
: longword¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BRICKLET_ROTARY_POTI_V2_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Rotary Poti 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.
BRICKLET_ROTARY_POTI_V2_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Rotary Poti Bricklet 2.0 dar.