TCP/IP - Remote Switch Bricklet 2.0

Dies ist die Beschreibung des TCP/IP Protokolls 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.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletRemoteSwitchV2.get_switching_state
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • state -- uint8

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 set_repeats.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: ready, für state
  • 1: busy, für state
BrickletRemoteSwitchV2.switch_socket_a
Funktions ID:

5

Anfrage:
  • house_code -- uint8
  • receiver_code -- uint8
  • switch_to -- uint8
Antwort:

keine Antwort

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für switch_to
  • 1: on, für switch_to
BrickletRemoteSwitchV2.switch_socket_b
Funktions ID:

6

Anfrage:
  • address -- uint32
  • unit -- uint8
  • switch_to -- uint8
Antwort:

keine Antwort

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für switch_to
  • 1: on, für switch_to
BrickletRemoteSwitchV2.dim_socket_b
Funktions ID:

7

Anfrage:
  • address -- uint32
  • unit -- uint8
  • dim_value -- uint8
Antwort:

keine Antwort

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.

BrickletRemoteSwitchV2.switch_socket_c
Funktions ID:

8

Anfrage:
  • system_code -- char
  • device_code -- uint8
  • switch_to -- uint8
Antwort:

keine Antwort

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für switch_to
  • 1: on, für switch_to
BrickletRemoteSwitchV2.set_remote_configuration
Funktions ID:

9

Anfrage:
  • remote_type -- uint8
  • minimum_repeats -- uint16
  • callback_enabled -- bool
Antwort:

keine Antwort

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

  • Remote Type: A, B oder C abhängig vom Typ der Fernbedienung die empfangen werden soll.
  • Minimum Repeats: Die Mindestanzahl an wiederholten Datenpaketen bevor der Callback ausgelöst wird (falls aktiviert).
  • Callback Enabled: Aktiviert/Deaktivert den Callback (siehe CALLBACK_REMOTE_STATUS_A Callback, CALLBACK_REMOTE_STATUS_B Callback und CALLBACK_REMOTE_STATUS_C Callback).

Der Standardwert ist ('A', 2, false).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: a, für remote_type
  • 1: b, für remote_type
  • 2: c, für remote_type
BrickletRemoteSwitchV2.get_remote_configuration
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • remote_type -- uint8
  • minimum_repeats -- uint16
  • callback_enabled -- bool

Gibt die Konfiguration zurück wie von set_remote_configuration gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: a, für remote_type
  • 1: b, für remote_type
  • 2: c, für remote_type
BrickletRemoteSwitchV2.get_remote_status_a
Funktions ID:

11

Anfrage:

keine Nutzdaten

Antwort:
  • house_code -- uint8
  • receiver_code -- uint8
  • switch_to -- uint8
  • repeats -- uint16

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 set_remote_configuration und CALLBACK_REMOTE_STATUS_A Callback.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für switch_to
  • 1: on, für switch_to
BrickletRemoteSwitchV2.get_remote_status_b
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • address -- uint32
  • unit -- uint8
  • switch_to -- uint8
  • dim_value -- uint8
  • repeats -- uint16

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 set_remote_configuration und CALLBACK_REMOTE_STATUS_B Callback.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für switch_to
  • 1: on, für switch_to
BrickletRemoteSwitchV2.get_remote_status_c
Funktions ID:

13

Anfrage:

keine Nutzdaten

Antwort:
  • system_code -- char
  • device_code -- uint8
  • switch_to -- uint8
  • repeats -- uint16

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 set_remote_configuration und CALLBACK_REMOTE_STATUS_C Callback.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für switch_to
  • 1: on, für switch_to

Fortgeschrittene Funktionen

BrickletRemoteSwitchV2.set_repeats
Funktions ID:

3

Anfrage:
  • repeats -- uint8
Antwort:

keine Antwort

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.

Der Standardwert ist 5.

BrickletRemoteSwitchV2.get_repeats
Funktions ID:

4

Anfrage:

keine Nutzdaten

Antwort:
  • repeats -- uint8

Gibt die Anzahl der Wiederholungen zurück, wie von set_repeats gesetzt.

BrickletRemoteSwitchV2.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletRemoteSwitchV2.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

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 Bootlodaer- 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletRemoteSwitchV2.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletRemoteSwitchV2.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

keine Antwort

Setzt den Firmware-Pointer für write_firmware. 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.

BrickletRemoteSwitchV2.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer 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.

BrickletRemoteSwitchV2.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
Antwort:

keine Antwort

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletRemoteSwitchV2.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletRemoteSwitchV2.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur in °C, 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.

BrickletRemoteSwitchV2.reset
Funktions ID:243
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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 bestehende führt zu undefiniertem Verhalten.

BrickletRemoteSwitchV2.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
Antwort:

keine Antwort

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.

BrickletRemoteSwitchV2.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

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

BrickletRemoteSwitchV2.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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. 

Callbacks

BrickletRemoteSwitchV2.CALLBACK_SWITCHING_DONE
Funktions ID:2
Antwort:keine Nutzdaten

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe get_switching_state.

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_A
Funktions ID:

14

Antwort:
  • house_code -- uint8
  • receiver_code -- uint8
  • switch_to -- uint8
  • repeats -- uint16

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 set_remote_configuration. 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für switch_to
  • 1: on, für switch_to
BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_B
Funktions ID:

15

Antwort:
  • address -- uint32
  • unit -- uint8
  • switch_to -- uint8
  • dim_value -- uint8
  • repeats -- uint16

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 set_remote_configuration. 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für switch_to
  • 1: on, für switch_to
BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_C
Funktions ID:

16

Antwort:
  • system_code -- char
  • device_code -- uint8
  • switch_to -- uint8
  • repeats -- uint16

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 set_remote_configuration. 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für switch_to
  • 1: on, für switch_to