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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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
|
Mögliche Exit Codes für alle tinkerforge Befehle sind:
Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.
Parameter: |
|
---|
Der call Befehl wird verwendet um eine Funktion des RS232 Bricklet 2.0 aufzurufen. Der Befehl kennt mehrere Optionen:
Parameter: |
|
---|
Der dispatch Befehl wird verwendet um eingehende Callbacks des RS232 Bricklet 2.0 abzufertigen. Der Befehl kennt mehrere Optionen:
Parameter: |
|
---|
Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:
Getter-Funktionen kennen zusätzlich die folgenden Optionen:
Setter-Funktionen kennen zusätzlich die folgenden Optionen:
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.
Parameter: |
|
---|
Der abzufertigende <callback> kennt mehrere Optionen:
Parameter: |
|
---|---|
Ausgabe: |
|
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.
Parameter: |
|
---|---|
Ausgabe: |
|
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.
Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Konfiguration für die RS232-Kommunikation.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <parity>:
Für <stopbits>:
Für <wordlength>:
Für <flowcontrol>:
Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-configuration gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für parity:
Für stopbits:
Für wordlength:
Für flowcontrol:
Parameter: |
|
---|---|
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.
Ausgabe: |
|
---|
Gibt die Buffer-Konfiguration zurück, wie von set-buffer-config gesetzt.
Ausgabe: |
|
---|
Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.
Siehe set-buffer-config zur Konfiguration der Buffergrößen.
Ausgabe: |
|
---|
Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.
Ausgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
Parameter: |
|
---|---|
Ausgabe: |
|
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>:
Für status:
Ausgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
Parameter: |
|
---|---|
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.
Parameter: |
|
---|---|
Ausgabe: |
|
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.
Parameter: |
|
---|---|
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>:
Ausgabe: |
|
---|
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:
Ausgabe: |
|
---|
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.
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.
Parameter: |
|
---|---|
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.
Ausgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
Ausgabe: |
|
---|
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.
Ausgabe: |
|
---|
Aktiviert den read Callback.
Im Startzustand ist der Callback deaktiviert.
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.
Ausgabe: |
|
---|
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.
Ausgabe: |
|
---|
Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.