Visual Basic .NET - Distance US Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Distance US Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance US 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 Distance US Bricklet

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

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

        ' Get current distance value
        Dim distance As Integer = dus.GetDistanceValue()
        Console.WriteLine("Distance Value: " + distance.ToString())

        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 Distance US Bricklet

    ' Callback subroutine for distance value callback
    Sub DistanceCB(ByVal sender As BrickletDistanceUS, ByVal distance As Integer)
        Console.WriteLine("Distance Value: " + distance.ToString())
    End Sub

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

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

        ' Register distance value callback to subroutine DistanceCB
        AddHandler dus.DistanceCallback, AddressOf DistanceCB

        ' Set period for distance value callback to 0.2s (200ms)
        ' Note: The distance value callback is only called every 0.2 seconds
        '       if the distance value has changed since the last call!
        dus.SetDistanceCallbackPeriod(200)

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

Threshold

Download (ExampleThreshold.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
34
Imports System
Imports Tinkerforge

Module ExampleThreshold
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Distance US Bricklet

    ' Callback subroutine for distance value reached callback
    Sub DistanceReachedCB(ByVal sender As BrickletDistanceUS, ByVal distance As Integer)
        Console.WriteLine("Distance Value: " + distance.ToString())
    End Sub

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

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

        ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        dus.SetDebouncePeriod(10000)

        ' Register distance value reached callback to subroutine DistanceReachedCB
        AddHandler dus.DistanceReachedCallback, AddressOf DistanceReachedCB

        ' Configure threshold for distance value "smaller than 200"
        dus.SetDistanceCallbackThreshold("<"C, 200, 0)

        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 BrickletDistanceUS(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim distanceUS As New BrickletDistanceUS("YOUR_DEVICE_UID", ipcon)

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

Function BrickletDistanceUS.GetDistanceValue() As Integer

Gibt den aktuellen Entfernungswert zurück. Der Wert hat einen Wertebereich von 0 bis 4095. Ein kleiner Wert entspricht einer kleinen Entfernung, ein großer Wert entspricht einer großen Entfernung. Das Verhältnis zwischen gemessenem Entfernungswert und wirklicher Entfernung wird durch die 5V Versorgungsspannung beeinflusst (Abweichungen der Versorgungsspannung führen zu Abweichungen in den Entfernungswerten) und ist nicht-linear (Auflösung ist größer im Nahbereich).

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den DistanceCallback Callback zu nutzen und die Periode mit SetDistanceCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

Sub BrickletDistanceUS.SetMovingAverage(ByVal average As Byte)

Setzt die Länge eines gleitenden Mittelwerts für den Entfernungswert.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 0-100.

Der Standardwert ist 20.

Function BrickletDistanceUS.GetMovingAverage() As Byte

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage() gesetzt.

Function BrickletDistanceUS.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 BrickletDistanceUS.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 BrickletDistanceUS.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:

  • BrickletDistanceUS.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
  • BrickletDistanceUS.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
  • BrickletDistanceUS.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDistanceUS.FUNCTION_SET_MOVING_AVERAGE = 10
Sub BrickletDistanceUS.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletDistanceUS.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 BrickletDistanceUS.SetDistanceCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletDistanceUS.GetDistanceCallbackPeriod() As Long

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

Sub BrickletDistanceUS.SetDistanceCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Setzt den Schwellwert für den DistanceReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst wenn der Entfernungswert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst wenn der Entfernungswert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst wenn der Entfernungswert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn der Entfernungswert 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:

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

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

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

  • BrickletDistanceUS.THRESHOLD_OPTION_OFF = "x"C
  • BrickletDistanceUS.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletDistanceUS.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletDistanceUS.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletDistanceUS.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletDistanceUS.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 BrickletDistanceUS.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 BrickletDistanceUS, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler distanceUS.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 BrickletDistanceUS.DistanceCallback(ByVal sender As BrickletDistanceUS, ByVal distance As Integer)

Dieser Callback wird mit der Periode, wie gesetzt mit SetDistanceCallbackPeriod(), ausgelöst. Der Parameter ist die Entfernungswert des Sensors.

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

Event BrickletDistanceUS.DistanceReachedCallback(ByVal sender As BrickletDistanceUS, ByVal distance As Integer)

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von SetDistanceCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Entfernungswert des Sensors.

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

Konstanten

Const BrickletDistanceUS.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Distance US 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 BrickletDistanceUS.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Distance US Bricklet dar.