Visual Basic .NET - Distance US Bricklet 2.0

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

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim dus As New BrickletDistanceUSV2(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 = dus.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
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 2.0

    ' Callback subroutine for distance callback
    Sub DistanceCB(ByVal sender As BrickletDistanceUSV2, 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 dus As New BrickletDistanceUSV2(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 dus.DistanceCallback, AddressOf DistanceCB

        ' Set period for distance callback to 0.1s (100ms) without a threshold
        dus.SetDistanceCallbackConfiguration(100, False, "x"C, 0, 0)

        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
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 2.0

    ' Callback subroutine for distance callback
    Sub DistanceCB(ByVal sender As BrickletDistanceUSV2, 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 dus As New BrickletDistanceUSV2(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 dus.DistanceCallback, AddressOf DistanceCB

        ' Configure threshold for distance "greater than 100 cm"
        ' with a debounce period of 0.1s (100ms)
        dus.SetDistanceCallbackConfiguration(100, False, ">"C, 100*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 BrickletDistanceUSV2(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim distanceUSV2 As New BrickletDistanceUSV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletDistanceUSV2.GetDistance() As Integer

Gibt die Distanz in mm zurück.

Wenn der Wert periodisch benötigt wird, kann auch der DistanceCallback Callback verwendet werden. Der Callback wird mit der Funktion SetDistanceCallbackConfiguration() konfiguriert.

Sub BrickletDistanceUSV2.SetUpdateRate(ByVal updateRate As Byte)

Setzt die Aktualisierungsrate auf 2 Hz oder 10 Hz.

Mit 2 Hz Aktualisierungsrate beträgt das Rauschen ungefähr ±1mm. Bei 10 Hz erhöht sich das das Rauschen auf ungefähr ±5mm.

Der Standardwert beträgt 2 Hz.

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

  • BrickletDistanceUSV2.UPDATE_RATE_2_HZ = 0
  • BrickletDistanceUSV2.UPDATE_RATE_10_HZ = 1
Function BrickletDistanceUSV2.GetUpdateRate() As Byte

Gibt die Aktualisierungsrate zurück, wie von SetUpdateRate() gesetzt.

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

  • BrickletDistanceUSV2.UPDATE_RATE_2_HZ = 0
  • BrickletDistanceUSV2.UPDATE_RATE_10_HZ = 1
Sub BrickletDistanceUSV2.SetDistanceLEDConfig(ByVal config As Byte)

Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).

Der Standardwert ist 3 (Distanzanzeige).

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

  • BrickletDistanceUSV2.DISTANCE_LED_CONFIG_OFF = 0
  • BrickletDistanceUSV2.DISTANCE_LED_CONFIG_ON = 1
  • BrickletDistanceUSV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceUSV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3
Function BrickletDistanceUSV2.GetDistanceLEDConfig() As Byte

Gibt die LED-Konfiguration zurück, wie von SetDistanceLEDConfig() gesetzt.

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

  • BrickletDistanceUSV2.DISTANCE_LED_CONFIG_OFF = 0
  • BrickletDistanceUSV2.DISTANCE_LED_CONFIG_ON = 1
  • BrickletDistanceUSV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceUSV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

Fortgeschrittene Funktionen

Function BrickletDistanceUSV2.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 BrickletDistanceUSV2.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.

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

  • BrickletDistanceUSV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
  • BrickletDistanceUSV2.FUNCTION_SET_UPDATE_RATE = 5
  • BrickletDistanceUSV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 7
  • BrickletDistanceUSV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDistanceUSV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDistanceUSV2.FUNCTION_RESET = 243
  • BrickletDistanceUSV2.FUNCTION_WRITE_UID = 248
Sub BrickletDistanceUSV2.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 Konstanten sind für diese Funktion verfügbar:

  • BrickletDistanceUSV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
  • BrickletDistanceUSV2.FUNCTION_SET_UPDATE_RATE = 5
  • BrickletDistanceUSV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 7
  • BrickletDistanceUSV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDistanceUSV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDistanceUSV2.FUNCTION_RESET = 243
  • BrickletDistanceUSV2.FUNCTION_WRITE_UID = 248
Sub BrickletDistanceUSV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletDistanceUSV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Function BrickletDistanceUSV2.SetBootloaderMode(ByVal mode As Byte) As Byte

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • BrickletDistanceUSV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDistanceUSV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDistanceUSV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDistanceUSV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDistanceUSV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletDistanceUSV2.BOOTLOADER_STATUS_OK = 0
  • BrickletDistanceUSV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletDistanceUSV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletDistanceUSV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletDistanceUSV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletDistanceUSV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletDistanceUSV2.GetBootloaderMode() As Byte

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

  • BrickletDistanceUSV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDistanceUSV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDistanceUSV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDistanceUSV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDistanceUSV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletDistanceUSV2.SetWriteFirmwarePointer(ByVal pointer As Long)

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Function BrickletDistanceUSV2.WriteFirmware(ByVal data() As Byte) As Byte

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Sub BrickletDistanceUSV2.SetStatusLEDConfig(ByVal config As Byte)

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • BrickletDistanceUSV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletDistanceUSV2.STATUS_LED_CONFIG_ON = 1
  • BrickletDistanceUSV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceUSV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletDistanceUSV2.GetStatusLEDConfig() As Byte

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

  • BrickletDistanceUSV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletDistanceUSV2.STATUS_LED_CONFIG_ON = 1
  • BrickletDistanceUSV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceUSV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletDistanceUSV2.GetChipTemperature() As Short

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

Sub BrickletDistanceUSV2.Reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

Sub BrickletDistanceUSV2.WriteUID(ByVal uid As Long)

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

Function BrickletDistanceUSV2.ReadUID() As Long

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Sub BrickletDistanceUSV2.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 BrickletDistanceUSV2.SetDistanceCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Die Periode in ms ist die Periode mit der der DistanceCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den DistanceCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

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

  • BrickletDistanceUSV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletDistanceUSV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletDistanceUSV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletDistanceUSV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletDistanceUSV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletDistanceUSV2.GetDistanceCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

Gibt die Callback-Konfiguration zurück, wie mittels SetDistanceCallbackConfiguration() gesetzt.

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

  • BrickletDistanceUSV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletDistanceUSV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletDistanceUSV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletDistanceUSV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletDistanceUSV2.THRESHOLD_OPTION_GREATER = ">"C

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 BrickletDistanceUSV2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetDistanceCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie GetDistance().

Konstanten

Const BrickletDistanceUSV2.DEVICE_IDENTIFIER

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

Const BrickletDistanceUSV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Distance US Bricklet 2.0 dar.