Visual Basic .NET - Linear Poti Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Linear Poti Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Linear Poti Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Linear Poti Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim lp As New BrickletLinearPoti(UID, ipcon) ' Create device object

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

        ' Get current position
        Dim position As Integer = lp.GetPosition()
        Console.WriteLine("Position: " + position.ToString()) ' Range: 0 to 100

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback

Download (ExampleCallback.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Linear Poti Bricklet

    ' Callback subroutine for position callback
    Sub PositionCB(ByVal sender As BrickletLinearPoti, ByVal position As Integer)
        Console.WriteLine("Position: " + position.ToString()) ' Range: 0 to 100
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim lp As New BrickletLinearPoti(UID, ipcon) ' Create device object

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

        ' Register position callback to subroutine PositionCB
        AddHandler lp.PositionCallback, AddressOf PositionCB

        ' Set period for position callback to 0.05s (50ms)
        ' Note: The position callback is only called every 0.05 seconds
        '       if the position has changed since the last call!
        lp.SetPositionCallbackPeriod(50)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

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.

Grundfunktionen

Class BrickletLinearPoti(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim linearPoti As New BrickletLinearPoti("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Function BrickletLinearPoti.GetPosition() As Integer

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0 (Schieberegler unten) und 100 (Schieberegler oben).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den PositionCallback Callback zu nutzen und die Periode mit SetPositionCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

Function BrickletLinearPoti.GetAnalogValue() As Integer

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von GetPosition() 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.

Function BrickletLinearPoti.GetAPIVersion() As Byte()

Gibt die Version der API Definition (Major, Minor, Revision) 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 BrickletLinearPoti.GetResponseExpected(ByVal functionId As Byte) As 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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickletLinearPoti.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletLinearPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11
Sub BrickletLinearPoti.SetResponseExpectedAll(ByVal responseExpected As Boolean)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Sub BrickletLinearPoti.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

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 kann 'a', 'b', 'c' oder 'd' sein.

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

Sub BrickletLinearPoti.SetPositionCallbackPeriod(ByVal period As Long)

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

Der PositionCallback Callback wird nur ausgelöst wenn sich die Position seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

Function BrickletLinearPoti.GetPositionCallbackPeriod() As Long

Gibt die Periode zurück, wie von SetPositionCallbackPeriod() gesetzt.

Sub BrickletLinearPoti.SetAnalogValueCallbackPeriod(ByVal period As Long)

Setzt die Periode in ms 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.

Der Standardwert ist 0.

Function BrickletLinearPoti.GetAnalogValueCallbackPeriod() As Long

Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod() gesetzt.

Sub BrickletLinearPoti.SetPositionCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Setzt den Schwellwert für den PositionReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

  • BrickletLinearPoti.THRESHOLD_OPTION_OFF = "x"C
  • BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletLinearPoti.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletLinearPoti.GetPositionCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

Gibt den Schwellwert zurück, wie von SetPositionCallbackThreshold() gesetzt.

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

  • BrickletLinearPoti.THRESHOLD_OPTION_OFF = "x"C
  • BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletLinearPoti.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletLinearPoti.SetAnalogValueCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

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 der min und max Werte ist
'i' Callback wird ausgelöst wenn der Analogwert innerhalb der min und max Werte 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)

Der Standardwert ist ('x', 0, 0).

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

  • BrickletLinearPoti.THRESHOLD_OPTION_OFF = "x"C
  • BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletLinearPoti.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletLinearPoti.GetAnalogValueCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold() gesetzt.

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

  • BrickletLinearPoti.THRESHOLD_OPTION_OFF = "x"C
  • BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletLinearPoti.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletLinearPoti.SetDebouncePeriod(ByVal debounce As Long)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

Function BrickletLinearPoti.GetDebouncePeriod() As Long

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:

Sub MyCallback(ByVal sender As BrickletLinearPoti, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler linearPoti.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.

Event BrickletLinearPoti.PositionCallback(ByVal sender As BrickletLinearPoti, ByVal position As Integer)

Dieser Callback wird mit der Periode, wie gesetzt mit SetPositionCallbackPeriod(), ausgelöst. Der Parameter ist die Position des Linearpotentiometers.

Der PositionCallback Callback wird nur ausgelöst wenn sich die Position seit der letzten Auslösung geändert hat.

Event BrickletLinearPoti.AnalogValueCallback(ByVal sender As BrickletLinearPoti, ByVal value As Integer)

Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Linearpotentiometers.

Der AnalogValueCallback Callback wird nur ausgelöst wenn sich der Analogwert seit der letzten Auslösung geändert hat.

Event BrickletLinearPoti.PositionReachedCallback(ByVal sender As BrickletLinearPoti, ByVal position As Integer)

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von SetPositionCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Position des Linearpotentiometers.

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

Event BrickletLinearPoti.AnalogValueReachedCallback(ByVal sender As BrickletLinearPoti, ByVal value As Integer)

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von SetAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Linearpotentiometers.

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

Konstanten

Const BrickletLinearPoti.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Linear Poti Bricklet zu identifizieren.

Die GetIdentity() Funktion und der EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Const BrickletLinearPoti.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Linear Poti Bricklet dar.