Shell - RS232 Bricklet

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

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

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

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

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

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

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

Schreibt einen String aus bis zu 60 Zeichen auf die RS232-Schnittstelle. Der String kann aus Binärdaten bestehen, ASCII o.ä. ist nicht notwendig.

Die Länge des Strings muss als ein zusätzlicher Parameter angegeben werden.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben werden konnten.

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

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

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die Länge als 0 gegeben wird, waren keine neuen Daten verfügbar.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe enable-read-callback und read Callback.

tinkerforge call rs232-bricklet <uid> set-configuration <baudrate> <parity> <stopbits> <wordlength> <hardware-flowcontrol> <software-flowcontrol>
Parameter:
  • <baudrate> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 11
  • <parity> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • <stopbits> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • <wordlength> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 8
  • <hardware-flowcontrol> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • <software-flowcontrol> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt die Konfiguration für die RS232-Kommunikation.

Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

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

Für <baudrate>:

  • baudrate-300 = 0
  • baudrate-600 = 1
  • baudrate-1200 = 2
  • baudrate-2400 = 3
  • baudrate-4800 = 4
  • baudrate-9600 = 5
  • baudrate-14400 = 6
  • baudrate-19200 = 7
  • baudrate-28800 = 8
  • baudrate-38400 = 9
  • baudrate-57600 = 10
  • baudrate-115200 = 11
  • baudrate-230400 = 12

Für <parity>:

  • parity-none = 0
  • parity-odd = 1
  • parity-even = 2
  • parity-forced-parity-1 = 3
  • parity-forced-parity-0 = 4

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

  • hardware-flowcontrol-off = 0
  • hardware-flowcontrol-on = 1

Für <software-flowcontrol>:

  • software-flowcontrol-off = 0
  • software-flowcontrol-on = 1
tinkerforge call rs232-bricklet <uid> get-configuration
Ausgabe:
  • baudrate – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 11
  • parity – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • stopbits – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • wordlength – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 8
  • hardware-flowcontrol – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • software-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 baudrate:

  • baudrate-300 = 0
  • baudrate-600 = 1
  • baudrate-1200 = 2
  • baudrate-2400 = 3
  • baudrate-4800 = 4
  • baudrate-9600 = 5
  • baudrate-14400 = 6
  • baudrate-19200 = 7
  • baudrate-28800 = 8
  • baudrate-38400 = 9
  • baudrate-57600 = 10
  • baudrate-115200 = 11
  • baudrate-230400 = 12

Für parity:

  • parity-none = 0
  • parity-odd = 1
  • parity-even = 2
  • parity-forced-parity-1 = 3
  • parity-forced-parity-0 = 4

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

  • hardware-flowcontrol-off = 0
  • hardware-flowcontrol-on = 1

Für software-flowcontrol:

  • software-flowcontrol-off = 0
  • software-flowcontrol-on = 1
tinkerforge call rs232-bricklet <uid> set-break-condition <break-time>
Parameter:
  • <break-time> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
Ausgabe:
  • keine Ausgabe

Setzt eine Break Condition (die TX-Ausgabe wird fest of logisch 0 gezwungen). Der Parameter setzt die Haltezeit der Break Condition.

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

tinkerforge call rs232-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-bricklet <uid> enable-read-callback
Ausgabe:
  • keine Ausgabe

Aktiviert den read Callback.

Im Startzustand ist der Callback deaktiviert

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

Deaktiviert den read Callback.

Im Startzustand ist der Callback deaktiviert

tinkerforge call rs232-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-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-bricklet <uid> read
Ausgabe:
  • message – Typ: Char Array, Länge: 60
  • length – Typ: Int, Wertebereich: [1 bis 60]

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen. Die Nachricht hat eine Maximalgröße von 60 Zeichen. Die Länge der Nachricht wird zusätzlich übergeben.

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

tinkerforge dispatch rs232-bricklet <uid> error
Ausgabe:
  • error – Typ: Int, Wertebereich: Siehe Symbole

Dieser Callback wird aufgerufen wenn ein Fehler auftritt. Mögliche Fehler sind Overrun-, Parity- oder Framing-Fehler.

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

Für error:

  • error-overrun = 1
  • error-parity = 2
  • error-framing = 4

Neu in Version 2.0.1 (Plugin).