Java - RS232 Bricklet¶

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
41
42
43
44
45
46
47
48
49
50
51

import java.util.Arrays;
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRS232;

// For this example connect the RX1 and TX pin to receive the send message

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

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

    // Convert string to array of length 60 as needed by write
    public static char[] stringToCharArray(String message) {
        return Arrays.copyOf(message.toCharArray(), 60);
    }

    // Assume that the message consists of ASCII characters and
    // convert it from an array of chars to a string
    public static String charArrayToString(char[] message, short length) {
        return new String(message, 0, length);
    }

    // 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
        BrickletRS232 rs232 = new BrickletRS232(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 BrickletRS232.ReadListener() {
            public void read(char[] message, short length) {
                String str = charArrayToString(message, length);
                System.out.println("Message (Length: " + length + "): \"" + str + "\"");
            }
        });

        // Enable read callback
        rs232.enableReadCallback();

        // Write "test" string
        rs232.write(stringToCharArray("test"), (short)4);

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

Grundfunktionen¶

class BrickletRS232(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	rs232 – Typ: BrickletRS232

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

BrickletRS232 rs232 = new BrickletRS232("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

short BrickletRS232.write(char[] message, short length)¶

Parameter:	message – Typ: char[], Länge: 60 length – Typ: short, Wertebereich: [0 bis 60]
Rückgabe:	written – Typ: short, 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 setConfiguration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

BrickletRS232.Read BrickletRS232.read()¶

Rückgabeobjekt:	message – Typ: char[], Länge: 60 length – Typ: short, 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 enableReadCallback() und ReadListener Listener.

void BrickletRS232.setConfiguration(short baudrate, short parity, short stopbits, short wordlength, short hardwareFlowcontrol, short softwareFlowcontrol)¶

Parameter:

baudrate – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 11 parity – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 8 hardwareFlowcontrol – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0 softwareFlowcontrol – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

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

Für baudrate:

• BrickletRS232.BAUDRATE_300 = 0
• BrickletRS232.BAUDRATE_600 = 1
• BrickletRS232.BAUDRATE_1200 = 2
• BrickletRS232.BAUDRATE_2400 = 3
• BrickletRS232.BAUDRATE_4800 = 4
• BrickletRS232.BAUDRATE_9600 = 5
• BrickletRS232.BAUDRATE_14400 = 6
• BrickletRS232.BAUDRATE_19200 = 7
• BrickletRS232.BAUDRATE_28800 = 8
• BrickletRS232.BAUDRATE_38400 = 9
• BrickletRS232.BAUDRATE_57600 = 10
• BrickletRS232.BAUDRATE_115200 = 11
• BrickletRS232.BAUDRATE_230400 = 12

Für parity:

• BrickletRS232.PARITY_NONE = 0
• BrickletRS232.PARITY_ODD = 1
• BrickletRS232.PARITY_EVEN = 2
• BrickletRS232.PARITY_FORCED_PARITY_1 = 3
• BrickletRS232.PARITY_FORCED_PARITY_0 = 4

Für stopbits:

• BrickletRS232.STOPBITS_1 = 1
• BrickletRS232.STOPBITS_2 = 2

Für wordlength:

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

Für hardwareFlowcontrol:

• BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
• BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1

Für softwareFlowcontrol:

• BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
• BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1

BrickletRS232.Configuration BrickletRS232.getConfiguration()¶

Rückgabeobjekt:

baudrate – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 11 parity – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 8 hardwareFlowcontrol – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0 softwareFlowcontrol – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für baudrate:

• BrickletRS232.BAUDRATE_300 = 0
• BrickletRS232.BAUDRATE_600 = 1
• BrickletRS232.BAUDRATE_1200 = 2
• BrickletRS232.BAUDRATE_2400 = 3
• BrickletRS232.BAUDRATE_4800 = 4
• BrickletRS232.BAUDRATE_9600 = 5
• BrickletRS232.BAUDRATE_14400 = 6
• BrickletRS232.BAUDRATE_19200 = 7
• BrickletRS232.BAUDRATE_28800 = 8
• BrickletRS232.BAUDRATE_38400 = 9
• BrickletRS232.BAUDRATE_57600 = 10
• BrickletRS232.BAUDRATE_115200 = 11
• BrickletRS232.BAUDRATE_230400 = 12

Für parity:

• BrickletRS232.PARITY_NONE = 0
• BrickletRS232.PARITY_ODD = 1
• BrickletRS232.PARITY_EVEN = 2
• BrickletRS232.PARITY_FORCED_PARITY_1 = 3
• BrickletRS232.PARITY_FORCED_PARITY_0 = 4

Für stopbits:

• BrickletRS232.STOPBITS_1 = 1
• BrickletRS232.STOPBITS_2 = 2

Für wordlength:

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

Für hardwareFlowcontrol:

• BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
• BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1

Für softwareFlowcontrol:

• BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
• BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1

void BrickletRS232.setBreakCondition(int breakTime)¶

Parameter:	breakTime – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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.ReadFrame BrickletRS232.readFrame()¶

Rückgabeobjekt:	message – Typ: char[], Länge: 60 length – Typ: short, Wertebereich: [0 bis 60]

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

Rückgabeobjekt:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, 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 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Listener¶

void BrickletRS232.enableReadCallback()¶

Aktiviert den ReadListener Listener. Dies deaktiviert den FrameReadableListener Listener.

Im Startzustand ist der Listener deaktiviert

void BrickletRS232.disableReadCallback()¶

Deaktiviert den ReadListener Listener.

Im Startzustand ist der Listener deaktiviert

boolean BrickletRS232.isReadCallbackEnabled()¶

Rückgabe:	enabled – Typ: boolean, Standardwert: false

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

void BrickletRS232.setFrameReadableCallbackConfiguration(short frameSize)¶

Parameter:	frameSize – Typ: short, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0

Konfiguriert den FrameReadableListener Listener. Die Frame Size ist die Anzahl an Bytes, die lesbar sein müssen, damit der Listener auslöst. Eine Frame Size von 0 deaktiviert den Listener. Eine Frame Size größer als 0 aktiviert diesen und deaktiviert den ReadListener Listener.

Im Startzustand ist der Listener deaktiviert.

Neu in Version 2.0.4 (Plugin).

short BrickletRS232.getFrameReadableCallbackConfiguration()¶

Rückgabe:	frameSize – Typ: short, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0

Gibt die Listener-Konfiguration zurück, wie mittels setFrameReadableCallbackConfiguration() gesetzt.

Neu in Version 2.0.4 (Plugin).

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

class BrickletRS232.ReadListener()¶

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

void read(char[] message, short length)

Parameter:	message – Typ: char[], Länge: 60 length – Typ: short, Wertebereich: [1 bis 60]

Dieser Listener 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 Listener kann durch enableReadCallback() aktiviert werden.

class BrickletRS232.ErrorListener()¶

Dieser Listener kann mit der Funktion addErrorListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeErrorListener() wieder entfernt werden.

void error(short error)

Parameter:	error – Typ: short, Wertebereich: Siehe Konstanten

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

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

Für error:

• BrickletRS232.ERROR_OVERRUN = 1
• BrickletRS232.ERROR_PARITY = 2
• BrickletRS232.ERROR_FRAMING = 4

Neu in Version 2.0.1 (Plugin).

class BrickletRS232.FrameReadableListener()¶

Dieser Listener kann mit der Funktion addFrameReadableListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeFrameReadableListener() wieder entfernt werden.

void frameReadable(short frameCount)

Parameter:	frameCount – Typ: short, Wertebereich: [0 bis 255]

Dieser Listener wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit setFrameReadableCallbackConfiguration() konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Listener wird nur einmal pro read() oder readFrame() Aufruf ausgelöst. Das heißt, dass wenn eine Framegröße von X Bytes konfiguriert wird, jedes Mal wenn das Listener ausgelöst wird, X Bytes mit der readFrame()-Funktion gelesen werden können, ohne dass der Frame Count-Parameter geprüft werden muss.

Neu in Version 2.0.4 (Plugin).

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

short[] BrickletRS232.getAPIVersion()¶

Rückgabeobjekt:	apiVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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 BrickletRS232.getResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, 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:

• BrickletRS232.FUNCTION_ENABLE_READ_CALLBACK = 3
• BrickletRS232.FUNCTION_DISABLE_READ_CALLBACK = 4
• BrickletRS232.FUNCTION_SET_CONFIGURATION = 6
• BrickletRS232.FUNCTION_SET_BREAK_CONDITION = 10
• BrickletRS232.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

void BrickletRS232.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameter:	functionId – Typ: byte, 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:

• BrickletRS232.FUNCTION_ENABLE_READ_CALLBACK = 3
• BrickletRS232.FUNCTION_DISABLE_READ_CALLBACK = 4
• BrickletRS232.FUNCTION_SET_CONFIGURATION = 6
• BrickletRS232.FUNCTION_SET_BREAK_CONDITION = 10
• BrickletRS232.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

void BrickletRS232.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.

Konstanten¶

int BrickletRS232.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein RS232 Bricklet 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 BrickletRS232.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.