Shell - Remote Switch Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Switch Socket

Download (example-switch-socket.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Remote Switch Bricklet 2.0

# 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.
tinkerforge call remote-switch-v2-bricklet $uid switch-socket-a 17 1 switch-to-on

Remote Callback

Download (example-remote-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Remote Switch Bricklet 2.0

# Configure to receive from remote type A with minimum repeats set to 1 and enable callback
tinkerforge call remote-switch-v2-bricklet $uid set-remote-configuration remote-type-a 1 true

# Handle incoming remote status a callbacks
tinkerforge dispatch remote-switch-v2-bricklet $uid remote-status-a &

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call remote-switch-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Remote Switch Bricklet 2.0 aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des Remote Switch Bricklet 2.0 an und endet dann
tinkerforge dispatch remote-switch-v2-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Remote Switch Bricklet 2.0 abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des Remote Switch Bricklet 2.0 an und endet dann
tinkerforge call remote-switch-v2-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch remote-switch-v2-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call remote-switch-v2-bricklet <uid> get-switching-state
Ausgabe:
  • 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 set-repeats.

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

Für state:

  • switching-state-ready = 0
  • switching-state-busy = 1
tinkerforge call remote-switch-v2-bricklet <uid> switch-socket-a <house-code> <receiver-code> <switch-to>
Parameter:
  • <house-code> – Typ: Int, Wertebereich: [0 bis 31]
  • <receiver-code> – Typ: Int, Wertebereich: [0 bis 31]
  • <switch-to> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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

  • switch-to-off = 0
  • switch-to-on = 1
tinkerforge call remote-switch-v2-bricklet <uid> switch-socket-b <address> <unit> <switch-to>
Parameter:
  • <address> – Typ: Int, Wertebereich: [0 bis 226 - 1]
  • <unit> – Typ: Int, Wertebereich: [0 bis 15, 255]
  • <switch-to> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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

  • switch-to-off = 0
  • switch-to-on = 1
tinkerforge call remote-switch-v2-bricklet <uid> dim-socket-b <address> <unit> <dim-value>
Parameter:
  • <address> – Typ: Int, Wertebereich: [0 bis 226 - 1]
  • <unit> – Typ: Int, Wertebereich: [0 bis 15, 255]
  • <dim-value> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call remote-switch-v2-bricklet <uid> switch-socket-c <system-code> <device-code> <switch-to>
Parameter:
  • <system-code> – Typ: Char, Wertebereich: [A bis P]
  • <device-code> – Typ: Int, Wertebereich: [1 bis 16]
  • <switch-to> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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

  • switch-to-off = 0
  • switch-to-on = 1
tinkerforge call remote-switch-v2-bricklet <uid> set-remote-configuration <remote-type> <minimum-repeats> <callback-enabled>
Parameter:
  • <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
Ausgabe:
  • keine Ausgabe

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 remote-status-a Callback, remote-status-b Callback und remote-status-c Callback).

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

Für <remote-type>:

  • remote-type-a = 0
  • remote-type-b = 1
  • remote-type-c = 2
tinkerforge call remote-switch-v2-bricklet <uid> get-remote-configuration
Ausgabe:
  • 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 set-remote-configuration gesetzt.

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

Für remote-type:

  • remote-type-a = 0
  • remote-type-b = 1
  • remote-type-c = 2
tinkerforge call remote-switch-v2-bricklet <uid> get-remote-status-a
Ausgabe:
  • 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 set-remote-configuration und remote-status-a Callback.

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

Für switch-to:

  • switch-to-off = 0
  • switch-to-on = 1
tinkerforge call remote-switch-v2-bricklet <uid> get-remote-status-b
Ausgabe:
  • 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 set-remote-configuration und remote-status-b Callback.

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

Für switch-to:

  • switch-to-off = 0
  • switch-to-on = 1
tinkerforge call remote-switch-v2-bricklet <uid> get-remote-status-c
Ausgabe:
  • 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 set-remote-configuration und remote-status-c Callback.

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

Für switch-to:

  • switch-to-off = 0
  • switch-to-on = 1

Fortgeschrittene Funktionen

tinkerforge call remote-switch-v2-bricklet <uid> set-repeats <repeats>
Parameter:
  • <repeats> – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 5
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call remote-switch-v2-bricklet <uid> get-repeats
Ausgabe:
  • repeats – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 5

Gibt die Anzahl der Wiederholungen zurück, wie von set-repeats gesetzt.

tinkerforge call remote-switch-v2-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • 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.

tinkerforge call remote-switch-v2-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

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

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call remote-switch-v2-bricklet <uid> get-status-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

Für config:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call remote-switch-v2-bricklet <uid> get-chip-temperature
Ausgabe:
  • 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.

tinkerforge call remote-switch-v2-bricklet <uid> reset
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call remote-switch-v2-bricklet <uid> get-identity
Ausgabe:
  • 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 Array, 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 Array, 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]

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. 

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch remote-switch-v2-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

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.

tinkerforge dispatch remote-switch-v2-bricklet <uid> switching-done
Ausgabe:
  • keine Ausgabe

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe get-switching-state.

tinkerforge dispatch remote-switch-v2-bricklet <uid> remote-status-a
Ausgabe:
  • 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.

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

Für switch-to:

  • switch-to-off = 0
  • switch-to-on = 1
tinkerforge dispatch remote-switch-v2-bricklet <uid> remote-status-b
Ausgabe:
  • 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]

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

Für switch-to:

  • switch-to-off = 0
  • switch-to-on = 1
tinkerforge dispatch remote-switch-v2-bricklet <uid> remote-status-c
Ausgabe:
  • 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.

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

Für switch-to:

  • switch-to-off = 0
  • switch-to-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.

tinkerforge call remote-switch-v2-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • 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-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

  • bootloader-status-ok = 0
  • bootloader-status-invalid-mode = 1
  • bootloader-status-no-change = 2
  • bootloader-status-entry-function-not-present = 3
  • bootloader-status-device-identifier-incorrect = 4
  • bootloader-status-crc-mismatch = 5
tinkerforge call remote-switch-v2-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

Für mode:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4
tinkerforge call remote-switch-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call remote-switch-v2-bricklet <uid> write-firmware <data>
Parameter:
  • <data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:
  • status – Typ: Int, 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.

tinkerforge call remote-switch-v2-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call remote-switch-v2-bricklet <uid> read-uid
Ausgabe:
  • 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.