Visual Basic .NET - Distance IR Bricklet

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

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

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

        ' Get current distance
        Dim distance As Integer = dir.GetDistance()
        Console.WriteLine("Distance: " + (distance/10.0).ToString() + " cm")

        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 IR Bricklet

    ' Callback subroutine for distance callback
    Sub DistanceCB(ByVal sender As BrickletDistanceIR, ByVal distance As Integer)
        Console.WriteLine("Distance: " + (distance/10.0).ToString() + " cm")
    End Sub

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

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

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

        ' Set period for distance callback to 0.2s (200ms)
        ' Note: The distance callback is only called every 0.2 seconds
        '       if the distance has changed since the last call!
        dir.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 IR Bricklet

    ' Callback subroutine for distance reached callback
    Sub DistanceReachedCB(ByVal sender As BrickletDistanceIR, ByVal distance As Integer)
        Console.WriteLine("Distance: " + (distance/10.0).ToString() + " cm")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim dir As New BrickletDistanceIR(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)
        dir.SetDebouncePeriod(10000)

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

        ' Configure threshold for distance "smaller than 30 cm"
        dir.SetDistanceCallbackThreshold("<"C, 30*10, 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 BrickletDistanceIR(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim distanceIR As New BrickletDistanceIR("YOUR_DEVICE_UID", ipcon)

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

Function BrickletDistanceIR.GetDistance() As Integer

Gibt die gemessene Entfernung des Sensors zurück. Der Wert ist in mm und die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.

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

Fortgeschrittene Funktionen

Function BrickletDistanceIR.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 GetDistance() 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.

Sub BrickletDistanceIR.SetSamplingPoint(ByVal position As Byte, ByVal distance As Integer)

Setzt einen Messpunkt für eine vorgegebene Position in der Wertetabelle. Die Wertetabelle beinhaltet 128 äquidistante Analogwerte mit entsprechenden Entfernungen.

Wenn eine Entfernung von 50cm bei einem Analogwert von 2048 gemessen wird, dann sollte der Aufruf der Funktion mit (64, 5000) erfolgen. Der verwendete Analog-Digital-Wandler hat eine Auflösung von 12 Bit. Mit 128 Messpunkten im gesamten Bereich bedeutet das, dass jeder Messpunkt 32 Analogwerte umfasst. Daher wird dem Analogwert 2048 der Messpunkt 64 = 2048/32 zugeordnet.

Messpunkte werden im EEPROM des Distance IR Bricklet gespeichert und werden bei jedem Hochfahren geladen.

Bemerkung

Ein einfacher Weg, die Messpunkte des Distance IR Bricklet zu kalibrieren, ist im Brick Viewer implementiert. Wenn der Bricklet kalibriert werden soll wird dringend empfohlen diese Implementierung zu nutzen.

Function BrickletDistanceIR.GetSamplingPoint(ByVal position As Byte) As Integer

Gibt die Entfernung eines Messpunktes zurück, wie von SetSamplingPoint() gesetzt.

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

  • BrickletDistanceIR.FUNCTION_SET_SAMPLING_POINT = 3
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletDistanceIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
Sub BrickletDistanceIR.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletDistanceIR.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 BrickletDistanceIR.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 Strom seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

Function BrickletDistanceIR.GetDistanceCallbackPeriod() As Long

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

Sub BrickletDistanceIR.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 BrickletDistanceIR.GetAnalogValueCallbackPeriod() As Long

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

Sub BrickletDistanceIR.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 die Entfernung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst wenn die Entfernung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst wenn die Entfernung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn die Entfernung 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:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"C
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletDistanceIR.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:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"C
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletDistanceIR.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 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)

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

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

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"C
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletDistanceIR.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:

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

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

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

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

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

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.

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

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

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

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

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.

Konstanten

Const BrickletDistanceIR.DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet dar.