MQTT - RS232 Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (example-loopback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# For this example connect the RX1 and TX pin to receive the send message

# Change XYZ to the UID of your RS232 Bricklet 2.0

setup:
    # Handle incoming read callbacks
    subscribe to tinkerforge/callback/rs232_v2_bricklet/XYZ/read # Received messages contain the message as string
    publish '{"register": true}' to tinkerforge/register/rs232_v2_bricklet/XYZ/read # Register read callback
    
    # Enable read callback
    publish '' to tinkerforge/request/rs232_v2_bricklet/XYZ/enable_read_callback 
    
    # Write "test" string
    publish '{"message": "test"}' to tinkerforge/request/rs232_v2_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_v2_bricklet/<UID>/write
Anfrage:
  • message – Typ: [char, ...], Länge: variabel
Antwort:
  • 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 request/rs232_v2_bricklet/<UID>/set_configuration für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

request/rs232_v2_bricklet/<UID>/read
Anfrage:
  • length – Typ: int, Wertebereich: [0 bis 216 - 1]
Antwort:
  • message – Typ: [char, ...], 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 request/rs232_v2_bricklet/<UID>/enable_read_callback und register/rs232_v2_bricklet/<UID>/read Callback.

request/rs232_v2_bricklet/<UID>/set_configuration
Anfrage:
  • 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
Antwort:
  • keine Antwort

Setzt die Konfiguration für die RS232-Kommunikation.

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

Für parity:

  • "none" = 0
  • "odd" = 1
  • "even" = 2

Für stopbits:

  • "1" = 1
  • "2" = 2

Für wordlength:

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

Für flowcontrol:

  • "off" = 0
  • "software" = 1
  • "hardware" = 2
request/rs232_v2_bricklet/<UID>/get_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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 request/rs232_v2_bricklet/<UID>/set_configuration gesetzt.

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

Für parity:

  • "none" = 0
  • "odd" = 1
  • "even" = 2

Für stopbits:

  • "1" = 1
  • "2" = 2

Für wordlength:

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

Für flowcontrol:

  • "off" = 0
  • "software" = 1
  • "hardware" = 2

Fortgeschrittene Funktionen

request/rs232_v2_bricklet/<UID>/set_buffer_config
Anfrage:
  • 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
Antwort:
  • keine Antwort

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 request/rs232_v2_bricklet/<UID>/write übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS232 empfangen wurden aber noch nicht über request/rs232_v2_bricklet/<UID>/read oder register/rs232_v2_bricklet/<UID>/read Callback an ein Nutzerprogramm übertragen werden konnten.

request/rs232_v2_bricklet/<UID>/get_buffer_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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 request/rs232_v2_bricklet/<UID>/set_buffer_config gesetzt.

request/rs232_v2_bricklet/<UID>/get_buffer_status
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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 request/rs232_v2_bricklet/<UID>/set_buffer_config zur Konfiguration der Buffergrößen.

request/rs232_v2_bricklet/<UID>/get_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/rs232_v2_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/rs232_v2_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • 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" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/rs232_v2_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/rs232_v2_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/rs232_v2_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/rs232_v2_bricklet/<UID>/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.

request/rs232_v2_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/rs232_v2_bricklet/<UID>/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.

request/rs232_v2_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

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:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/rs232_v2_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/rs232_v2_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/rs232_v2_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/rs232_v2_bricklet/<UID>/reset
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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.

request/rs232_v2_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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.

request/rs232_v2_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/rs232_v2_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", "i", "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 216 - 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 '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. 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 2.0.

Konfigurationsfunktionen für Callbacks

request/rs232_v2_bricklet/<UID>/enable_read_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert den register/rs232_v2_bricklet/<UID>/read Callback.

Im Startzustand ist der Callback deaktiviert.

request/rs232_v2_bricklet/<UID>/disable_read_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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

Im Startzustand ist der Callback deaktiviert.

request/rs232_v2_bricklet/<UID>/is_read_callback_enabled
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

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

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_v2_bricklet/<UID>/read
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • message – Typ: [char, ...], Länge: variabel

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

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

Dieser Callback kann durch request/rs232_v2_bricklet/<UID>/enable_read_callback aktiviert werden.

Bemerkung

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

register/rs232_v2_bricklet/<UID>/error_count
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • error_count_overrun – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_parity – Typ: int, Wertebereich: [0 bis 232 - 1]

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

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