Dies ist die Beschreibung der Java API Bindings für das Distance IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance IR Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Java API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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.BrickletDistanceIR;
public class ExampleSimple {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Distance IR 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
BrickletDistanceIR dir = new BrickletDistanceIR(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current distance
int distance = dir.getDistance(); // Can throw com.tinkerforge.TimeoutException
System.out.println("Distance: " + distance/10.0 + " cm");
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
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.BrickletDistanceIR;
public class ExampleCallback {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Distance IR 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
BrickletDistanceIR dir = new BrickletDistanceIR(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Add distance listener
dir.addDistanceListener(new BrickletDistanceIR.DistanceListener() {
public void distance(int distance) {
System.out.println("Distance: " + distance/10.0 + " cm");
}
});
// Set period for distance callback to 0.2s (200ms)
// Note: The distance callback is only called every 0.2 seconds
// if the distance has changed since the last call!
dir.setDistanceCallbackPeriod(200);
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
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.BrickletDistanceIR;
public class ExampleThreshold {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Distance IR 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
BrickletDistanceIR dir = new BrickletDistanceIR(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 10 seconds (10000ms)
dir.setDebouncePeriod(10000);
// Add distance reached listener
dir.addDistanceReachedListener(new BrickletDistanceIR.DistanceReachedListener() {
public void distanceReached(int distance) {
System.out.println("Distance: " + distance/10.0 + " cm");
}
});
// Configure threshold for distance "smaller than 30 cm"
dir.setDistanceCallbackThreshold('<', 30*10, 0);
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
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.
BrickletDistanceIR
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletDistanceIR distanceIR = new BrickletDistanceIR("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletDistanceIR.
getDistance
()¶Rückgabe: |
|
---|
Gibt die gemessene Entfernung des Sensors zurück. Die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.
Wenn die Entfernung periodisch abgefragt werden soll, wird empfohlen
den DistanceListener
Listener zu nutzen und die Periode mit
setDistanceCallbackPeriod()
vorzugeben.
BrickletDistanceIR.
getAnalogValue
()¶Rückgabe: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von getDistance()
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.
BrickletDistanceIR.
setSamplingPoint
(short position, int distance)¶Parameter: |
|
---|
Setzt einen Messpunkt für eine vorgegebene Position in der Wertetabelle. Die Wertetabelle beinhaltet 128 äquidistante Analogwerte mit entsprechenden Entfernungen.
Wenn eine Entfernung von 50cm bei einem Analogwert von 2048 gemessen wird, dann sollte der Aufruf der Funktion mit (64, 5000) erfolgen. Der verwendete Analog-Digital-Wandler hat eine Auflösung von 12 Bit. Mit 128 Messpunkten im gesamten Bereich bedeutet das, dass jeder Messpunkt 32 Analogwerte umfasst. Daher wird dem Analogwert 2048 der Messpunkt 64 = 2048/32 zugeordnet.
Messpunkte werden im EEPROM des Distance IR Bricklet gespeichert und werden bei jedem Hochfahren geladen.
Bemerkung
Ein einfacher Weg, die Messpunkte des Distance IR Bricklet zu kalibrieren, ist im Brick Viewer implementiert. Wenn der Bricklet kalibriert werden soll wird dringend empfohlen diese Implementierung zu nutzen.
BrickletDistanceIR.
getSamplingPoint
(short position)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Entfernung eines Messpunktes zurück, wie von setSamplingPoint()
gesetzt.
BrickletDistanceIR.
getIdentity
()¶Rückgabeobjekt: |
|
---|
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.
BrickletDistanceIR.
setDistanceCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der DistanceListener
Listener ausgelöst wird.
Ein Wert von 0 deaktiviert den Listener.
Der DistanceListener
Listener wird nur ausgelöst, wenn sich der Strom seit der
letzten Auslösung geändert hat.
BrickletDistanceIR.
getDistanceCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setDistanceCallbackPeriod()
gesetzt.
BrickletDistanceIR.
setAnalogValueCallbackPeriod
(long period)¶Parameter: |
|
---|
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.
BrickletDistanceIR.
getAnalogValueCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAnalogValueCallbackPeriod()
gesetzt.
BrickletDistanceIR.
setDistanceCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den DistanceReachedListener
Listener.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Listener ist inaktiv |
'o' | Listener wird ausgelöst, wenn die Entfernung außerhalb des min und max Wertes ist |
'i' | Listener wird ausgelöst, wenn die Entfernung innerhalb des min und max Wertes ist |
'<' | Listener wird ausgelöst, wenn die Entfernung kleiner als der min Wert ist (max wird ignoriert) |
'>' | Listener wird ausgelöst, wenn die Entfernung größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletDistanceIR.
getDistanceCallbackThreshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setDistanceCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletDistanceIR.
setAnalogValueCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
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 des min und max Wertes ist |
'i' | Listener wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes 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:
BrickletDistanceIR.
getAnalogValueCallbackThreshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setAnalogValueCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletDistanceIR.
setDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Listeners
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletDistanceIR.
getDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von setDebouncePeriod()
gesetzt.
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 BrickletDistanceIR.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.
BrickletDistanceIR.
DistanceListener
()¶Dieser Listener kann mit der Funktion addDistanceListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeDistanceListener()
wieder
entfernt werden.
distance
(int distance)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit setDistanceCallbackPeriod()
,
ausgelöst. Der Parameter ist die Entfernung des Sensors.
Der DistanceListener
Listener wird nur ausgelöst, wenn sich der Strom seit der
letzten Auslösung geändert hat.
BrickletDistanceIR.
AnalogValueListener
()¶Dieser Listener kann mit der Funktion addAnalogValueListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAnalogValueListener()
wieder
entfernt werden.
analogValue
(int value)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod()
,
ausgelöst. Der Parameter ist der Analogwert des Sensors.
Der AnalogValueListener
Listener wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
BrickletDistanceIR.
DistanceReachedListener
()¶Dieser Listener kann mit der Funktion addDistanceReachedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeDistanceReachedListener()
wieder
entfernt werden.
distanceReached
(int distance)Parameter: |
|
---|
Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von
setDistanceCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Entfernung des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
BrickletDistanceIR.
AnalogValueReachedListener
()¶Dieser Listener kann mit der Funktion addAnalogValueReachedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAnalogValueReachedListener()
wieder
entfernt werden.
analogValueReached
(int value)Parameter: |
|
---|
Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von
setAnalogValueCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist der Analogwert des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
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.
BrickletDistanceIR.
getAPIVersion
()¶Rückgabeobjekt: |
|
---|
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.
BrickletDistanceIR.
getResponseExpected
(byte functionId)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletDistanceIR.
setResponseExpected
(byte functionId, boolean responseExpected)¶Parameter: |
|
---|
Ä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:
BrickletDistanceIR.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.
BrickletDistanceIR.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Distance IR 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.
BrickletDistanceIR.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet dar.