Java - Linear Poti Bricklet¶

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

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

    // Change XYZ to the UID of your Linear 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
        BrickletLinearPoti lp = new BrickletLinearPoti(UID, ipcon); // Create device object

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

        // Get current position
        int position = lp.getPosition(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Position: " + position + " %"); // Range: 0 to 100

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

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

    // Change XYZ to the UID of your Linear 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
        BrickletLinearPoti lp = new BrickletLinearPoti(UID, ipcon); // Create device object

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

        // Add position listener
        lp.addPositionListener(new BrickletLinearPoti.PositionListener() {
            public void position(int position) {
                System.out.println("Position: " + position + " %"); // Range: 0 to 100
            }
        });

        // 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!
        lp.setPositionCallbackPeriod(50);

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

Grundfunktionen¶

class BrickletLinearPoti(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	linearPoti – Typ: BrickletLinearPoti

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

BrickletLinearPoti linearPoti = new BrickletLinearPoti("YOUR_DEVICE_UID", ipcon);

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

int BrickletLinearPoti.getPosition()¶

Rückgabe:	position – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100]

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0% (Schieberegler unten) und 100% (Schieberegler oben).

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

Fortgeschrittene Funktionen¶

int BrickletLinearPoti.getAnalogValue()¶

Rückgabe:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

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.

BrickletLinearPoti.Identity BrickletLinearPoti.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 BrickletLinearPoti.setPositionCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode 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.

long BrickletLinearPoti.getPositionCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletLinearPoti.setAnalogValueCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode 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.

long BrickletLinearPoti.getAnalogValueCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletLinearPoti.setPositionCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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)

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

Für option:

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

BrickletLinearPoti.PositionCallbackThreshold BrickletLinearPoti.getPositionCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

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

void BrickletLinearPoti.setAnalogValueCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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)

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

Für option:

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

BrickletLinearPoti.AnalogValueCallbackThreshold BrickletLinearPoti.getAnalogValueCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

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

void BrickletLinearPoti.setDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Listeners

• PositionReachedListener,
• AnalogValueReachedListener

ausgelöst werden, wenn die Schwellwerte

• setPositionCallbackThreshold(),
• setAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

long BrickletLinearPoti.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 BrickletLinearPoti.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 BrickletLinearPoti.PositionListener()¶

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

void position(int position)

Parameter:	position – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100]

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

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

class BrickletLinearPoti.AnalogValueListener()¶

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

void analogValue(int value)

Parameter:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

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

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

class BrickletLinearPoti.PositionReachedListener()¶

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

void positionReached(int position)

Parameter:	position – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100]

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

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

class BrickletLinearPoti.AnalogValueReachedListener()¶

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

void analogValueReached(int value)

Parameter:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

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

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

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

• BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
• BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
• BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletLinearPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11

void BrickletLinearPoti.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:

• BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
• BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
• BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletLinearPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11

void BrickletLinearPoti.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 BrickletLinearPoti.DEVICE_IDENTIFIER¶

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

String BrickletLinearPoti.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Linear Poti Bricklet dar.