Go - Remote Switch Bricklet

Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Switch Socket

Download (example_switch_socket.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/remote_switch_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Remote Switch Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rs, _ := remote_switch_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // 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, remote_switch_bricklet.SwitchToOn)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des Remote Switch Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/remote_switch_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func remote_switch_bricklet.New(uid string, ipcon *IPConnection) (device RemoteSwitchBricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: RemoteSwitchBricklet
  • err – Typ: error

Erzeugt ein neues RemoteSwitchBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := remote_switch_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*RemoteSwitchBricklet) SwitchSocket(houseCode uint8, receiverCode uint8, switchTo uint8) (err error)
Parameter:
  • houseCode – Typ: uint8, Wertebereich: [0 bis 31]
  • receiverCode – Typ: uint8, Wertebereich: [0 bis 31]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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

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

Für switchTo:

  • remote_switch_bricklet.SwitchToOff = 0
  • remote_switch_bricklet.SwitchToOn = 1
func (*RemoteSwitchBricklet) GetSwitchingState() (state uint8, err error)
Rückgabe:
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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:

Für state:

  • remote_switch_bricklet.SwitchingStateReady = 0
  • remote_switch_bricklet.SwitchingStateBusy = 1
func (*RemoteSwitchBricklet) SwitchSocketA(houseCode uint8, receiverCode uint8, switchTo uint8) (err error)
Parameter:
  • houseCode – Typ: uint8, Wertebereich: [0 bis 31]
  • receiverCode – Typ: uint8, Wertebereich: [0 bis 31]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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

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

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

Für switchTo:

  • remote_switch_bricklet.SwitchToOff = 0
  • remote_switch_bricklet.SwitchToOn = 1

Neu in Version 2.0.1 (Plugin).

func (*RemoteSwitchBricklet) SwitchSocketB(address uint32, unit uint8, switchTo uint8) (err error)
Parameter:
  • address – Typ: uint32, Wertebereich: [0 bis 67108863]
  • unit – Typ: uint8, Wertebereich: [0 bis 15, 255]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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.

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:

Für switchTo:

  • remote_switch_bricklet.SwitchToOff = 0
  • remote_switch_bricklet.SwitchToOn = 1

Neu in Version 2.0.1 (Plugin).

func (*RemoteSwitchBricklet) DimSocketB(address uint32, unit uint8, dimValue uint8) (err error)
Parameter:
  • address – Typ: uint32, Wertebereich: [0 bis 67108863]
  • unit – Typ: uint8, Wertebereich: [0 bis 15, 255]
  • dimValue – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

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

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

Neu in Version 2.0.1 (Plugin).

func (*RemoteSwitchBricklet) SwitchSocketC(systemCode rune, deviceCode uint8, switchTo uint8) (err error)
Parameter:
  • systemCode – Typ: rune, Wertebereich: ['A' bis 'P']
  • deviceCode – Typ: uint8, Wertebereich: [1 bis 16]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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.

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:

Für switchTo:

  • remote_switch_bricklet.SwitchToOff = 0
  • remote_switch_bricklet.SwitchToOn = 1

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

func (*RemoteSwitchBricklet) SetRepeats(repeats uint8) (err error)
Parameter:
  • repeats – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 5
Rückgabe:
  • err – Typ: error

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.

func (*RemoteSwitchBricklet) GetRepeats() (repeats uint8, err error)
Rückgabe:
  • repeats – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 5
  • err – Typ: error

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

func (*RemoteSwitchBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

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.

func (*RemoteSwitchBricklet) RegisterSwitchingDoneCallback(func()) (registrationId uint64)
Rückgabe:
  • registrationId – Typ: uint64

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

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.

func (*RemoteSwitchBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*RemoteSwitchBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: error

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:

  • remote_switch_bricklet.FunctionSwitchSocket = 1
  • remote_switch_bricklet.FunctionSetRepeats = 4
  • remote_switch_bricklet.FunctionSwitchSocketA = 6
  • remote_switch_bricklet.FunctionSwitchSocketB = 7
  • remote_switch_bricklet.FunctionDimSocketB = 8
  • remote_switch_bricklet.FunctionSwitchSocketC = 9
func (*RemoteSwitchBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

Ä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:

  • remote_switch_bricklet.FunctionSwitchSocket = 1
  • remote_switch_bricklet.FunctionSetRepeats = 4
  • remote_switch_bricklet.FunctionSwitchSocketA = 6
  • remote_switch_bricklet.FunctionSwitchSocketB = 7
  • remote_switch_bricklet.FunctionDimSocketB = 8
  • remote_switch_bricklet.FunctionSwitchSocketC = 9
func (*RemoteSwitchBricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

Konstanten

remote_switch_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Remote Switch Bricklet zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

remote_switch_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet dar.