Software / API Bindings / MQTT / API Referenz und Beispiele / Bricklets / RS232 Bricklet

MQTT - RS232 Bricklet¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback¶

Download (example-loopback.txt)

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

# Change XYZ to the UID of your RS232 Bricklet

setup:
    # Handle incoming read callbacks
    subscribe to tinkerforge/callback/rs232_bricklet/XYZ/read # Received messages contain the message as string and it's length as int
    publish '{"register": true}' to tinkerforge/register/rs232_bricklet/XYZ/read # Register read callback

    # Enable read callback
    publish '' to tinkerforge/request/rs232_bricklet/XYZ/enable_read_callback

    # Write "test" string
    publish '{"message": "test", "length": 4}' to tinkerforge/request/rs232_bricklet/XYZ/write

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/rs232_bricklet/<UID>/write¶

Anfrage:	message – Typ: [char, ...], Länge: 60 length – Typ: int, Wertebereich: [0 bis 60]
Antwort:	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 request/rs232_bricklet/<UID>/set_configuration für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

request/rs232_bricklet/<UID>/read¶

Anfrage:	keine Nutzdaten
Antwort:	message – Typ: [char, ...], 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 zurückgegebene Länge 0 ist, waren keine neuen Daten verfügbar.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe request/rs232_bricklet/<UID>/enable_read_callback und register/rs232_bricklet/<UID>/read Callback.

request/rs232_bricklet/<UID>/set_configuration¶

Anfrage:

Anfrage:	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
Antwort:	keine Antwort

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

Antwort:

keine Antwort

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:

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

Für parity:

"none" = 0
"odd" = 1
"even" = 2
"forced_parity_1" = 3
"forced_parity_0" = 4

Für stopbits:

"1" = 1
"2" = 2

Für wordlength:

"5" = 5
"6" = 6
"7" = 7
"8" = 8

Für hardware_flowcontrol:

"off" = 0
"on" = 1

Für software_flowcontrol:

"off" = 0
"on" = 1

request/rs232_bricklet/<UID>/get_configuration¶

Anfrage:

keine Nutzdaten

Antwort:

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 request/rs232_bricklet/<UID>/set_configuration gesetzt.

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

Für baudrate:

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

Für parity:

"none" = 0
"odd" = 1
"even" = 2
"forced_parity_1" = 3
"forced_parity_0" = 4

Für stopbits:

"1" = 1
"2" = 2

Für wordlength:

"5" = 5
"6" = 6
"7" = 7
"8" = 8

Für hardware_flowcontrol:

"off" = 0
"on" = 1

Für software_flowcontrol:

"off" = 0
"on" = 1

request/rs232_bricklet/<UID>/set_break_condition¶

Anfrage:	break_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	keine Antwort

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).

request/rs232_bricklet/<UID>/read_frame¶

Anfrage:	keine Nutzdaten
Antwort:	message – Typ: [char, ...], Länge: 60 length – Typ: int, Wertebereich: [0 bis 60]

Gibt bis zu einem Frame an Daten aus dem Lesebuffer zurück. Die Größe eines Frames kann mit request/rs232_bricklet/<UID>/set_frame_readable_callback_configuration konfiguriert werden. Wenn die zurückgegebene Länge 0 ist, waren keine neuen Daten verfügbar.

Neu in Version 2.0.4 (Plugin).

Fortgeschrittene Funktionen¶

request/rs232_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", "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 2¹⁶ - 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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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 RS232.

Konfigurationsfunktionen für Callbacks¶

request/rs232_bricklet/<UID>/enable_read_callback¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Aktiviert den register/rs232_bricklet/<UID>/read Callback. Dies deaktiviert den register/rs232_bricklet/<UID>/frame_readable Callback.

Im Startzustand ist der Callback deaktiviert

request/rs232_bricklet/<UID>/disable_read_callback¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Deaktiviert den register/rs232_bricklet/<UID>/read Callback.

Im Startzustand ist der Callback deaktiviert

request/rs232_bricklet/<UID>/is_read_callback_enabled¶

Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

Gibt true zurück falls register/rs232_bricklet/<UID>/read Callback aktiviert ist, false sonst.

request/rs232_bricklet/<UID>/set_frame_readable_callback_configuration¶

Anfrage:	frame_size – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0
Antwort:	keine Antwort

Konfiguriert den register/rs232_bricklet/<UID>/frame_readable Callback. Die Frame Size ist die Anzahl an Bytes, die lesbar sein müssen, damit der Callback auslöst. Eine Frame Size von 0 deaktiviert den Callback. Eine Frame Size größer als 0 aktiviert diesen und deaktiviert den register/rs232_bricklet/<UID>/read Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.4 (Plugin).

request/rs232_bricklet/<UID>/get_frame_readable_callback_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	frame_size – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels request/rs232_bricklet/<UID>/set_frame_readable_callback_configuration gesetzt.

Neu in Version 2.0.4 (Plugin).

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/rs232_bricklet/<UID>/read¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	message – Typ: [char, ...], Länge: 60 length – Typ: int, Wertebereich: [1 bis 60]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/rs232_bricklet/<UID>/read[/<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/rs232_bricklet/<UID>/read[/<SUFFIX>]-Topic veröffentlicht.

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 request/rs232_bricklet/<UID>/enable_read_callback aktiviert werden.

register/rs232_bricklet/<UID>/error¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	error – Typ: int, Wertebereich: Siehe Symbole

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/rs232_bricklet/<UID>/error[/<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/rs232_bricklet/<UID>/error[/<SUFFIX>]-Topic veröffentlicht.

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:

"overrun" = 1
"parity" = 2
"framing" = 4

Neu in Version 2.0.1 (Plugin).

register/rs232_bricklet/<UID>/frame_readable¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	frame_count – Typ: int, Wertebereich: [0 bis 255]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/rs232_bricklet/<UID>/frame_readable[/<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/rs232_bricklet/<UID>/frame_readable[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit request/rs232_bricklet/<UID>/set_frame_readable_callback_configuration konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro request/rs232_bricklet/<UID>/read oder request/rs232_bricklet/<UID>/read_frame Aufruf ausgelöst. Das heißt, dass wenn eine Framegröße von X Bytes konfiguriert wird, jedes Mal wenn das Callback ausgelöst wird, X Bytes mit der request/rs232_bricklet/<UID>/read_frame-Funktion gelesen werden können, ohne dass der Frame Count-Payload des Callbacks geprüft werden muss.

Neu in Version 2.0.4 (Plugin).