Java - Line Bricklet

Dies ist die Beschreibung der Java API Bindings für das Line Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Line Bricklet 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).

Simple

Download (ExampleSimple.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLine;

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

    // Change XYZ to the UID of your Line Bricklet
    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
        BrickletLine l = new BrickletLine(UID, ipcon); // Create device object

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

        // Get current reflectivity
        int reflectivity = l.getReflectivity(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Reflectivity: " + reflectivity);

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

Callback

Download (ExampleCallback.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLine;

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

    // Change XYZ to the UID of your Line Bricklet
    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
        BrickletLine l = new BrickletLine(UID, ipcon); // Create device object

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

        // Add reflectivity listener
        l.addReflectivityListener(new BrickletLine.ReflectivityListener() {
            public void reflectivity(int reflectivity) {
                System.out.println("Reflectivity: " + reflectivity);
            }
        });

        // Set period for reflectivity callback to 1s (1000ms)
        // Note: The reflectivity callback is only called every second
        //       if the reflectivity has changed since the last call!
        l.setReflectivityCallbackPeriod(1000);

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

Threshold

Download (ExampleThreshold.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLine;

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

    // Change XYZ to the UID of your Line Bricklet
    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
        BrickletLine l = new BrickletLine(UID, ipcon); // Create device object

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

        // Get threshold callbacks with a debounce time of 1 second (1000ms)
        l.setDebouncePeriod(1000);

        // Add reflectivity reached listener
        l.addReflectivityReachedListener(new BrickletLine.ReflectivityReachedListener() {
            public void reflectivityReached(int reflectivity) {
                System.out.println("Reflectivity: " + reflectivity);
            }
        });

        // Configure threshold for reflectivity "greater than 2000"
        l.setReflectivityCallbackThreshold('>', 2000, 0);

        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 BrickletLine(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • line – Typ: BrickletLine

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

BrickletLine line = new BrickletLine("YOUR_DEVICE_UID", ipcon);

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

int BrickletLine.getReflectivity()
Rückgabe:
  • reflectivity – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die aktuell gemessene Reflektivität zurück. Die Reflektivität ist ein Wert zwischen 0 (nicht reflektiv) und 4095 (sehr reflektiv).

Normalerweise hat schwarz eine geringe Reflektivität während weiß eine hohe Reflektivität hat.

Wenn die Reflektivität periodisch abgefragt werden soll, wird empfohlen den ReflectivityListener Listener zu nutzen und die Periode mit setReflectivityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

short[] BrickletLine.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: short[], 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 BrickletLine.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletLine.FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
  • BrickletLine.FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
  • BrickletLine.FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletLine.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletLine.FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
  • BrickletLine.FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
  • BrickletLine.FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletLine.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.

BrickletLine.Identity BrickletLine.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], 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 BrickletLine.setReflectivityCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ReflectivityListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

Der ReflectivityListener Listener wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

long BrickletLine.getReflectivityCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setReflectivityCallbackPeriod() gesetzt.

void BrickletLine.setReflectivityCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt den Schwellwert für den ReflectivityReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst, wenn die Reflektivität außerhalb des min und max Wertes ist
'i' Listener wird ausgelöst, wenn die Reflektivität innerhalb des min und max Wertes ist
'<' Listener wird ausgelöst, wenn die Reflektivität kleiner als der min Wert ist (max wird ignoriert)
'>' Listener wird ausgelöst, wenn die Reflektivität größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

Für option:

  • BrickletLine.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLine.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLine.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLine.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLine.THRESHOLD_OPTION_GREATER = '>'
BrickletLine.ReflectivityCallbackThreshold BrickletLine.getReflectivityCallbackThreshold()
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt den Schwellwert zurück, wie von setReflectivityCallbackThreshold() gesetzt.

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

Für option:

  • BrickletLine.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLine.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLine.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLine.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLine.THRESHOLD_OPTION_GREATER = '>'
void BrickletLine.setDebouncePeriod(long debounce)
Parameter:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Listener

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

long BrickletLine.getDebouncePeriod()
Rückgabe:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

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 BrickletLine.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 BrickletLine.ReflectivityListener()

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

void reflectivity(int reflectivity)
Parameter:
  • reflectivity – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Listener wird mit der Periode, wie gesetzt mit setReflectivityCallbackPeriod(), ausgelöst. Der Parameter ist die Reflektivität des Sensors.

Der ReflectivityListener Listener wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

class BrickletLine.ReflectivityReachedListener()

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

void reflectivityReached(int reflectivity)
Parameter:
  • reflectivity – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von setReflectivityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Reflektivität des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Konstanten

int BrickletLine.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Line 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 BrickletLine.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Line Bricklet dar.