Visual Basic .NET - Hall Effect Bricklet 2.0

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

Counter

Download (ExampleCounter.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 ExampleCounter
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Hall Effect Bricklet 2.0

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

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

        ' Get current count without counter reset
        Dim count As Long = he.GetCounter(False)
        Console.WriteLine("Count: " + count.ToString())

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

Magnetic Flux Density

Download (ExampleMagneticFluxDensity.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 ExampleMagneticFluxDensity
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Hall Effect Bricklet 2.0

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

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

        ' Get current Magnetic Flux Density
        Dim magneticFluxDensity As Short = he.GetMagneticFluxDensity()
        Console.WriteLine("Magnetic Flux Density: " + magneticFluxDensity.ToString() + " µT")

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

Counter Callback

Download (ExampleCounterCallback.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 ExampleCounterCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Hall Effect Bricklet 2.0

    ' Callback subroutine for counter callback
    Sub CounterCB(ByVal sender As BrickletHallEffectV2, ByVal counter As Long)
        Console.WriteLine("Counter: " + counter.ToString())
    End Sub

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

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

        ' Configure counter with ±3000µT threshold and 10ms debounce
        he.SetCounterConfig(3000, -3000, 10000)

        ' Register counter callback to subroutine CounterCB
        AddHandler he.CounterCallback, AddressOf CounterCB

        ' Set period for counter callback to 0.1s (100ms)
        he.SetCounterCallbackConfiguration(100, True)

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

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

Dim hallEffectV2 As New BrickletHallEffectV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletHallEffectV2.GetMagneticFluxDensity() As Short

Gibt die magnetische Flussdichte (magnetische Induktion) in µT (Microtesla) zurück.

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

Function BrickletHallEffectV2.GetCounter(ByVal resetCounter As Boolean) As Long

Gibt den aktuellen Wert des Zählers zurück.

Die Schwellwerte (low/high) in µT und Entprellzeit in µs können per SetCounterConfig() eingestellt werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem Auslesen auf 0 zurückgesetzt.

Wenn der Zähler periodisch benötigt wird, kann auch der CounterCallback Callback verwendet werden. Der Callback wird mit der Funktion SetCounterCallbackConfiguration() konfiguriert.

Sub BrickletHallEffectV2.SetCounterConfig(ByVal highThreshold As Short, ByVal lowThreshold As Short, ByVal debounce As Long)

Setzt einen unteren und einen oberen Schwellwert (threshold) in µT sowie eine Entprellzeit (debounce) in µs.

Wenn die gemessene magnetische Flussdichte über den oberen Schwellwert oder unter den unteren Schwellwert wandert, wird der Zählerstand des Zählers (siehe GetCounter()) um 1 erhöht.

Die Entprellzeit ist die Minimalzeit zwischen zwei Zählererhöhungen.

Die Standardwerte sind

  • Unterer Schwellwert: 2000µT
  • Oberer Schwellwert: -2000µT
  • Entprellzeit: 100000µs (100ms)
Sub BrickletHallEffectV2.GetCounterConfig(ByRef highThreshold As Short, ByRef lowThreshold As Short, ByRef debounce As Long)

Gibt die Zähler-Konfiguration zurück, wie von SetCounterConfig() gesetzt.

Fortgeschrittene Funktionen

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

  • BrickletHallEffectV2.FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 2
  • BrickletHallEffectV2.FUNCTION_SET_COUNTER_CONFIG = 6
  • BrickletHallEffectV2.FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION = 8
  • BrickletHallEffectV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletHallEffectV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletHallEffectV2.FUNCTION_RESET = 243
  • BrickletHallEffectV2.FUNCTION_WRITE_UID = 248
Sub BrickletHallEffectV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletHallEffectV2.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 BrickletHallEffectV2.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:

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

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

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

  • BrickletHallEffectV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletHallEffectV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletHallEffectV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletHallEffectV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletHallEffectV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletHallEffectV2.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 BrickletHallEffectV2.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 BrickletHallEffectV2.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:

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

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

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

  • BrickletHallEffectV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletHallEffectV2.STATUS_LED_CONFIG_ON = 1
  • BrickletHallEffectV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletHallEffectV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletHallEffectV2.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 BrickletHallEffectV2.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 BrickletHallEffectV2.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 BrickletHallEffectV2.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 BrickletHallEffectV2.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 BrickletHallEffectV2.SetMagneticFluxDensityCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Short, ByVal max As Short)

Die Periode in ms ist die Periode mit der der MagneticFluxDensityCallback 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 MagneticFluxDensityCallback 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:

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

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

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

  • BrickletHallEffectV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletHallEffectV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletHallEffectV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletHallEffectV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletHallEffectV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletHallEffectV2.SetCounterCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)

Die Periode in ms ist die Periode mit der der CounterCallback 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

Der Standardwert ist (0, false).

Sub BrickletHallEffectV2.GetCounterCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)

Gibt die Callback-Konfiguration zurück, wie mittels SetCounterCallbackConfiguration() 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 BrickletHallEffectV2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler hallEffectV2.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 BrickletHallEffectV2.MagneticFluxDensityCallback(ByVal sender As BrickletHallEffectV2, ByVal magneticFluxDensity As Short)

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

Der Parameter ist der gleiche wie GetMagneticFluxDensity().

Event BrickletHallEffectV2.CounterCallback(ByVal sender As BrickletHallEffectV2, ByVal count As Long)

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

Der Zählerstand ist der gleiche, der auch per GetCounter() abgefragt werden kann.

Konstanten

Const BrickletHallEffectV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Hall Effect 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 BrickletHallEffectV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet 2.0 dar.