Visual Basic .NET - Hall Effect Bricklet¶

Simple¶

Download (ExampleSimple.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleSimple
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Hall Effect Bricklet
 8
 9    Sub Main()
10        Dim ipcon As New IPConnection() ' Create IP connection
11        Dim he As New BrickletHallEffect(UID, ipcon) ' Create device object
12
13        ipcon.Connect(HOST, PORT) ' Connect to brickd
14        ' Don't use device before ipcon is connected
15
16        ' Get current edge count without reset
17        Dim count As Long = he.GetEdgeCount(False)
18        Console.WriteLine("Count: " + count.ToString())
19
20        Console.WriteLine("Press key to exit")
21        Console.ReadLine()
22        ipcon.Disconnect()
23    End Sub
24End Module

Callback¶

Download (ExampleCallback.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleCallback
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Hall Effect Bricklet
 8
 9    ' Callback subroutine for edge count callback
10    Sub EdgeCountCB(ByVal sender As BrickletHallEffect, ByVal count As Long, _
11                    ByVal value As Boolean)
12        Console.WriteLine("Count: " + count.ToString())
13    End Sub
14
15    Sub Main()
16        Dim ipcon As New IPConnection() ' Create IP connection
17        Dim he As New BrickletHallEffect(UID, ipcon) ' Create device object
18
19        ipcon.Connect(HOST, PORT) ' Connect to brickd
20        ' Don't use device before ipcon is connected
21
22        ' Register edge count callback to subroutine EdgeCountCB
23        AddHandler he.EdgeCountCallback, AddressOf EdgeCountCB
24
25        ' Set period for edge count callback to 0.05s (50ms)
26        ' Note: The edge count callback is only called every 0.05 seconds
27        '       if the edge count has changed since the last call!
28        he.SetEdgeCountCallbackPeriod(50)
29
30        Console.WriteLine("Press key to exit")
31        Console.ReadLine()
32        ipcon.Disconnect()
33    End Sub
34End Module

Grundfunktionen¶

Class BrickletHallEffect(ByVal uid As String, ByVal ipcon As IPConnection)¶

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

Dim hallEffect As New BrickletHallEffect("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

Function BrickletHallEffect.GetValue() As Boolean¶

Rückgabe:	value – Typ: Boolean

Gibt true zurück wenn ein Magnetfeld mit 3,5 Millitesla oder größer detektiert wird.

Function BrickletHallEffect.GetEdgeCount(ByVal resetCounter As Boolean) As Long¶

Parameter:	resetCounter – Typ: Boolean
Rückgabe:	count – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit SetEdgeCountConfig() konfiguriert werden.

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

Fortgeschrittene Funktionen¶

Sub BrickletHallEffect.SetEdgeCountConfig(ByVal edgeType As Byte, ByVal debounce As Byte)¶

Parameter:	edgeType – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: Byte, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

• 0 = steigend

• 1 = fallend

• 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>3,5 Millitesla) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<2,5 Millitesla) wird entsteht ein high-Signal (steigende Flanke).

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für edgeType:

• BrickletHallEffect.EDGE_TYPE_RISING = 0

• BrickletHallEffect.EDGE_TYPE_FALLING = 1

• BrickletHallEffect.EDGE_TYPE_BOTH = 2

Sub BrickletHallEffect.GetEdgeCountConfig(ByRef edgeType As Byte, ByRef debounce As Byte)¶

Ausgabeparameter:	edgeType – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: Byte, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von SetEdgeCountConfig() gesetzt.

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

Für edgeType:

• BrickletHallEffect.EDGE_TYPE_RISING = 0

• BrickletHallEffect.EDGE_TYPE_FALLING = 1

• BrickletHallEffect.EDGE_TYPE_BOTH = 2

Sub BrickletHallEffect.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)¶

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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 BrickletHallEffect.SetEdgeInterrupt(ByVal edges As Long)¶

Parameter:	edges – Typ: Long, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

Function BrickletHallEffect.GetEdgeInterrupt() As Long¶

Rückgabe:	edges – Typ: Long, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt edges zurück, wie von SetEdgeInterrupt() gesetzt.

Sub BrickletHallEffect.SetEdgeCountCallbackPeriod(ByVal period As Long)¶

Parameter:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Der EdgeCountCallback Callback wird nur ausgelöst, wenn sich die Flankenzählung seit der letzten Auslösung geändert hat.

Function BrickletHallEffect.GetEdgeCountCallbackPeriod() As Long¶

Rückgabe:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetEdgeCountCallbackPeriod() 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 BrickletHallEffect, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler hallEffect.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Event BrickletHallEffect.EdgeCountCallback(ByVal sender As BrickletHallEffect, ByVal count As Long, ByVal value As Boolean)¶

Callback-Parameter:	sender – Typ: BrickletHallEffect count – Typ: Long, Wertebereich: [0 bis 232 - 1] value – Typ: Boolean

Dieser Callback wird mit der Periode, wie gesetzt mit SetEdgeCountCallbackPeriod(), ausgelöst. Die Parameter sind der aktuelle Zählerstand und der aktuelle Wert (siehe GetValue() and GetEdgeCount()).

Der EdgeCountCallback Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

Function BrickletHallEffect.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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 BrickletHallEffect.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: 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:

Für functionId:

• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3

• BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5

• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7

Sub BrickletHallEffect.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten responseExpected – Typ: 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:

Für functionId:

• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3

• BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5

• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7

Sub BrickletHallEffect.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameter:	responseExpected – Typ: Boolean

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

Konstanten¶

Const BrickletHallEffect.DEVICE_IDENTIFIER¶

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

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet dar.