Spezifikationen / Modbus Protokoll / API / Bricklets / Remote Switch Bricklet 2.0

Modbus - Remote Switch Bricklet 2.0¶

Dies ist die Beschreibung des Modbus 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 Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletRemoteSwitchV2.get_switching_state¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	state – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Elemente dieser Funktion definiert:

Für state:

0 = Ready
1 = Busy

BrickletRemoteSwitchV2.switch_socket_a¶

Funktions-ID:	5
Anfrage:	house_code – Typ: uint8, Wertebereich: [0 bis 31] receiver_code – Typ: uint8, Wertebereich: [0 bis 31] switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen
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.

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

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

Für switch_to:

0 = Off
1 = On

BrickletRemoteSwitchV2.switch_socket_b¶

Funktions-ID:	6
Anfrage:	address – Typ: uint32, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: uint8, Wertebereich: [0 bis 15, 255] switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen
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.

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 Elemente dieser Funktion definiert:

Für switch_to:

0 = Off
1 = On

BrickletRemoteSwitchV2.dim_socket_b¶

Funktions-ID:	7
Anfrage:	address – Typ: uint32, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: uint8, Wertebereich: [0 bis 15, 255] dim_value – Typ: uint8, Wertebereich: [0 bis 255]
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.

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 – Typ: char, Wertebereich: ['A' bis 'P'] device_code – Typ: uint8, Wertebereich: [1 bis 16] switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen
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.

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

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

Für switch_to:

0 = Off
1 = On

BrickletRemoteSwitchV2.set_remote_configuration¶

Funktions-ID:	9
Anfrage:	remote_type – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 minimum_repeats – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2 callback_enabled – Typ: bool, Standardwert: false
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).

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

Für remote_type:

0 = A
1 = B
2 = C

BrickletRemoteSwitchV2.get_remote_configuration¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	remote_type – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 minimum_repeats – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2 callback_enabled – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück wie von set_remote_configuration gesetzt.

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

Für remote_type:

0 = A
1 = B
2 = C

BrickletRemoteSwitchV2.get_remote_status_a¶

Funktions-ID:	11
Anfrage:	keine Nutzdaten
Antwort:	house_code – Typ: uint8, Wertebereich: [0 bis 31] receiver_code – Typ: uint8, Wertebereich: [0 bis 31] switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen repeats – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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 Elemente dieser Funktion definiert:

Für switch_to:

0 = Off
1 = On

BrickletRemoteSwitchV2.get_remote_status_b¶

Funktions-ID:	12
Anfrage:	keine Nutzdaten
Antwort:	address – Typ: uint32, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: uint8, Wertebereich: [0 bis 15] switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen dim_value – Typ: uint8, Wertebereich: [0 bis 255] repeats – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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 Elemente dieser Funktion definiert:

Für switch_to:

0 = Off
1 = On

BrickletRemoteSwitchV2.get_remote_status_c¶

Funktions-ID:	13
Anfrage:	keine Nutzdaten
Antwort:	system_code – Typ: char, Wertebereich: ['A' bis 'P'] device_code – Typ: uint8, Wertebereich: [1 bis 16] switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen repeats – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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 Elemente dieser Funktion definiert:

Für switch_to:

0 = Off
1 = On

Fortgeschrittene Funktionen¶

BrickletRemoteSwitchV2.set_repeats¶

Funktions-ID:	3
Anfrage:	repeats – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 5
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.

BrickletRemoteSwitchV2.get_repeats¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	repeats – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 5

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 – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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_status_led_config¶

Funktions-ID:	239
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
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 Elemente dieser Funktion definiert:

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletRemoteSwitchV2.get_status_led_config¶

Funktions-ID:	240
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

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

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

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletRemoteSwitchV2.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

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.

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 bestehenden führen zu undefiniertem Verhalten.

BrickletRemoteSwitchV2.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 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.

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 – Typ: uint8, Wertebereich: [0 bis 31] receiver_code – Typ: uint8, Wertebereich: [0 bis 31] switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen repeats – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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 Elemente dieser Funktion definiert:

Für switch_to:

0 = Off
1 = On

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_B¶

Funktions-ID:	15
Antwort:	address – Typ: uint32, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: uint8, Wertebereich: [0 bis 15, 255] switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen dim_value – Typ: uint8, Wertebereich: [0 bis 255] repeats – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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

Für switch_to:

0 = Off
1 = On

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_C¶

Funktions-ID:	16
Antwort:	system_code – Typ: char, Wertebereich: ['A' bis 'P'] device_code – Typ: uint8, Wertebereich: [1 bis 16] switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen repeats – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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

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

Für switch_to:

0 = Off
1 = On

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletRemoteSwitchV2.set_bootloader_mode¶

Funktions-ID:	235
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

Für mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

Für status:

0 = OK
1 = Invalid Mode
2 = No Change
3 = Entry Function Not Present
4 = Device Identifier Incorrect
5 = CRC Mismatch

BrickletRemoteSwitchV2.get_bootloader_mode¶

Funktions-ID:	236
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

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

Für mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

BrickletRemoteSwitchV2.set_write_firmware_pointer¶

Funktions-ID:	237
Anfrage:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
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 – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: [0 bis 255]

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.write_uid¶

Funktions-ID:	248
Anfrage:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1]
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 – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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