TCP/IP - RS232 Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das RS232 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletRS232.write
Funktions-ID:
  • 1
Anfrage:
  • message – Typ: char[60]
  • length – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:
  • written – Typ: uint8, Wertebereich: [0 bis 255]

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.

BrickletRS232.read
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • message – Typ: char[60]
  • length – Typ: uint8, Wertebereich: [0 bis 255]

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 CALLBACK_READ Callback.

BrickletRS232.set_configuration
Funktions-ID:
  • 6
Anfrage:
  • baudrate – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • parity – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stopbits – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • wordlength – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • hardware_flowcontrol – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • software_flowcontrol – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

Setzt die Konfiguration für die RS232-Kommunikation. Verfügbare Optionen sind:

  • Baudrate zwischen 300 und 230400 Baud.
  • Parität von None, Odd, Even und Forced Parity.
  • Stop Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8, Hard-/Software Flow Control aus.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für baudrate:

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

Für parity:

  • 0 = None
  • 1 = Odd
  • 2 = Even
  • 3 = Forced Parity 1
  • 4 = Forced Parity 0

Für stopbits:

  • 1 = 1
  • 2 = 2

Für wordlength:

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

Für hardware_flowcontrol:

  • 0 = Off
  • 1 = On

Für software_flowcontrol:

  • 0 = Off
  • 1 = On
BrickletRS232.get_configuration
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • baudrate – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • parity – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stopbits – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • wordlength – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • hardware_flowcontrol – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • software_flowcontrol – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt die Konfiguration zurück, wie von set_configuration gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für baudrate:

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

Für parity:

  • 0 = None
  • 1 = Odd
  • 2 = Even
  • 3 = Forced Parity 1
  • 4 = Forced Parity 0

Für stopbits:

  • 1 = 1
  • 2 = 2

Für wordlength:

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

Für hardware_flowcontrol:

  • 0 = Off
  • 1 = On

Für software_flowcontrol:

  • 0 = Off
  • 1 = On
BrickletRS232.set_break_condition
Funktions-ID:
  • 10
Anfrage:
  • break_time – Typ: uint16, Wertebereich: [0 bis 216 - 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 (in ms).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

BrickletRS232.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char
  • hardware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletRS232.enable_read_callback
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

BrickletRS232.disable_read_callback
Funktions-ID:
  • 4
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

BrickletRS232.is_read_callback_enabled
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool

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

Callbacks

BrickletRS232.CALLBACK_READ
Funktions-ID:
  • 8
Antwort:
  • message – Typ: char[60]
  • length – Typ: uint8, Wertebereich: [0 bis 255]

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.

BrickletRS232.CALLBACK_ERROR
Funktions-ID:
  • 9
Antwort:
  • error – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error:

  • 1 = Overrun
  • 2 = Parity
  • 4 = Framing

Neu in Version 2.0.1 (Plugin).