Visual Basic .NET - Remote Switch Bricklet

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

Switch Socket

Download (ExampleSwitchSocket.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
Imports System
Imports Tinkerforge

Module ExampleSwitchSocket
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Remote Switch Bricklet

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

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

        ' Switch on a type A socket with house code 17 and receiver code 1.
        ' House code 17 is 10001 in binary (least-significant bit first)
        ' and means that the DIP switches 1 and 5 are on and 2-4 are off.
        ' Receiver code 1 is 10000 in binary (least-significant bit first)
        ' and means that the DIP switch A is on and B-E are off.
        rs.SwitchSocketA(17, 1, BrickletRemoteSwitch.SWITCH_TO_ON)

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

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

Dim remoteSwitch As New BrickletRemoteSwitch("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletRemoteSwitch.SwitchSocket(ByVal houseCode As Byte, ByVal receiverCode As Byte, ByVal switchTo As Byte)

Diese Funktion ist veraltet und wurde durch SwitchSocketA() ersetzt.

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

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1
Function BrickletRemoteSwitch.GetSwitchingState() As Byte

Gibt den aktuellen Zustand des Schaltens zurück. Wenn der aktuell Zustand busy (beschäftigt) ist, sendet das Bricklet gerade einen Code um eine Steckdose zu schalten. Weitere Aufrufe von SwitchSocket() werden ignoriert bis der Zustand auf ready (fertig) wechselt.

Die Länge des Schaltvorgangs ist abhängig von der Anzahl der Wiederholungen, siehe SetRepeats().

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

  • BrickletRemoteSwitch.SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitch.SWITCHING_STATE_BUSY = 1
Sub BrickletRemoteSwitch.SwitchSocketA(ByVal houseCode As Byte, ByVal receiverCode As Byte, ByVal switchTo As Byte)

Um eine Typ A Steckdose zu schalten muss der Housecode, Receivercode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Der House- und Receivercode hat einen Wertebereich von 0 bis 31 (5Bit).

Eine detaillierte Beschreibung wie man den House- und Receivercode herausfinden kann gibt es hier.

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

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

Sub BrickletRemoteSwitch.SwitchSocketB(ByVal address As Long, ByVal unit As Byte, ByVal switchTo As Byte)

Um eine Typ B Steckdose zu schalten muss die Adresse und Unit sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Die Adresse hat einen Wertebereich von 0 bis 67108863 (26Bit) und die Unit hat einen Wertebereich von 0 bis 15 (4Bit). Um alle Geräte mit der selben Adresse zu schalten kann die Unit auf 255 gesetzt werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einer Steckdose anlernen kann gibt es hier.

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

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

Sub BrickletRemoteSwitch.DimSocketB(ByVal address As Long, ByVal unit As Byte, ByVal dimValue As Byte)

Um eine Typ B Dimmer zu steuern muss die Adresse und Unit sowie der Dimmwert auf der Dimmer gesetzt werden soll übergeben werden.

Die Adresse hat einen Wertebereich von 0 bis 67108863 (26Bit), die Unit und der Dimmwert haben einen Wertebereich von 0 bis 15 (4Bit).

Eine detaillierte Beschreibung wie man Adresse und Unit einem Dimmer anlernen kann gibt es hier.

Neu in Version 2.0.1 (Plugin).

Sub BrickletRemoteSwitch.SwitchSocketC(ByVal systemCode As Char, ByVal deviceCode As Byte, ByVal switchTo As Byte)

Um eine Typ C Steckdose zu schalten muss der Systemcode, Gerätecode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Der Systemcode hat einen Wertebereich von 'A' bis 'P' (4Bit) und der Gerätecode hat einen Wertebereich von 1 bis 16 (4Bit).

Eine detaillierte Beschreibung wie man den System- und Gerätecode herausfinden kann gibt es hier.

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

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

Sub BrickletRemoteSwitch.SetRepeats(ByVal repeats As Byte)

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der SwitchSocket() Funktionen aufgerufen wird. Die Wiederholungen korrespondieren zu der Zeit die eine Taste auf der Fernbedienung gedrückt wird.

Einige Dimmer werden über die Länge des Tastendrucks kontrolliert, dies kann simuliert werden indem man die Anzahl der Wiederholungen inkrementiert.

Der Standardwert ist 5.

Function BrickletRemoteSwitch.GetRepeats() As Byte

Gibt die Anzahl der Wiederholungen zurück, wie von SetRepeats() gesetzt.

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

  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
  • BrickletRemoteSwitch.FUNCTION_SET_REPEATS = 4
  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
  • BrickletRemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9
Sub BrickletRemoteSwitch.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:

  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
  • BrickletRemoteSwitch.FUNCTION_SET_REPEATS = 4
  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
  • BrickletRemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9
Sub BrickletRemoteSwitch.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

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

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

AddHandler remoteSwitch.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 BrickletRemoteSwitch.SwitchingDoneCallback(ByVal sender As BrickletRemoteSwitch)

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe GetSwitchingState().

Konstanten

Const BrickletRemoteSwitch.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Remote Switch 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 BrickletRemoteSwitch.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet dar.