Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Segment Display 4x7 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Segment Display 4x7 Bricklet 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 53 54 55 56 57 58 59 | program ExampleSimple;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletSegmentDisplay4x7;
type
TExample = class
private
ipcon: TIPConnection;
sd: TBrickletSegmentDisplay4x7;
public
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your Segment Display 4x7 Bricklet }
DIGITS : array [0..15] of byte = ($3f,$06,$5b,$4f,
$66,$6d,$7d,$07,
$7f,$6f,$77,$7c,
$39,$5e,$79,$71);
var
e: TExample;
procedure TExample.Execute;
var segments: array [0..3] of byte;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
sd := TBrickletSegmentDisplay4x7.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Write "4223" to the display with full brightness without colon }
segments[0] := DIGITS[4];
segments[1] := DIGITS[2];
segments[2] := DIGITS[2];
segments[3] := DIGITS[3];
sd.SetSegments(segments, 7, false);
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.
TBrickletSegmentDisplay4x7.
Create
(const uid: string; ipcon: TIPConnection)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
segmentDisplay4x7 := TBrickletSegmentDisplay4x7.Create('YOUR_DEVICE_UID', ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
TBrickletSegmentDisplay4x7.
SetSegments
(const segments: array [0..3] of byte; const brightness: byte; const colon: boolean)¶Parameter: |
|
---|
Die 7-Segment-Anzeige kann mit Bitmaps gesetzt werden. Jedes Bit kontrolliert ein Segment:
Beispiel: Um eine "5" auf der Anzeige darzustellen müssen die Segment 0, 2, 3, 5 und 6 aktiviert werden. Dies kann mit der Zahl 0b01101101 = 0x6d = 109 repräsentiert werden.
Die Helligkeit kann zwischen 0 (dunkel) und 7 (hell) gesetzt werden. Der dritte Parameter aktiviert/deaktiviert den Doppelpunkt auf der Anzeige.
TBrickletSegmentDisplay4x7.
GetSegments
(out segments: array [0..3] of byte; out brightness: byte; out colon: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Segment-, Helligkeit- und Doppelpunktdaten zurück, wie von
SetSegments
gesetzt.
TBrickletSegmentDisplay4x7.
StartCounter
(const valueFrom: smallint; const valueTo: smallint; const increment: smallint; const length: longword)¶Parameter: |
|
---|
Starter einen Zähler mit dem from Wert der bis zum to Wert Zählt mit einer Schrittweite von increment. Das Argument length ist die Länge der Pause zwischen zwei Inkrements.
Beispiel: Wenn from auf 0, to auf 100, increment auf 1 und length auf 1000 gesetzt wird, wird ein Zähler gestartet der von 0 bis 100 zählt mit Rate von einer Sekunde zwischen jeder Erhöhung.
Wenn das increment negativ ist läuft der Zähler rückwärts.
Der Zähler kann jederzeit durch einen Aufruf von SetSegments
gestoppt werden.
TBrickletSegmentDisplay4x7.
GetCounterValue
: word¶Rückgabe: |
|
---|
Gibt den aktuellen Zählerstand zurück der auf der Anzeige angezeigt wird.
Wenn kein Zähler am laufen ist wird eine 0 zurückgegeben.
TBrickletSegmentDisplay4x7.
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.
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: TBrickletSegmentDisplay4x7; const value: longint); begin WriteLn(Format('Value: %d', [value])); end; segmentDisplay4x7.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.
TBrickletSegmentDisplay4x7.
OnCounterFinished
¶procedure(sender: TBrickletSegmentDisplay4x7) of object;
Callback-Parameter: |
|
---|
Diese Callback wird ausgelöst, wenn der Zähler (siehe StartCounter
)
fertig ist.
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.
TBrickletSegmentDisplay4x7.
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.
TBrickletSegmentDisplay4x7.
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:
TBrickletSegmentDisplay4x7.
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:
TBrickletSegmentDisplay4x7.
SetResponseExpectedAll
(const responseExpected: boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BRICKLET_SEGMENT_DISPLAY_4X7_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Segment Display 4x7 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.
BRICKLET_SEGMENT_DISPLAY_4X7_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Segment Display 4x7 Bricklet dar.