MQTT - Remote Switch Bricklet 2.0

Dies ist die Beschreibung der MQTT 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 MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Remote Callback

Download (example-remote-callback.txt)

1
2
3
4
5
6
7
8
9
# Change XYZ to the UID of your Remote Switch Bricklet 2.0

setup:
    # Configure to receive from remote type A with minimum repeats set to 1 and enable callback
    publish '{"remote_type": "a", "minimum_repeats": 1, "callback_enabled": true}' to tinkerforge/request/remote_switch_v2_bricklet/XYZ/set_remote_configuration

    # Handle incoming remote status a callbacks
    subscribe to tinkerforge/callback/remote_switch_v2_bricklet/XYZ/remote_status_a
    publish '{"register": true}' to tinkerforge/register/remote_switch_v2_bricklet/XYZ/remote_status_a # Register remote_status_a callback

Switch Socket

Download (example-switch-socket.txt)

1
2
3
4
5
6
7
8
9
# Change XYZ to the UID of your Remote Switch Bricklet 2.0

setup:
    # 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.
    publish '{"house_code": 17, "receiver_code": 1, "switch_to": "on"}' to tinkerforge/request/remote_switch_v2_bricklet/XYZ/switch_socket_a

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/remote_switch_v2_bricklet/<UID>/get_switching_state
Anfrage:
  • keine Nutzdaten
Antwort:
  • state – Typ: int, Wertebereich: Siehe Symbole

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 request/remote_switch_v2_bricklet/<UID>/set_repeats.

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

Für state:

  • "ready" = 0
  • "busy" = 1
request/remote_switch_v2_bricklet/<UID>/switch_socket_a
Anfrage:
  • house_code – Typ: int, Wertebereich: [0 bis 31]
  • receiver_code – Typ: int, Wertebereich: [0 bis 31]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
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 Symbole sind für diese Funktion verfügbar:

Für switch_to:

  • "off" = 0
  • "on" = 1
request/remote_switch_v2_bricklet/<UID>/switch_socket_b
Anfrage:
  • address – Typ: int, Wertebereich: [0 bis 226 - 1]
  • unit – Typ: int, Wertebereich: [0 bis 15, 255]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
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 Symbole sind für diese Funktion verfügbar:

Für switch_to:

  • "off" = 0
  • "on" = 1
request/remote_switch_v2_bricklet/<UID>/dim_socket_b
Anfrage:
  • address – Typ: int, Wertebereich: [0 bis 226 - 1]
  • unit – Typ: int, Wertebereich: [0 bis 15, 255]
  • dim_value – Typ: int, 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.

request/remote_switch_v2_bricklet/<UID>/switch_socket_c
Anfrage:
  • system_code – Typ: char, Wertebereich: ["A" bis "P"]
  • device_code – Typ: int, Wertebereich: [1 bis 16]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
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 Symbole sind für diese Funktion verfügbar:

Für switch_to:

  • "off" = 0
  • "on" = 1
