Dies ist die Beschreibung der Visual Basic .NET 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 Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1Imports System
2Imports Tinkerforge
3
4Module ExampleSimple
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your Analog In Bricklet
8
9 Sub Main()
10 Dim ipcon As New IPConnection() ' Create IP connection
11 Dim ai As New BrickletAnalogIn(UID, ipcon) ' Create device object
12
13 ipcon.Connect(HOST, PORT) ' Connect to brickd
14 ' Don't use device before ipcon is connected
15
16 ' Get current voltage
17 Dim voltage As Integer = ai.GetVoltage()
18 Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
19
20 Console.WriteLine("Press key to exit")
21 Console.ReadLine()
22 ipcon.Disconnect()
23 End Sub
24End Module
1Imports System
2Imports Tinkerforge
3
4Module ExampleCallback
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your Analog In Bricklet
8
9 ' Callback subroutine for voltage callback
10 Sub VoltageCB(ByVal sender As BrickletAnalogIn, ByVal voltage As Integer)
11 Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
12 End Sub
13
14 Sub Main()
15 Dim ipcon As New IPConnection() ' Create IP connection
16 Dim ai As New BrickletAnalogIn(UID, ipcon) ' Create device object
17
18 ipcon.Connect(HOST, PORT) ' Connect to brickd
19 ' Don't use device before ipcon is connected
20
21 ' Register voltage callback to subroutine VoltageCB
22 AddHandler ai.VoltageCallback, AddressOf VoltageCB
23
24 ' Set period for voltage callback to 1s (1000ms)
25 ' Note: The voltage callback is only called every second
26 ' if the voltage has changed since the last call!
27 ai.SetVoltageCallbackPeriod(1000)
28
29 Console.WriteLine("Press key to exit")
30 Console.ReadLine()
31 ipcon.Disconnect()
32 End Sub
33End Module
Download (ExampleThreshold.vb)
1Imports System
2Imports Tinkerforge
3
4Module ExampleThreshold
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your Analog In Bricklet
8
9 ' Callback subroutine for voltage reached callback
10 Sub VoltageReachedCB(ByVal sender As BrickletAnalogIn, ByVal voltage As Integer)
11 Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
12 End Sub
13
14 Sub Main()
15 Dim ipcon As New IPConnection() ' Create IP connection
16 Dim ai As New BrickletAnalogIn(UID, ipcon) ' Create device object
17
18 ipcon.Connect(HOST, PORT) ' Connect to brickd
19 ' Don't use device before ipcon is connected
20
21 ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
22 ai.SetDebouncePeriod(10000)
23
24 ' Register voltage reached callback to subroutine VoltageReachedCB
25 AddHandler ai.VoltageReachedCallback, AddressOf VoltageReachedCB
26
27 ' Configure threshold for voltage "smaller than 5 V"
28 ai.SetVoltageCallbackThreshold("<"C, 5*1000, 0)
29
30 Console.WriteLine("Press key to exit")
31 Console.ReadLine()
32 ipcon.Disconnect()
33 End Sub
34End Module
Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das
ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.
Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
Dim analogIn As New BrickletAnalogIn("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 VoltageCallback 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:
BrickletAnalogIn.RANGE_AUTOMATIC = 0
BrickletAnalogIn.RANGE_UP_TO_6V = 1
BrickletAnalogIn.RANGE_UP_TO_10V = 2
BrickletAnalogIn.RANGE_UP_TO_36V = 3
BrickletAnalogIn.RANGE_UP_TO_45V = 4
BrickletAnalogIn.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:
BrickletAnalogIn.RANGE_AUTOMATIC = 0
BrickletAnalogIn.RANGE_UP_TO_6V = 1
BrickletAnalogIn.RANGE_UP_TO_10V = 2
BrickletAnalogIn.RANGE_UP_TO_36V = 3
BrickletAnalogIn.RANGE_UP_TO_45V = 4
BrickletAnalogIn.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 AnalogValueCallback 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 VoltageCallback Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der VoltageCallback 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 AnalogValueCallback Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der AnalogValueCallback 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 VoltageReachedCallback 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:
BrickletAnalogIn.THRESHOLD_OPTION_OFF = "x"C
BrickletAnalogIn.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletAnalogIn.THRESHOLD_OPTION_INSIDE = "i"C
BrickletAnalogIn.THRESHOLD_OPTION_SMALLER = "<"C
BrickletAnalogIn.THRESHOLD_OPTION_GREATER = ">"C
| Ausgabeparameter: |
|
|---|
Gibt den Schwellwert zurück, wie von SetVoltageCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAnalogIn.THRESHOLD_OPTION_OFF = "x"C
BrickletAnalogIn.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletAnalogIn.THRESHOLD_OPTION_INSIDE = "i"C
BrickletAnalogIn.THRESHOLD_OPTION_SMALLER = "<"C
BrickletAnalogIn.THRESHOLD_OPTION_GREATER = ">"C
| Parameter: |
|
|---|
Setzt den Schwellwert für den AnalogValueReachedCallback 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:
BrickletAnalogIn.THRESHOLD_OPTION_OFF = "x"C
BrickletAnalogIn.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletAnalogIn.THRESHOLD_OPTION_INSIDE = "i"C
BrickletAnalogIn.THRESHOLD_OPTION_SMALLER = "<"C
BrickletAnalogIn.THRESHOLD_OPTION_GREATER = ">"C
| Ausgabeparameter: |
|
|---|
Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAnalogIn.THRESHOLD_OPTION_OFF = "x"C
BrickletAnalogIn.THRESHOLD_OPTION_OUTSIDE = "o"C
BrickletAnalogIn.THRESHOLD_OPTION_INSIDE = "i"C
BrickletAnalogIn.THRESHOLD_OPTION_SMALLER = "<"C
BrickletAnalogIn.THRESHOLD_OPTION_GREATER = ">"C
| 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:
Sub MyCallback(ByVal sender As BrickletAnalogIn, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler analogIn.ExampleCallback, AddressOf 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.
| Callback-Parameter: |
|
|---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetVoltageCallbackPeriod(), ausgelöst. Der Parameter ist die
gemessene Spannung des Sensors.
Der VoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
| Callback-Parameter: |
|
|---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAnalogValueCallbackPeriod(), ausgelöst. Der Parameter
ist der Analogwert des Sensors.
Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
| 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.
| 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:
BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletAnalogIn.FUNCTION_SET_RANGE = 17
BrickletAnalogIn.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:
BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletAnalogIn.FUNCTION_SET_RANGE = 17
BrickletAnalogIn.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
IPConnection.EnumerateCallback
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.