Go - Remote Switch Bricklet 2.0

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rs, _ := remote_switch_v2_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_v2_bricklet.SwitchToOn)

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

Remote Callback

Download (example_remote_callback.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
31
32
33
34
35
36
37
38
39
40
package main

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

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

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

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Configure to receive from remote type A with minimum repeats set to 1 and enable callback
    rs.SetRemoteConfiguration(remote_switch_v2_bricklet.RemoteTypeA, 1, true)

    rs.RegisterRemoteStatusACallback(func(houseCode uint8, receiverCode uint8, switchTo remote_switch_v2_bricklet.SwitchTo, repeats uint16) {
        fmt.Printf("House Code: %d\n", houseCode)
        fmt.Printf("Receiver Code: %d\n", receiverCode)

        if switchTo == remote_switch_v2_bricklet.SwitchToOff {
            fmt.Println("Switch To: Off")
        } else if switchTo == remote_switch_v2_bricklet.SwitchToOn {
            fmt.Println("Switch To: On")
        }

        fmt.Printf("Repeats: %d\n", repeats)
        fmt.Println()
    })

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

API

Die API des Remote Switch Bricklet 2.0 ist im Package github.com/Tinkerforge/go-api-bindings/remote_switch_v2_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_v2_bricklet.New(uid string, ipcon *IPConnection) (device RemoteSwitchV2Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: RemoteSwitchV2Bricklet
  • err – Typ: error

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

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

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

func (*RemoteSwitchV2Bricklet) 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 der Switch Socket Funktionen 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_v2_bricklet.SwitchingStateReady = 0
  • remote_switch_v2_bricklet.SwitchingStateBusy = 1
func (*RemoteSwitchV2Bricklet) 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_v2_bricklet.SwitchToOff = 0
  • remote_switch_v2_bricklet.SwitchToOn = 1
func (*RemoteSwitchV2Bricklet) 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_v2_bricklet.SwitchToOff = 0
  • remote_switch_v2_bricklet.SwitchToOn = 1
func (*RemoteSwitchV2Bricklet) 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.

func (*RemoteSwitchV2Bricklet) 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_v2_bricklet.SwitchToOff = 0
  • remote_switch_v2_bricklet.SwitchToOn = 1
func (*RemoteSwitchV2Bricklet) SetRemoteConfiguration(remoteType uint8, minimumRepeats uint16, callbackEnabled bool) (err error)
Parameter:
  • remoteType – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: A
  • minimumRepeats – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 2
  • callbackEnabled – Typ: bool, Standardwert: false
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration für das Empfangen von Daten von Fernbedienungen der Typen A, B und C.

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

Für remoteType:

  • remote_switch_v2_bricklet.RemoteTypeA = 0
  • remote_switch_v2_bricklet.RemoteTypeB = 1
  • remote_switch_v2_bricklet.RemoteTypeC = 2
func (*RemoteSwitchV2Bricklet) GetRemoteConfiguration() (remoteType uint8, minimumRepeats uint16, callbackEnabled bool, err error)
Rückgabe:
  • remoteType – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: A
  • minimumRepeats – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 2
  • callbackEnabled – Typ: bool, Standardwert: false
  • err – Typ: error

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

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

Für remoteType:

  • remote_switch_v2_bricklet.RemoteTypeA = 0
  • remote_switch_v2_bricklet.RemoteTypeB = 1
  • remote_switch_v2_bricklet.RemoteTypeC = 2
func (*RemoteSwitchV2Bricklet) GetRemoteStatusA() (houseCode uint8, receiverCode uint8, switchTo uint8, repeats uint16, err error)
Rückgabe:
  • houseCode – Typ: uint8, Wertebereich: [0 bis 31]
  • receiverCode – Typ: uint8, Wertebereich: [0 bis 31]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
  • repeats – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit dem angegebenen House/Receivercode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe SetRemoteConfiguration() und RegisterRemoteStatusACallback Callback.

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

Für switchTo:

  • remote_switch_v2_bricklet.SwitchToOff = 0
  • remote_switch_v2_bricklet.SwitchToOn = 1
func (*RemoteSwitchV2Bricklet) GetRemoteStatusB() (address uint32, unit uint8, switchTo uint8, dimValue uint8, repeats uint16, err error)
Rückgabe:
  • address – Typ: uint32, Wertebereich: [0 bis 67108863]
  • unit – Typ: uint8, Wertebereich: [0 bis 15]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
  • dimValue – Typ: uint8, Wertebereich: [0 bis 255]
  • repeats – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Falls die Fernbedienung Dimmen unterstützt, dann wie der Dimmwert anstatt des Schaltzustandes verwendet.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen Address/Unit auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe SetRemoteConfiguration() und RegisterRemoteStatusBCallback Callback.

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

Für switchTo:

  • remote_switch_v2_bricklet.SwitchToOff = 0
  • remote_switch_v2_bricklet.SwitchToOn = 1
func (*RemoteSwitchV2Bricklet) GetRemoteStatusC() (systemCode rune, deviceCode uint8, switchTo uint8, repeats uint16, err error)
Rückgabe:
  • systemCode – Typ: rune, Wertebereich: ['A' bis 'P']
  • deviceCode – Typ: uint8, Wertebereich: [1 bis 16]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
  • repeats – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen System/Gerätecode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe SetRemoteConfiguration() und RegisterRemoteStatusCCallback Callback.

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

Für switchTo:

  • remote_switch_v2_bricklet.SwitchToOff = 0
  • remote_switch_v2_bricklet.SwitchToOn = 1

Fortgeschrittene Funktionen

func (*RemoteSwitchV2Bricklet) 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 Switch Socket 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 (*RemoteSwitchV2Bricklet) 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 (*RemoteSwitchV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Rückgabe:
  • errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

func (*RemoteSwitchV2Bricklet) SetBootloaderMode(mode uint8) (status uint8, err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • remote_switch_v2_bricklet.BootloaderModeBootloader = 0
  • remote_switch_v2_bricklet.BootloaderModeFirmware = 1
  • remote_switch_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • remote_switch_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • remote_switch_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

  • remote_switch_v2_bricklet.BootloaderStatusOK = 0
  • remote_switch_v2_bricklet.BootloaderStatusInvalidMode = 1
  • remote_switch_v2_bricklet.BootloaderStatusNoChange = 2
  • remote_switch_v2_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • remote_switch_v2_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • remote_switch_v2_bricklet.BootloaderStatusCRCMismatch = 5
func (*RemoteSwitchV2Bricklet) GetBootloaderMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

Für mode:

  • remote_switch_v2_bricklet.BootloaderModeBootloader = 0
  • remote_switch_v2_bricklet.BootloaderModeFirmware = 1
  • remote_switch_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • remote_switch_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • remote_switch_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*RemoteSwitchV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Parameter:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*RemoteSwitchV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Parameter:
  • data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*RemoteSwitchV2Bricklet) SetStatusLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • remote_switch_v2_bricklet.StatusLEDConfigOff = 0
  • remote_switch_v2_bricklet.StatusLEDConfigOn = 1
  • remote_switch_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • remote_switch_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*RemoteSwitchV2Bricklet) GetStatusLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für config:

  • remote_switch_v2_bricklet.StatusLEDConfigOff = 0
  • remote_switch_v2_bricklet.StatusLEDConfigOn = 1
  • remote_switch_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • remote_switch_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*RemoteSwitchV2Bricklet) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
  • err – Typ: error

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

func (*RemoteSwitchV2Bricklet) Reset() (err error)
Rückgabe:
  • err – Typ: error

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

func (*RemoteSwitchV2Bricklet) WriteUID(uid uint32) (err error)
Parameter:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

func (*RemoteSwitchV2Bricklet) ReadUID() (uid uint32, err error)
Rückgabe:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

func (*RemoteSwitchV2Bricklet) 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 (*RemoteSwitchV2Bricklet) RegisterSwitchingDoneCallback(func()) (registrationId uint64)
Rückgabe:
  • registrationId – Typ: uint64

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

func (*RemoteSwitchV2Bricklet) RegisterRemoteStatusACallback(func(houseCode uint8, receiverCode uint8, switchTo uint8, repeats uint16)) (registrationId uint64)
Callback-Parameter:
  • houseCode – Typ: uint8, Wertebereich: [0 bis 31]
  • receiverCode – Typ: uint8, Wertebereich: [0 bis 31]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
  • repeats – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels SetRemoteConfiguration(). Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

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

Für switchTo:

  • remote_switch_v2_bricklet.SwitchToOff = 0
  • remote_switch_v2_bricklet.SwitchToOn = 1
func (*RemoteSwitchV2Bricklet) RegisterRemoteStatusBCallback(func(address uint32, unit uint8, switchTo uint8, dimValue uint8, repeats uint16)) (registrationId uint64)
Callback-Parameter:
  • address – Typ: uint32, Wertebereich: [0 bis 67108863]
  • unit – Typ: uint8, Wertebereich: [0 bis 15, 255]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
  • dimValue – Typ: uint8, Wertebereich: [0 bis 255]
  • repeats – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels SetRemoteConfiguration(). Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

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

Für switchTo:

  • remote_switch_v2_bricklet.SwitchToOff = 0
  • remote_switch_v2_bricklet.SwitchToOn = 1
func (*RemoteSwitchV2Bricklet) RegisterRemoteStatusCCallback(func(systemCode rune, deviceCode uint8, switchTo uint8, repeats uint16)) (registrationId uint64)
Callback-Parameter:
  • systemCode – Typ: rune, Wertebereich: ['A' bis 'P']
  • deviceCode – Typ: uint8, Wertebereich: [1 bis 16]
  • switchTo – Typ: uint8, Wertebereich: Siehe Konstanten
  • repeats – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels SetRemoteConfiguration(). Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

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

Für switchTo:

  • remote_switch_v2_bricklet.SwitchToOff = 0
  • remote_switch_v2_bricklet.SwitchToOn = 1

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 (*RemoteSwitchV2Bricklet) 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 (*RemoteSwitchV2Bricklet) 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_v2_bricklet.FunctionSetRepeats = 3
  • remote_switch_v2_bricklet.FunctionSwitchSocketA = 5
  • remote_switch_v2_bricklet.FunctionSwitchSocketB = 6
  • remote_switch_v2_bricklet.FunctionDimSocketB = 7
  • remote_switch_v2_bricklet.FunctionSwitchSocketC = 8
  • remote_switch_v2_bricklet.FunctionSetRemoteConfiguration = 9
  • remote_switch_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • remote_switch_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • remote_switch_v2_bricklet.FunctionReset = 243
  • remote_switch_v2_bricklet.FunctionWriteUID = 248
func (*RemoteSwitchV2Bricklet) 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_v2_bricklet.FunctionSetRepeats = 3
  • remote_switch_v2_bricklet.FunctionSwitchSocketA = 5
  • remote_switch_v2_bricklet.FunctionSwitchSocketB = 6
  • remote_switch_v2_bricklet.FunctionDimSocketB = 7
  • remote_switch_v2_bricklet.FunctionSwitchSocketC = 8
  • remote_switch_v2_bricklet.FunctionSetRemoteConfiguration = 9
  • remote_switch_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • remote_switch_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • remote_switch_v2_bricklet.FunctionReset = 243
  • remote_switch_v2_bricklet.FunctionWriteUID = 248
func (*RemoteSwitchV2Bricklet) 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_v2_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Remote Switch Bricklet 2.0 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_v2_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet 2.0 dar.