Java - Rotary Poti Bricklet

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

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

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

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

        // Get current position
        short position = rp.getPosition(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Position: " + position); // Range: -150 to 150

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

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

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

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

        // Add position listener
        rp.addPositionListener(new BrickletRotaryPoti.PositionListener() {
            public void position(short position) {
                System.out.println("Position: " + position); // Range: -150 to 150
            }
        });

        // Set period for position callback to 0.05s (50ms)
        // Note: The position callback is only called every 0.05 seconds
        //       if the position has changed since the last call!
        rp.setPositionCallbackPeriod(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 BrickletRotaryPoti(String uid, IPConnection ipcon)

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

BrickletRotaryPoti rotaryPoti = new BrickletRotaryPoti("YOUR_DEVICE_UID", ipcon);

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

short BrickletRotaryPoti.getPosition()

Gibt die Position des Drehpotentiometers zurück. Der Wertebereich ist in Grad und ist von -150° (links gedreht) und 150° (rechts gedreht).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den PositionListener Listener zu nutzen und die Periode mit setPositionCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

int BrickletRotaryPoti.getAnalogValue()

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von getPosition() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund getAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den AnalogValueListener Listener zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

short[] BrickletRotaryPoti.getAPIVersion()

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 BrickletRotaryPoti.getResponseExpected(short functionId)

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:

  • BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletRotaryPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletRotaryPoti.setResponseExpected(short functionId, boolean responseExpected)

Ä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:

  • BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletRotaryPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletRotaryPoti.setResponseExpectedAll(boolean responseExpected)

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

BrickletRotaryPoti.Identity BrickletRotaryPoti.getIdentity()

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Listener

void BrickletRotaryPoti.setPositionCallbackPeriod(long period)

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

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

Der Standardwert ist 0.

long BrickletRotaryPoti.getPositionCallbackPeriod()

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

void BrickletRotaryPoti.setAnalogValueCallbackPeriod(long period)

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

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

Der Standardwert ist 0.

long BrickletRotaryPoti.getAnalogValueCallbackPeriod()

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

void BrickletRotaryPoti.setPositionCallbackThreshold(char option, short min, short max)

Setzt den Schwellwert für den PositionReachedListener Listener.

Die folgenden Optionen sind möglich:

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

  • BrickletRotaryPoti.THRESHOLD_OPTION_OFF = 'x'
  • BrickletRotaryPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletRotaryPoti.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletRotaryPoti.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletRotaryPoti.THRESHOLD_OPTION_GREATER = '>'
BrickletRotaryPoti.PositionCallbackThreshold BrickletRotaryPoti.getPositionCallbackThreshold()

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

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

  • BrickletRotaryPoti.THRESHOLD_OPTION_OFF = 'x'
  • BrickletRotaryPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletRotaryPoti.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletRotaryPoti.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletRotaryPoti.THRESHOLD_OPTION_GREATER = '>'

Das zurückgegebene Objekt enthält die Public-Member-Variablen char option, short min und short max.

void BrickletRotaryPoti.setAnalogValueCallbackThreshold(char option, int min, int max)

Setzt den Schwellwert für den AnalogValueReachedListener Listener.

Die folgenden Optionen sind möglich:

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

  • BrickletRotaryPoti.THRESHOLD_OPTION_OFF = 'x'
  • BrickletRotaryPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletRotaryPoti.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletRotaryPoti.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletRotaryPoti.THRESHOLD_OPTION_GREATER = '>'
BrickletRotaryPoti.AnalogValueCallbackThreshold BrickletRotaryPoti.getAnalogValueCallbackThreshold()

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

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

  • BrickletRotaryPoti.THRESHOLD_OPTION_OFF = 'x'
  • BrickletRotaryPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletRotaryPoti.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletRotaryPoti.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletRotaryPoti.THRESHOLD_OPTION_GREATER = '>'

Das zurückgegebene Objekt enthält die Public-Member-Variablen char option, int min und int max.

void BrickletRotaryPoti.setDebouncePeriod(long debounce)

Setzt die Periode in ms mit welcher die Schwellwert Listeners

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

long BrickletRotaryPoti.getDebouncePeriod()

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 BrickletRotaryPoti.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 BrickletRotaryPoti.PositionListener()

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

void position(short position)

Dieser Listener wird mit der Periode, wie gesetzt mit setPositionCallbackPeriod(), ausgelöst. Der Parameter ist die Position des Drehpotentiometers.

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

class BrickletRotaryPoti.AnalogValueListener()

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

void analogValue(int value)

Dieser Listener wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Drehpotentiometers.

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

class BrickletRotaryPoti.PositionReachedListener()

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

void positionReached(short position)

Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von setPositionCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Position des Drehpotentiometers.

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

class BrickletRotaryPoti.AnalogValueReachedListener()

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

void analogValueReached(int value)

Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von setAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Drehpotentiometers.

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

Konstanten

static final int BrickletRotaryPoti.DEVICE_IDENTIFIER

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

static final String BrickletRotaryPoti.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Rotary Poti Bricklet dar.