TCP/IP - RS232 Bricklet¶

Grundfunktionen¶

BrickletRS232.write¶

Funktions-ID:	1
Anfrage:	message – Typ: char[60] length – Typ: uint8, Wertebereich: [0 bis 60]
Antwort:	written – Typ: uint8, 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.

BrickletRS232.read¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	message – Typ: char[60] length – Typ: uint8, 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 enable_read_callback und CALLBACK_READ Callback.

BrickletRS232.set_configuration¶

Funktions-ID:	6
Anfrage:	baudrate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 11 parity – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 stopbits – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 wordlength – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 8 hardware_flowcontrol – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 software_flowcontrol – Typ: uint8, Wertebereich: Siehe Bedeutungen, 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 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, Standardwert: 11 parity – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 stopbits – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 wordlength – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 8 hardware_flowcontrol – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 software_flowcontrol – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

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, Einheit: 1 ms, 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.

Neu in Version 2.0.2 (Plugin).

BrickletRS232.read_frame¶

Funktions-ID:	14
Anfrage:	keine Nutzdaten
Antwort:	message – Typ: char[60] length – Typ: uint8, Wertebereich: [0 bis 60]

Gibt bis zu einem Frame an Daten aus dem Lesebuffer zurück. Die Größe eines Frames kann mit 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¶

BrickletRS232.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, 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 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. 

Konfigurationsfunktionen für Callbacks¶

BrickletRS232.enable_read_callback¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Aktiviert den CALLBACK_READ Callback. Dies deaktiviert den CALLBACK_FRAME_READABLE 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, Standardwert: false

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

BrickletRS232.set_frame_readable_callback_configuration¶

Funktions-ID:	11
Anfrage:	frame_size – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0
Antwort:	keine Antwort

Konfiguriert den CALLBACK_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 CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.4 (Plugin).

BrickletRS232.get_frame_readable_callback_configuration¶

Funktions-ID:	12
Anfrage:	keine Nutzdaten
Antwort:	frame_size – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels set_frame_readable_callback_configuration gesetzt.

Neu in Version 2.0.4 (Plugin).

Callbacks¶

BrickletRS232.CALLBACK_READ¶

Funktions-ID:	8
Antwort:	message – Typ: char[60] length – Typ: uint8, 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.

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

BrickletRS232.CALLBACK_FRAME_READABLE¶

Funktions-ID:	13
Antwort:	frame_count – Typ: uint8, Wertebereich: [0 bis 255]

Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit set_frame_readable_callback_configuration konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro read oder 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 read_frame-Funktion gelesen werden können, ohne dass der Frame Count-Rückgabewert geprüft werden muss.

Neu in Version 2.0.4 (Plugin).