Visual Basic .NET - Motion Detector Bricklet¶

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 Motion Detector Bricklet
 8
 9    ' Callback subroutine for motion detected callback
10    Sub MotionDetectedCB(ByVal sender As BrickletMotionDetector)
11        Console.WriteLine("Motion Detected")
12    End Sub
13
14    ' Callback subroutine for detection cycle ended callback
15    Sub DetectionCycleEndedCB(ByVal sender As BrickletMotionDetector)
16        Console.WriteLine("Detection Cycle Ended (next detection possible in ~3 seconds)")
17    End Sub
18
19    Sub Main()
20        Dim ipcon As New IPConnection() ' Create IP connection
21        Dim md As New BrickletMotionDetector(UID, ipcon) ' Create device object
22
23        ipcon.Connect(HOST, PORT) ' Connect to brickd
24        ' Don't use device before ipcon is connected
25
26        ' Register motion detected callback to subroutine MotionDetectedCB
27        AddHandler md.MotionDetectedCallback, AddressOf MotionDetectedCB
28
29        ' Register detection cycle ended callback to subroutine DetectionCycleEndedCB
30        AddHandler md.DetectionCycleEndedCallback, AddressOf DetectionCycleEndedCB
31
32        Console.WriteLine("Press key to exit")
33        Console.ReadLine()
34        ipcon.Disconnect()
35    End Sub
36End Module

Grundfunktionen¶

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

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

Dim motionDetector As New BrickletMotionDetector("YOUR_DEVICE_UID", ipcon)

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

Function BrickletMotionDetector.GetMotionDetected() As Byte¶

Rückgabe:	motion – Typ: Byte, Wertebereich: Siehe Konstanten

Gibt 1 zurück wenn eine Bewegung detektiert wurde. Wie lange 1 zurückgegeben wird nachdem eine Bewegung detektiert wurde kann mit einem kleinen Poti auf dem Motion Detector Bricklet eingestellt werden, siehe hier.

Auf dem Bricklet selbst ist eine blaue LED, die leuchtet solange das Bricklet im "Bewegung detektiert" Zustand ist.

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

Für motion:

• BrickletMotionDetector.MOTION_NOT_DETECTED = 0

• BrickletMotionDetector.MOTION_DETECTED = 1

Fortgeschrittene Funktionen¶

Sub BrickletMotionDetector.SetStatusLEDConfig(ByVal config As Byte)¶

Parameter:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 2

Setzt die Konfiguration der Status-LED.

Standardmäßig geht die LED an, wenn eine Bewegung erkannt wird und aus wenn keine Bewegung erkannt wird.

Die LED kann auch permanent an/aus gestellt werden.

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

Für config:

• BrickletMotionDetector.STATUS_LED_CONFIG_OFF = 0

• BrickletMotionDetector.STATUS_LED_CONFIG_ON = 1

• BrickletMotionDetector.STATUS_LED_CONFIG_SHOW_STATUS = 2

Added in version 2.0.1$nbsp;(Plugin).

Function BrickletMotionDetector.GetStatusLEDConfig() As Byte¶

Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 2

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

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

Für config:

• BrickletMotionDetector.STATUS_LED_CONFIG_OFF = 0

• BrickletMotionDetector.STATUS_LED_CONFIG_ON = 1

• BrickletMotionDetector.STATUS_LED_CONFIG_SHOW_STATUS = 2

Added in version 2.0.1$nbsp;(Plugin).

Sub BrickletMotionDetector.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.

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

AddHandler motionDetector.ExampleCallback, AddressOf MyCallback

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

Event BrickletMotionDetector.MotionDetectedCallback(ByVal sender As BrickletMotionDetector)¶

Callback-Parameter:	sender – Typ: BrickletMotionDetector

Dieser Callback wird aufgerufen nachdem eine Bewegung detektiert wurde.

Event BrickletMotionDetector.DetectionCycleEndedCallback(ByVal sender As BrickletMotionDetector)¶

Callback-Parameter:	sender – Typ: BrickletMotionDetector

Dieser Callback wird aufgerufen wenn ein Bewegungserkennungszyklus beendet ist. Wenn dieser Callback aufgerufen wurde kann wieder eine weitere Bewegung erkannt werden nach ungefähr 2 Sekunden.

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 BrickletMotionDetector.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 BrickletMotionDetector.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:

• BrickletMotionDetector.FUNCTION_SET_STATUS_LED_CONFIG = 4

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

• BrickletMotionDetector.FUNCTION_SET_STATUS_LED_CONFIG = 4

Sub BrickletMotionDetector.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 BrickletMotionDetector.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Motion Detector 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 BrickletMotionDetector.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Motion Detector Bricklet dar.