request/remote_switch_v2_bricklet/<UID>/set_remote_configuration
Anfrage:
  • remote_type – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • minimum_repeats – Typ: int, Wertebereich: [0 bis 216 - 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.

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

Für remote_type:

  • "a" = 0
  • "b" = 1
  • "c" = 2
request/remote_switch_v2_bricklet/<UID>/get_remote_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • remote_type – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • minimum_repeats – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 2
  • callback_enabled – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück wie von request/remote_switch_v2_bricklet/<UID>/set_remote_configuration gesetzt.

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

Für remote_type:

  • "a" = 0
  • "b" = 1
  • "c" = 2
request/remote_switch_v2_bricklet/<UID>/get_remote_status_a
Anfrage:
  • keine Nutzdaten
Antwort:
  • house_code – Typ: int, Wertebereich: [0 bis 31]
  • receiver_code – Typ: int, Wertebereich: [0 bis 31]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 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 request/remote_switch_v2_bricklet/<UID>/set_remote_configuration und register/remote_switch_v2_bricklet/<UID>/remote_status_a Callback.

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

Für switch_to:

  • "off" = 0
  • "on" = 1
request/remote_switch_v2_bricklet/<UID>/get_remote_status_b
Anfrage:
  • keine Nutzdaten
Antwort:
  • address – Typ: int, Wertebereich: [0 bis 226 - 1]
  • unit – Typ: int, Wertebereich: [0 bis 15]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
  • dim_value – Typ: int, Wertebereich: [0 bis 255]
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 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 request/remote_switch_v2_bricklet/<UID>/set_remote_configuration und register/remote_switch_v2_bricklet/<UID>/remote_status_b Callback.

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

Für switch_to:

  • "off" = 0
  • "on" = 1
request/remote_switch_v2_bricklet/<UID>/get_remote_status_c
Anfrage:
  • keine Nutzdaten
Antwort:
  • system_code – Typ: char, Wertebereich: ["A" bis "P"]
  • device_code – Typ: int, Wertebereich: [1 bis 16]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 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 request/remote_switch_v2_bricklet/<UID>/set_remote_configuration und register/remote_switch_v2_bricklet/<UID>/remote_status_c Callback.

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

Für switch_to:

  • "off" = 0
  • "on" = 1

Fortgeschrittene Funktionen

request/remote_switch_v2_bricklet/<UID>/set_repeats
Anfrage:
  • repeats – Typ: int, 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.

request/remote_switch_v2_bricklet/<UID>/get_repeats
Anfrage:
  • keine Nutzdaten
Antwort:
  • repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5

Gibt die Anzahl der Wiederholungen zurück, wie von request/remote_switch_v2_bricklet/<UID>/set_repeats gesetzt.

request/remote_switch_v2_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 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.

request/remote_switch_v2_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, 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 Symbole sind für diese Funktion verfügbar:

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/remote_switch_v2_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/remote_switch_v2_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/remote_switch_v2_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 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.

request/remote_switch_v2_bricklet/<UID>/reset
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.

request/remote_switch_v2_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Remote Switch 2.0.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix 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.

register/remote_switch_v2_bricklet/<UID>/switching_done
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • keine Nutzdaten

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/remote_switch_v2_bricklet/<UID>/switching_done[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/remote_switch_v2_bricklet/<UID>/switching_done[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe request/remote_switch_v2_bricklet/<UID>/get_switching_state.

register/remote_switch_v2_bricklet/<UID>/remote_status_a
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • house_code – Typ: int, Wertebereich: [0 bis 31]
  • receiver_code – Typ: int, Wertebereich: [0 bis 31]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/remote_switch_v2_bricklet/<UID>/remote_status_a[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/remote_switch_v2_bricklet/<UID>/remote_status_a[/<SUFFIX>]-Topic veröffentlicht.

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 request/remote_switch_v2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für switch_to:

  • "off" = 0
  • "on" = 1
register/remote_switch_v2_bricklet/<UID>/remote_status_b
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • address – Typ: int, Wertebereich: [0 bis 226 - 1]
  • unit – Typ: int, Wertebereich: [0 bis 15, 255]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
  • dim_value – Typ: int, Wertebereich: [0 bis 255]
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/remote_switch_v2_bricklet/<UID>/remote_status_b[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/remote_switch_v2_bricklet/<UID>/remote_status_b[/<SUFFIX>]-Topic veröffentlicht.

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 request/remote_switch_v2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für switch_to:

  • "off" = 0
  • "on" = 1
register/remote_switch_v2_bricklet/<UID>/remote_status_c
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • system_code – Typ: char, Wertebereich: ["A" bis "P"]
  • device_code – Typ: int, Wertebereich: [1 bis 16]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
  • repeats – Typ: int, Wertebereich: [0 bis 216 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/remote_switch_v2_bricklet/<UID>/remote_status_c[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/remote_switch_v2_bricklet/<UID>/remote_status_c[/<SUFFIX>]-Topic veröffentlicht.

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 request/remote_switch_v2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für switch_to:

  • "off" = 0
  • "on" = 1

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.

request/remote_switch_v2_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • status – Typ: int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/remote_switch_v2_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/remote_switch_v2_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/remote_switch_v2_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/remote_switch_v2_bricklet/<UID>/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.

request/remote_switch_v2_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/remote_switch_v2_bricklet/<UID>/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.

request/remote_switch_v2_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 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.

request/remote_switch_v2_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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