Java - RS232 Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (ExampleLoopback.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRS232V2;

// For this example connect the RX pin to the TX pin on the same Bricklet

public class ExampleLoopback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your RS232 Bricklet 2.0
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRS232V2 rs232 = new BrickletRS232V2(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Add read listener
        rs232.addReadListener(new BrickletRS232V2.ReadListener() {
            public void read(char[] message) {
                // Assume that the message consists of ASCII characters and
                // convert it from an array of chars to a string
                System.out.println("Message: \"" + new String(message) + "\"");
            }
        });

        // Enable read callback
        rs232.enableReadCallback();

        // Write "test" string
        rs232.write("test".toCharArray());

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API

Prinzipiell kann jede Methode der Java Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletRS232V2(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • rs232V2 – Typ: BrickletRS232V2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

BrickletRS232V2 rs232V2 = new BrickletRS232V2("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

int BrickletRS232V2.write(char[] message)
Parameter:
  • message – Typ: char[], Länge: variabel
Rückgabe:
  • messageWritten – 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 setConfiguration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

char[] BrickletRS232V2.read(int length)
Parameter:
  • length – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • 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-Listener nicht aktiv ist. Siehe enableReadCallback() und ReadListener Listener.

void BrickletRS232V2.setConfiguration(long baudrate, int parity, int stopbits, int wordlength, int flowcontrol)
Parameter:
  • baudrate – Typ: long, Wertebereich: [0 bis 232 - 1]
  • parity – Typ: int, Wertebereich: Siehe Konstanten
  • stopbits – Typ: int, Wertebereich: Siehe Konstanten
  • wordlength – Typ: int, Wertebereich: Siehe Konstanten
  • flowcontrol – Typ: int, Wertebereich: Siehe Konstanten

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

  • Baudrate zwischen 100 und 2000000 Baud.
  • Parität von None, Odd und Even.
  • Stopp-Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Flow Control kann aus, Software oder Hardware sein.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8.

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

Für parity:

  • BrickletRS232V2.PARITY_NONE = 0
  • BrickletRS232V2.PARITY_ODD = 1
  • BrickletRS232V2.PARITY_EVEN = 2

Für stopbits:

  • BrickletRS232V2.STOPBITS_1 = 1
  • BrickletRS232V2.STOPBITS_2 = 2

Für wordlength:

  • BrickletRS232V2.WORDLENGTH_5 = 5
  • BrickletRS232V2.WORDLENGTH_6 = 6
  • BrickletRS232V2.WORDLENGTH_7 = 7
  • BrickletRS232V2.WORDLENGTH_8 = 8

Für flowcontrol:

  • BrickletRS232V2.FLOWCONTROL_OFF = 0
  • BrickletRS232V2.FLOWCONTROL_SOFTWARE = 1
  • BrickletRS232V2.FLOWCONTROL_HARDWARE = 2
BrickletRS232V2.Configuration BrickletRS232V2.getConfiguration()
Rückgabeobjekt:
  • baudrate – Typ: long, Wertebereich: [0 bis 232 - 1]
  • parity – Typ: int, Wertebereich: Siehe Konstanten
  • stopbits – Typ: int, Wertebereich: Siehe Konstanten
  • wordlength – Typ: int, Wertebereich: Siehe Konstanten
  • flowcontrol – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von setConfiguration() gesetzt.

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

Für parity:

  • BrickletRS232V2.PARITY_NONE = 0
  • BrickletRS232V2.PARITY_ODD = 1
  • BrickletRS232V2.PARITY_EVEN = 2

Für stopbits:

  • BrickletRS232V2.STOPBITS_1 = 1
  • BrickletRS232V2.STOPBITS_2 = 2

Für wordlength:

  • BrickletRS232V2.WORDLENGTH_5 = 5
  • BrickletRS232V2.WORDLENGTH_6 = 6
  • BrickletRS232V2.WORDLENGTH_7 = 7
  • BrickletRS232V2.WORDLENGTH_8 = 8

Für flowcontrol:

  • BrickletRS232V2.FLOWCONTROL_OFF = 0
  • BrickletRS232V2.FLOWCONTROL_SOFTWARE = 1
  • BrickletRS232V2.FLOWCONTROL_HARDWARE = 2

Fortgeschrittene Funktionen

void BrickletRS232V2.setBufferConfig(int sendBufferSize, int receiveBufferSize)
Parameter:
  • sendBufferSize – Typ: int, Wertebereich: [0 bis 216 - 1]
  • receiveBufferSize – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10kb) haben, die Minimalgröße ist 1024 Byte (1kb) für beide.

Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.

Der Sendebuffer hält die Daten welche über write() übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS232 empfangen wurden aber noch nicht über read() oder ReadListener Listener an ein Nutzerprogramm übertragen werden konnten.

Die Standardkonfiguration ist 5120 Byte (5kb) pro Buffer.

BrickletRS232V2.BufferConfig BrickletRS232V2.getBufferConfig()
Rückgabeobjekt:
  • sendBufferSize – Typ: int, Wertebereich: [0 bis 216 - 1]
  • receiveBufferSize – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Buffer-Konfiguration zurück, wie von setBufferConfig() gesetzt.

BrickletRS232V2.BufferStatus BrickletRS232V2.getBufferStatus()
Rückgabeobjekt:
  • sendBufferUsed – Typ: int, Wertebereich: [0 bis 216 - 1]
  • receiveBufferUsed – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Siehe setBufferConfig() zur Konfiguration der Buffergrößen.

BrickletRS232V2.ErrorCount BrickletRS232V2.getErrorCount()
Rückgabeobjekt:
  • errorCountOverrun – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountParity – Typ: long, Wertebereich: [0 bis 232 - 1]

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

int[] BrickletRS232V2.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

boolean BrickletRS232V2.getResponseExpected(int functionId)
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Listeners ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

  • BrickletRS232V2.FUNCTION_ENABLE_READ_CALLBACK = 3
  • BrickletRS232V2.FUNCTION_DISABLE_READ_CALLBACK = 4
  • BrickletRS232V2.FUNCTION_SET_CONFIGURATION = 6
  • BrickletRS232V2.FUNCTION_SET_BUFFER_CONFIG = 8
  • BrickletRS232V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRS232V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRS232V2.FUNCTION_RESET = 243
  • BrickletRS232V2.FUNCTION_WRITE_UID = 248
void BrickletRS232V2.setResponseExpected(int functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Listeners (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

  • BrickletRS232V2.FUNCTION_ENABLE_READ_CALLBACK = 3
  • BrickletRS232V2.FUNCTION_DISABLE_READ_CALLBACK = 4
  • BrickletRS232V2.FUNCTION_SET_CONFIGURATION = 6
  • BrickletRS232V2.FUNCTION_SET_BUFFER_CONFIG = 8
  • BrickletRS232V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRS232V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRS232V2.FUNCTION_RESET = 243
  • BrickletRS232V2.FUNCTION_WRITE_UID = 248
void BrickletRS232V2.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.

BrickletRS232V2.SPITFPErrorCount BrickletRS232V2.getSPITFPErrorCount()
Rückgabeobjekt:
  • errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: long, 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.

int BrickletRS232V2.setBootloaderMode(int mode)
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

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 Bootlodaer- 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 Konstanten sind für diese Funktion verfügbar:

Für mode:

  • BrickletRS232V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRS232V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletRS232V2.BOOTLOADER_STATUS_OK = 0
  • BrickletRS232V2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletRS232V2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletRS232V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletRS232V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletRS232V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletRS232V2.getBootloaderMode()
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für mode:

  • BrickletRS232V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRS232V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletRS232V2.setWriteFirmwarePointer(long pointer)
Parameter:
  • pointer – Typ: long, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). 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.

int BrickletRS232V2.writeFirmware(int[] data)
Parameter:
  • data – Typ: int[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() 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.

void BrickletRS232V2.setStatusLEDConfig(int config)
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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 Konstanten sind für diese Funktion verfügbar:

Für config:

  • BrickletRS232V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletRS232V2.STATUS_LED_CONFIG_ON = 1
  • BrickletRS232V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRS232V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletRS232V2.getStatusLEDConfig()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

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

Für config:

  • BrickletRS232V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletRS232V2.STATUS_LED_CONFIG_ON = 1
  • BrickletRS232V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRS232V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletRS232V2.getChipTemperature()
Rückgabe:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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.

void BrickletRS232V2.reset()

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.

void BrickletRS232V2.writeUID(long uid)
Parameter:
  • uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

long BrickletRS232V2.readUID()
Rückgabe:
  • uid – Typ: long, 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.

BrickletRS232V2.Identity BrickletRS232V2.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Listener

void BrickletRS232V2.enableReadCallback()

Aktiviert den ReadListener Listener.

Im Startzustand ist der Listener deaktiviert.

void BrickletRS232V2.disableReadCallback()

Deaktiviert den ReadListener Listener.

Im Startzustand ist der Listener deaktiviert.

boolean BrickletRS232V2.isReadCallbackEnabled()
Rückgabe:
  • enabled – Typ: boolean

Gibt true zurück falls ReadListener Listener aktiviert ist, false sonst.

Listener

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

device.addExampleListener(new BrickletRS232V2.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden remove*Listener() wieder zu entfernen.

Bemerkung

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

class BrickletRS232V2.ReadListener()

Dieser Listener kann mit der Funktion addReadListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeReadListener() wieder entfernt werden.

void read(char[] message)
Parameter:
  • message – Typ: char[], Länge: variabel

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

Dieser Listener kann durch enableReadCallback() aktiviert werden.

Bemerkung

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

class BrickletRS232V2.ErrorCountListener()

Dieser Listener kann mit der Funktion addErrorCountListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeErrorCountListener() wieder entfernt werden.

void errorCount(long errorCountOverrun, long errorCountParity)
Parameter:
  • errorCountOverrun – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountParity – Typ: long, Wertebereich: [0 bis 232 - 1]

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

Konstanten

int BrickletRS232V2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS232 Bricklet 2.0 zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateListener Listener der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletRS232V2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet 2.0 dar.