TCP/IP - RS232 Bricklet 2.0¶

Grundfunktionen¶

BrickletRS232V2.write_low_level¶

Funktions-ID:	1
Anfrage:	message_length – Typ: uint16, Wertebereich: [0 bis 216 - 1] message_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1] message_chunk_data – Typ: char[60]
Antwort:	message_chunk_written – Typ: uint8, Wertebereich: [0 bis 255]

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.

BrickletRS232V2.read_low_level¶

Funktions-ID:	2
Anfrage:	length – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:	message_length – Typ: uint16, Wertebereich: [0 bis 216 - 1] message_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1] message_chunk_data – Typ: char[60]

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

BrickletRS232V2.set_configuration¶

Funktions-ID:	6
Anfrage:	baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 stopbits – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 wordlength – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 8 flowcontrol – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:	keine Antwort

Setzt die Konfiguration für die RS232-Kommunikation.

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

Für parity:

• 0 = None
• 1 = Odd
• 2 = Even

Für stopbits:

• 1 = 1
• 2 = 2

Für wordlength:

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

Für flowcontrol:

• 0 = Off
• 1 = Software
• 2 = Hardware

BrickletRS232V2.get_configuration¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 stopbits – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 wordlength – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 8 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 parity:

• 0 = None
• 1 = Odd
• 2 = Even

Für stopbits:

• 1 = 1
• 2 = 2

Für wordlength:

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

Für flowcontrol:

• 0 = Off
• 1 = Software
• 2 = Hardware

Fortgeschrittene Funktionen¶

BrickletRS232V2.set_buffer_config¶

Funktions-ID:	8
Anfrage:	send_buffer_size – Typ: uint16, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120 receive_buffer_size – Typ: uint16, Einheit: 1 B, Wertebereich: [210 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 write_low_level übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS232 empfangen wurden aber noch nicht über read_low_level oder CALLBACK_READ_LOW_LEVEL Callback an ein Nutzerprogramm übertragen werden konnten.

BrickletRS232V2.get_buffer_config¶

Funktions-ID:	9
Anfrage:	keine Nutzdaten
Antwort:	send_buffer_size – Typ: uint16, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120 receive_buffer_size – Typ: uint16, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120

Gibt die Buffer-Konfiguration zurück, wie von set_buffer_config gesetzt.

BrickletRS232V2.get_buffer_status¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	send_buffer_used – Typ: uint16, Einheit: 1 B, Wertebereich: [0 bis 9216] receive_buffer_used – Typ: uint16, Einheit: 1 B, Wertebereich: [0 bis 9216]

Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.

Siehe set_buffer_config zur Konfiguration der Buffergrößen.

BrickletRS232V2.get_error_count¶

Funktions-ID:	11
Anfrage:	keine Nutzdaten
Antwort:	error_count_overrun – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_parity – Typ: uint32, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.

BrickletRS232V2.get_spitfp_error_count¶

Funktions-ID:	234
Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: uint32, 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.

BrickletRS232V2.set_status_led_config¶

Funktions-ID:	239
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletRS232V2.get_status_led_config¶

Funktions-ID:	240
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

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

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

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletRS232V2.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, 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.

BrickletRS232V2.reset¶

Funktions-ID:	243
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.

BrickletRS232V2.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¶

BrickletRS232V2.enable_read_callback¶

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

Aktiviert den CALLBACK_READ_LOW_LEVEL Callback. Dies deaktiviert den CALLBACK_FRAME_READABLE Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS232V2.disable_read_callback¶

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

Deaktiviert den CALLBACK_READ_LOW_LEVEL Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS232V2.is_read_callback_enabled¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

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

BrickletRS232V2.set_frame_readable_callback_configuration¶

Funktions-ID:	14
Anfrage:	frame_size – Typ: uint16, Einheit: 1 B, Wertebereich: [0 bis 9216], 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_LOW_LEVEL Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.3 (Plugin).

BrickletRS232V2.get_frame_readable_callback_configuration¶

Funktions-ID:	15
Anfrage:	keine Nutzdaten
Antwort:	frame_size – Typ: uint16, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0

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

Neu in Version 2.0.3 (Plugin).

Callbacks¶

BrickletRS232V2.CALLBACK_READ_LOW_LEVEL¶

Funktions-ID:	12
Antwort:	message_length – Typ: uint16, Wertebereich: [0 bis 216 - 1] message_chunk_offset – Typ: uint16, Wertebereich: [0 bis 216 - 1] message_chunk_data – Typ: char[60]

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

Dieser Callback kann durch enable_read_callback aktiviert werden.

BrickletRS232V2.CALLBACK_ERROR_COUNT¶

Funktions-ID:	13
Antwort:	error_count_overrun – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_parity – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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

BrickletRS232V2.CALLBACK_FRAME_READABLE¶

Funktions-ID:	16
Antwort:	frame_count – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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_low_level 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_low_level-Funktion gelesen werden können, ohne dass der Frame Count-Rückgabewert geprüft werden muss.

Neu in Version 2.0.3 (Plugin).

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletRS232V2.set_bootloader_mode¶

Funktions-ID:	235
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

Für status:

• 0 = OK
• 1 = Invalid Mode
• 2 = No Change
• 3 = Entry Function Not Present
• 4 = Device Identifier Incorrect
• 5 = CRC Mismatch

BrickletRS232V2.get_bootloader_mode¶

Funktions-ID:	236
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

Für mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

BrickletRS232V2.set_write_firmware_pointer¶

Funktions-ID:	237
Anfrage:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

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.

BrickletRS232V2.write_firmware¶

Funktions-ID:	238
Anfrage:	data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: [0 bis 255]

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.

BrickletRS232V2.write_uid¶

Funktions-ID:	248
Anfrage:	uid – Typ: uint32, 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.

BrickletRS232V2.read_uid¶

Funktions-ID:	249
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: uint32, 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.