Shell - RS232 Bricklet 2.0

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

Loopback

Download (example-loopback.sh)

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

# For this example connect the RX1 and TX pin to receive the send message

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

# Handle incoming read callbacks
tinkerforge dispatch rs232-v2-bricklet $uid read &

# Enable read callback
tinkerforge call rs232-v2-bricklet $uid enable-read-callback

# Write "test" string
tinkerforge call rs232-v2-bricklet $uid write t,e,s,t

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 rs232-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des RS232 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 RS232 Bricklet 2.0 an und endet dann
tinkerforge dispatch rs232-v2-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des RS232 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 RS232 Bricklet 2.0 an und endet dann
tinkerforge call rs232-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 rs232-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 rs232-v2-bricklet <uid> write <message>
Parameter:
  • <message> – Typ: Char Array, Länge: variabel
Ausgabe:
  • message-written – Typ: Int, Wertebereich: [0 bis 216 - 1]

Schreibt Zeichen auf die RS232-Schnittstelle. Die Zeichen können Binärdaten sein, ASCII o.ä. ist nicht notwendig.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben wurden.

Siehe set-configuration für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

tinkerforge call rs232-v2-bricklet <uid> read <length>
Parameter:
  • <length> – Typ: Int, Wertebereich: [0 bis 216 - 1]
Ausgabe:
  • message – Typ: Char Array, Länge: variabel

Gibt bis zu length Zeichen aus dem Empfangsbuffer zurück.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn der Read-Callback nicht aktiv ist. Siehe enable-read-callback und read Callback.

tinkerforge call rs232-v2-bricklet <uid> set-configuration <baudrate> <parity> <stopbits> <wordlength> <flowcontrol>
Parameter:
  • <baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200
  • <parity> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • <stopbits> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • <wordlength> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 8
  • <flowcontrol> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt die Konfiguration für die RS232-Kommunikation.

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

Für <parity>:

  • parity-none = 0
  • parity-odd = 1
  • parity-even = 2

Für <stopbits>:

  • stopbits-1 = 1
  • stopbits-2 = 2

Für <wordlength>:

  • wordlength-5 = 5
  • wordlength-6 = 6
  • wordlength-7 = 7
  • wordlength-8 = 8

Für <flowcontrol>:

  • flowcontrol-off = 0
  • flowcontrol-software = 1
  • flowcontrol-hardware = 2
tinkerforge call rs232-v2-bricklet <uid> get-configuration
Ausgabe:
  • baudrate – Typ: Int, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200
  • parity – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • stopbits – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • wordlength – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 8
  • flowcontrol – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von set-configuration gesetzt.

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

Für parity:

  • parity-none = 0
  • parity-odd = 1
  • parity-even = 2

Für stopbits:

  • stopbits-1 = 1
  • stopbits-2 = 2

Für wordlength:

  • wordlength-5 = 5
  • wordlength-6 = 6
  • wordlength-7 = 7
  • wordlength-8 = 8

Für flowcontrol:

  • flowcontrol-off = 0
  • flowcontrol-software = 1
  • flowcontrol-hardware = 2

Fortgeschrittene Funktionen

tinkerforge call rs232-v2-bricklet <uid> set-buffer-config <send-buffer-size> <receive-buffer-size>
Parameter:
  • <send-buffer-size> – Typ: Int, Einheit: 1 B, Wertebereich: [1024 bis 9216], Standardwert: 5120
  • <receive-buffer-size> – Typ: Int, Einheit: 1 B, Wertebereich: [1024 bis 9216], Standardwert: 5120
Ausgabe:
  • keine Ausgabe

Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10KiB) haben, die Minimalgröße ist 1024 Byte (1KiB) für beide.

Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.

Der Sendebuffer hält die Daten welche über write übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS232 empfangen wurden aber noch nicht über read oder read Callback an ein Nutzerprogramm übertragen werden konnten.

tinkerforge call rs232-v2-bricklet <uid> get-buffer-config
Ausgabe:
  • send-buffer-size – Typ: Int, Einheit: 1 B, Wertebereich: [1024 bis 9216], Standardwert: 5120
  • receive-buffer-size – Typ: Int, Einheit: 1 B, Wertebereich: [1024 bis 9216], Standardwert: 5120

Gibt die Buffer-Konfiguration zurück, wie von set-buffer-config gesetzt.

tinkerforge call rs232-v2-bricklet <uid> get-buffer-status
Ausgabe:
  • send-buffer-used – Typ: Int, Einheit: 1 B, Wertebereich: [1024 bis 9216]
  • receive-buffer-used – Typ: Int, Einheit: 1 B, Wertebereich: [1024 bis 9216]

Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.

Siehe set-buffer-config zur Konfiguration der Buffergrößen.

tinkerforge call rs232-v2-bricklet <uid> get-error-count
Ausgabe:
  • error-count-overrun – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-parity – Typ: Int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.

tinkerforge call rs232-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 rs232-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 rs232-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 rs232-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 rs232-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 rs232-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 rs232-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 rs232-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 rs232-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 rs232-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 rs232-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.

tinkerforge call rs232-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. 

Konfigurationsfunktionen für Callbacks

tinkerforge call rs232-v2-bricklet <uid> enable-read-callback
Ausgabe:
  • keine Ausgabe

Aktiviert den read Callback.

Im Startzustand ist der Callback deaktiviert.

tinkerforge call rs232-v2-bricklet <uid> disable-read-callback
Ausgabe:
  • keine Ausgabe

Deaktiviert den read Callback.

Im Startzustand ist der Callback deaktiviert.

tinkerforge call rs232-v2-bricklet <uid> is-read-callback-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: false

Gibt true zurück falls read Callback aktiviert ist, false sonst.

Callbacks

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

tinkerforge dispatch rs232-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 rs232-v2-bricklet <uid> read
Ausgabe:
  • message – Typ: Char Array, Länge: variabel

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.

Dieser Callback kann durch enable-read-callback aktiviert werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit None für message ausgelöst.

tinkerforge dispatch rs232-v2-bricklet <uid> error-count
Ausgabe:
  • error-count-overrun – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-parity – Typ: Int, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.