Java - Rotary Encoder Bricklet

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

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

    // Change XYZ to the UID of your Rotary Encoder 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
        BrickletRotaryEncoder re = new BrickletRotaryEncoder(UID, ipcon); // Create device object

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

        // Get current count without reset
        int count = re.getCount(false); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Count: " + count);

        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.BrickletRotaryEncoder;

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

    // Change XYZ to the UID of your Rotary Encoder 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
        BrickletRotaryEncoder re = new BrickletRotaryEncoder(UID, ipcon); // Create device object

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

        // Add count listener
        re.addCountListener(new BrickletRotaryEncoder.CountListener() {
            public void count(int count) {
                System.out.println("Count: " + count);
            }
        });

        // Set period for count callback to 0.05s (50ms)
        // Note: The count callback is only called every 0.05 seconds
        //       if the count has changed since the last call!
        re.setCountCallbackPeriod(50);

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

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

BrickletRotaryEncoder rotaryEncoder = new BrickletRotaryEncoder("YOUR_DEVICE_UID", ipcon);

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

int BrickletRotaryEncoder.getCount(boolean reset)
Parameter:
  • reset – Typ: boolean
Rückgabe:
  • count – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt den aktuellen Zählerwert des Encoders zurück. Wenn reset auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurück gesetzt.

Der Encoder hat 24 Schritte pro Umdrehung.

Wenn der Encoder nach links gedreht wird wird der Zählerwert dekrementiert, d.h. negative Zählerwerte sind möglich.

boolean BrickletRotaryEncoder.isPressed()
Rückgabe:
  • pressed – Typ: boolean

Gibt true zurück wenn der Taster gedrückt ist und sonst false.

Es wird empfohlen die PressedListener und ReleasedListener Listeners zu nutzen, um den Taster programmatisch zu behandeln.

Fortgeschrittene Funktionen

short[] BrickletRotaryEncoder.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 BrickletRotaryEncoder.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:

  • BrickletRotaryEncoder.FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
  • BrickletRotaryEncoder.FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
  • BrickletRotaryEncoder.FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletRotaryEncoder.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:

  • BrickletRotaryEncoder.FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
  • BrickletRotaryEncoder.FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
  • BrickletRotaryEncoder.FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletRotaryEncoder.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.

BrickletRotaryEncoder.Identity BrickletRotaryEncoder.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 BrickletRotaryEncoder.setCountCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Der CountListener Listener wird nur ausgelöst, wenn sich der Zählerwert seit der letzten Auslösung geändert hat.

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

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

void BrickletRotaryEncoder.setCountCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: int, Wertebereich: [-231 bis 231 - 1]

Setzt den Schwellwert für den CountReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst, wenn der Zählerwert außerhalb der min und max Werte ist
'i' Listener wird ausgelöst, wenn die Zählerwert innerhalb der min und max Werte ist
'<' Listener wird ausgelöst, wenn die Zählerwert kleiner als der min Wert ist (max wird ignoriert)
'>' Listener wird ausgelöst, wenn die Zählerwert 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:

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

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

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

Für option:

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

Setzt die Periode mit welcher der Schwellwert-Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

long BrickletRotaryEncoder.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 BrickletRotaryEncoder.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 BrickletRotaryEncoder.CountListener()

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

void count(int count)
Parameter:
  • count – Typ: int, Wertebereich: [-231 bis 231 - 1]

Dieser Listener wird mit der Periode, wie gesetzt mit setCountCallbackPeriod(), ausgelöst. Der Parameter ist der Zählerwert des Encoders.

Der CountListener Listener wird nur ausgelöst, wenn sich der Zähler seit der letzten Auslösung geändert hat.

class BrickletRotaryEncoder.CountReachedListener()

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

void countReached(int count)
Parameter:
  • count – Typ: int, Wertebereich: [-231 bis 231 - 1]

Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von setCountCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Zählerwert des Encoders.

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

class BrickletRotaryEncoder.PressedListener()

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

void pressed()

Dieser Listener wird ausgelöst, wenn der Taster gedrückt wird.

class BrickletRotaryEncoder.ReleasedListener()

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

void released()

Dieser Listener wird ausgelöst, wenn der Taster losgelassen wird.

Konstanten

int BrickletRotaryEncoder.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Rotary Encoder 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 BrickletRotaryEncoder.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Rotary Encoder Bricklet dar.