Visual Basic .NET - Dual Button Bricklet¶

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
34
35
36
37
38
39
40
41

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 Dual Button Bricklet

    ' Callback subroutine for state changed callback
    Sub StateChangedCB(ByVal sender As BrickletDualButton, ByVal buttonL As Byte, _
                       ByVal buttonR As Byte, ByVal ledL As Byte, ByVal ledR As Byte)
        If buttonL = BrickletDualButton.BUTTON_STATE_PRESSED Then
            Console.WriteLine("Left Button: Pressed")
        Else If buttonL = BrickletDualButton.BUTTON_STATE_RELEASED Then
            Console.WriteLine("Left Button: Released")
        End If

        If buttonR = BrickletDualButton.BUTTON_STATE_PRESSED Then
            Console.WriteLine("Right Button: Pressed")
        Else If buttonR = BrickletDualButton.BUTTON_STATE_RELEASED Then
            Console.WriteLine("Right Button: Released")
        End If

        Console.WriteLine("")
    End Sub

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

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

        ' Register state changed callback to subroutine StateChangedCB
        AddHandler db.StateChangedCallback, AddressOf StateChangedCB

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

Grundfunktionen¶

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

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

Dim dualButton As New BrickletDualButton("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletDualButton.SetLEDState(ByVal ledL As Byte, ByVal ledR As Byte)¶

Parameter:	ledL – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1 ledR – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt den Zustand der LEDs. Möglich Zustände sind:

• 0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
• 1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
• 2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
• 3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit GetLEDState() ausgelesen werden oder es kann SetSelectedLEDState() genutzt werden.

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

Für ledL:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

Für ledR:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

Sub BrickletDualButton.GetLEDState(ByRef ledL As Byte, ByRef ledR As Byte)¶

Ausgabeparameter:	ledL – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1 ledR – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den aktuellen Zustand der LEDs zurück, wie von SetLEDState() gesetzt.

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

Für ledL:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

Für ledR:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

Sub BrickletDualButton.GetButtonState(ByRef buttonL As Byte, ByRef buttonR As Byte)¶

Ausgabeparameter:	buttonL – Typ: Byte, Wertebereich: Siehe Konstanten buttonR – Typ: Byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

• 0 = pressed (gedrückt)
• 1 = released (losgelassen)

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

Für buttonL:

• BrickletDualButton.BUTTON_STATE_PRESSED = 0
• BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für buttonR:

• BrickletDualButton.BUTTON_STATE_PRESSED = 0
• BrickletDualButton.BUTTON_STATE_RELEASED = 1

Fortgeschrittene Funktionen¶

Sub BrickletDualButton.SetSelectedLEDState(ByVal led As Byte, ByVal state As Byte)¶

Parameter:	led – Typ: Byte, Wertebereich: Siehe Konstanten state – Typ: Byte, Wertebereich: Siehe Konstanten

Setzt den Zustand der selektierten LED (0 oder 1).

Die andere LED bleibt unangetastet.

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

Für led:

• BrickletDualButton.LED_LEFT = 0
• BrickletDualButton.LED_RIGHT = 1

Für state:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

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

AddHandler dualButton.ExampleCallback, AddressOf MyCallback

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

Event BrickletDualButton.StateChangedCallback(ByVal sender As BrickletDualButton, ByVal buttonL As Byte, ByVal buttonR As Byte, ByVal ledL As Byte, ByVal ledR As Byte)¶

Callback-Parameter:	sender – Typ: BrickletDualButton buttonL – Typ: Byte, Wertebereich: Siehe Konstanten buttonR – Typ: Byte, Wertebereich: Siehe Konstanten ledL – Typ: Byte, Wertebereich: Siehe Konstanten ledR – Typ: Byte, Wertebereich: Siehe Konstanten

Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

• 0 = pressed (gedrückt)
• 1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

• 0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
• 1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
• 2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
• 3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

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

Für buttonL:

• BrickletDualButton.BUTTON_STATE_PRESSED = 0
• BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für buttonR:

• BrickletDualButton.BUTTON_STATE_PRESSED = 0
• BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für ledL:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

Für ledR:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

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

• BrickletDualButton.FUNCTION_SET_LED_STATE = 1
• BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

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

• BrickletDualButton.FUNCTION_SET_LED_STATE = 1
• BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

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

Diese Konstante wird verwendet um ein Dual Button 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 BrickletDualButton.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet dar.