Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Analog In Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Analog In 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).
1program ExampleSimple;
2
3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
5
6uses
7 SysUtils, IPConnection, BrickletAnalogIn;
8
9type
10 TExample = class
11 private
12 ipcon: TIPConnection;
13 ai: TBrickletAnalogIn;
14 public
15 procedure Execute;
16 end;
17
18const
19 HOST = 'localhost';
20 PORT = 4223;
21 UID = 'XYZ'; { Change XYZ to the UID of your Analog In Bricklet }
22
23var
24 e: TExample;
25
26procedure TExample.Execute;
27var voltage: word;
28begin
29 { Create IP connection }
30 ipcon := TIPConnection.Create;
31
32 { Create device object }
33 ai := TBrickletAnalogIn.Create(UID, ipcon);
34
35 { Connect to brickd }
36 ipcon.Connect(HOST, PORT);
37 { Don't use device before ipcon is connected }
38
39 { Get current voltage }
40 voltage := ai.GetVoltage;
41 WriteLn(Format('Voltage: %f V', [voltage/1000.0]));
42
43 WriteLn('Press key to exit');
44 ReadLn;
45 ipcon.Destroy; { Calls ipcon.Disconnect internally }
46end;
47
48begin
49 e := TExample.Create;
50 e.Execute;
51 e.Destroy;
52end.
Download (ExampleCallback.pas)
1program ExampleCallback;
2
3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
5
6uses
7 SysUtils, IPConnection, BrickletAnalogIn;
8
9type
10 TExample = class
11 private
12 ipcon: TIPConnection;
13 ai: TBrickletAnalogIn;
14 public
15 procedure VoltageCB(sender: TBrickletAnalogIn; const voltage: word);
16 procedure Execute;
17 end;
18
19const
20 HOST = 'localhost';
21 PORT = 4223;
22 UID = 'XYZ'; { Change XYZ to the UID of your Analog In Bricklet }
23
24var
25 e: TExample;
26
27{ Callback procedure for voltage callback }
28procedure TExample.VoltageCB(sender: TBrickletAnalogIn; const voltage: word);
29begin
30 WriteLn(Format('Voltage: %f V', [voltage/1000.0]));
31end;
32
33procedure TExample.Execute;
34begin
35 { Create IP connection }
36 ipcon := TIPConnection.Create;
37
38 { Create device object }
39 ai := TBrickletAnalogIn.Create(UID, ipcon);
40
41 { Connect to brickd }
42 ipcon.Connect(HOST, PORT);
43 { Don't use device before ipcon is connected }
44
45 { Register voltage callback to procedure VoltageCB }
46 ai.OnVoltage := {$ifdef FPC}@{$endif}VoltageCB;
47
48 { Set period for voltage callback to 1s (1000ms)
49 Note: The voltage callback is only called every second
50 if the voltage has changed since the last call! }
51 ai.SetVoltageCallbackPeriod(1000);
52
53 WriteLn('Press key to exit');
54 ReadLn;
55 ipcon.Destroy; { Calls ipcon.Disconnect internally }
56end;
57
58begin
59 e := TExample.Create;
60 e.Execute;
61 e.Destroy;
62end.
Download (ExampleThreshold.pas)
1program ExampleThreshold;
2
3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
5
6uses
7 SysUtils, IPConnection, BrickletAnalogIn;
8
9type
10 TExample = class
11 private
12 ipcon: TIPConnection;
13 ai: TBrickletAnalogIn;
14 public
15 procedure VoltageReachedCB(sender: TBrickletAnalogIn; const voltage: word);
16 procedure Execute;
17 end;
18
19const
20 HOST = 'localhost';
21 PORT = 4223;
22 UID = 'XYZ'; { Change XYZ to the UID of your Analog In Bricklet }
23
24var
25 e: TExample;
26
27{ Callback procedure for voltage reached callback }
28procedure TExample.VoltageReachedCB(sender: TBrickletAnalogIn; const voltage: word);
29begin
30 WriteLn(Format('Voltage: %f V', [voltage/1000.0]));
31end;
32
33procedure TExample.Execute;
34begin
35 { Create IP connection }
36 ipcon := TIPConnection.Create;
37
38 { Create device object }
39 ai := TBrickletAnalogIn.Create(UID, ipcon);
40
41 { Connect to brickd }
42 ipcon.Connect(HOST, PORT);
43 { Don't use device before ipcon is connected }
44
45 { Get threshold callbacks with a debounce time of 10 seconds (10000ms) }
46 ai.SetDebouncePeriod(10000);
47
48 { Register voltage reached callback to procedure VoltageReachedCB }
49 ai.OnVoltageReached := {$ifdef FPC}@{$endif}VoltageReachedCB;
50
51 { Configure threshold for voltage "smaller than 5 V" }
52 ai.SetVoltageCallbackThreshold('<', 5*1000, 0);
53
54 WriteLn('Press key to exit');
55 ReadLn;
56 ipcon.Destroy; { Calls ipcon.Disconnect internally }
57end;
58
59begin
60 e := TExample.Create;
61 e.Execute;
62 e.Destroy;
63end.
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
analogIn := TBrickletAnalogIn.Create('YOUR_DEVICE_UID', ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Rückgabe: |
|
|---|
Gibt die gemessene Spannung des Sensors zurück. Die Auflösung im Bereich 0 bis 6V beträgt rund 2mV. Zwischen 6 und 45V ist die Auflösung rund 10mV.
Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen
den OnVoltage Callback zu nutzen und die Periode mit
SetVoltageCallbackPeriod vorzugeben.
| Parameter: |
|
|---|
Setzt den Messbereich. Mögliche Bereiche:
0: Automatisch geschaltet
1: 0V - 6,05V, ~1,48mV Auflösung
2: 0V - 10,32V, ~2,52mV Auflösung
3: 0V - 36,30V, ~8,86mV Auflösung
4: 0V - 45,00V, ~11,25mV Auflösung
5: 0V - 3,3V, ~0,81mV Auflösung, neu in Version 2.0.3$nbsp;(Plugin)
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für range:
BRICKLET_ANALOG_IN_RANGE_AUTOMATIC = 0
BRICKLET_ANALOG_IN_RANGE_UP_TO_6V = 1
BRICKLET_ANALOG_IN_RANGE_UP_TO_10V = 2
BRICKLET_ANALOG_IN_RANGE_UP_TO_36V = 3
BRICKLET_ANALOG_IN_RANGE_UP_TO_45V = 4
BRICKLET_ANALOG_IN_RANGE_UP_TO_3V = 5
Added in version 2.0.1$nbsp;(Plugin).
| Rückgabe: |
|
|---|
Gibt den Messbereich zurück, wie von SetRange gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für range:
BRICKLET_ANALOG_IN_RANGE_AUTOMATIC = 0
BRICKLET_ANALOG_IN_RANGE_UP_TO_6V = 1
BRICKLET_ANALOG_IN_RANGE_UP_TO_10V = 2
BRICKLET_ANALOG_IN_RANGE_UP_TO_36V = 3
BRICKLET_ANALOG_IN_RANGE_UP_TO_45V = 4
BRICKLET_ANALOG_IN_RANGE_UP_TO_3V = 5
Added in version 2.0.1$nbsp;(Plugin).
| Rückgabe: |
|
|---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von GetVoltage 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 der Analogwert periodisch abgefragt werden soll, wird empfohlen
den OnAnalogValue Callback zu nutzen und die Periode mit
SetAnalogValueCallbackPeriod vorzugeben.
| Parameter: |
|
|---|
Setzt die Länge des Mittelwerts für die Spannung.
Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. In diesem Fall gibt es mehr Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung.
Added in version 2.0.3$nbsp;(Plugin).
| Rückgabe: |
|
|---|
Gibt die Averaging-Konfiguration zurück, wie von SetAveraging gesetzt.
Added in version 2.0.3$nbsp;(Plugin).
| 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.
| Parameter: |
|
|---|
Setzt die Periode mit welcher der OnVoltage Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der OnVoltage Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetVoltageCallbackPeriod gesetzt.
| Parameter: |
|
|---|
Setzt die Periode mit welcher der OnAnalogValue Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der OnAnalogValue Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod gesetzt.
| Parameter: |
|
|---|
Setzt den Schwellwert für den OnVoltageReached Callback.
Die folgenden Optionen sind möglich:
Option |
Beschreibung |
|---|---|
'x' |
Callback ist inaktiv |
'o' |
Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist |
'i' |
Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist |
'<' |
Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert) |
'>' |
Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
| Ausgabeparameter: |
|
|---|
Gibt den Schwellwert zurück, wie von SetVoltageCallbackThreshold gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
| Parameter: |
|
|---|
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 der Analogwert außerhalb des min und max Wertes ist |
'i' |
Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist |
'<' |
Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert) |
'>' |
Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
| Ausgabeparameter: |
|
|---|
Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
| Parameter: |
|
|---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
| Rückgabe: |
|
|---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod gesetzt.
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: TBrickletAnalogIn; const value: longint); begin WriteLn(Format('Value: %d', [value])); end; analogIn.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.
procedure(sender: TBrickletAnalogIn; const voltage: word) of object;
| Callback-Parameter: |
|
|---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetVoltageCallbackPeriod, ausgelöst. Der Parameter ist die
gemessene Spannung des Sensors.
Der OnVoltage Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
procedure(sender: TBrickletAnalogIn; const value: word) of object;
| Callback-Parameter: |
|
|---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAnalogValueCallbackPeriod, ausgelöst. Der Parameter
ist der Analogwert des Sensors.
Der OnAnalogValue Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
procedure(sender: TBrickletAnalogIn; const voltage: word) of object;
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetVoltageCallbackThreshold gesetzt, erreicht wird.
Der Parameter ist die gemessene Spannung des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod gesetzt, ausgelöst.
procedure(sender: TBrickletAnalogIn; const value: word) of object;
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAnalogValueCallbackThreshold gesetzt, erreicht wird.
Der Parameter ist der Analogwert des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod gesetzt, ausgelöst.
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.
| 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.
| 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:
BRICKLET_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
BRICKLET_ANALOG_IN_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BRICKLET_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
BRICKLET_ANALOG_IN_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BRICKLET_ANALOG_IN_FUNCTION_SET_DEBOUNCE_PERIOD = 11
BRICKLET_ANALOG_IN_FUNCTION_SET_RANGE = 17
BRICKLET_ANALOG_IN_FUNCTION_SET_AVERAGING = 19
| 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:
BRICKLET_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
BRICKLET_ANALOG_IN_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BRICKLET_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
BRICKLET_ANALOG_IN_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BRICKLET_ANALOG_IN_FUNCTION_SET_DEBOUNCE_PERIOD = 11
BRICKLET_ANALOG_IN_FUNCTION_SET_RANGE = 17
BRICKLET_ANALOG_IN_FUNCTION_SET_AVERAGING = 19
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein Analog In 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.
Diese Konstante stellt den Anzeigenamen eines Analog In Bricklet dar.