Dies ist die Beschreibung der Java API Bindings für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature 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 28 29 30 31 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletTemperatureIR;
public class ExampleSimple {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Temperature 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
BrickletTemperatureIR tir = new BrickletTemperatureIR(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current ambient temperature
short ambientTemperature = tir.getAmbientTemperature(); // Can throw com.tinkerforge.TimeoutException
System.out.println("Ambient Temperature: " + ambientTemperature/10.0 + " °C");
// Get current object temperature
short objectTemperature = tir.getObjectTemperature(); // Can throw com.tinkerforge.TimeoutException
System.out.println("Object Temperature: " + objectTemperature/10.0 + " °C");
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.BrickletTemperatureIR;
public class ExampleCallback {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Temperature 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
BrickletTemperatureIR tir = new BrickletTemperatureIR(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Add object temperature listener
tir.addObjectTemperatureListener(new BrickletTemperatureIR.ObjectTemperatureListener() {
public void objectTemperature(short temperature) {
System.out.println("Object Temperature: " + temperature/10.0 + " °C");
}
});
// Set period for object temperature callback to 1s (1000ms)
// Note: The object temperature callback is only called every second
// if the object temperature has changed since the last call!
tir.setObjectTemperatureCallbackPeriod(1000);
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
Download (ExampleWaterBoiling.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 37 38 39 40 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletTemperatureIR;
public class ExampleWaterBoiling {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Temperature 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
BrickletTemperatureIR tir = new BrickletTemperatureIR(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
tir.setEmissivity(64224);
// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tir.setDebouncePeriod(10000);
// Add object temperature reached listener
tir.addObjectTemperatureReachedListener(new BrickletTemperatureIR.ObjectTemperatureReachedListener() {
public void objectTemperatureReached(short temperature) {
System.out.println("Object Temperature: " + temperature/10.0 + " °C");
System.out.println("The water is boiling!");
}
});
// Configure threshold for object temperature "greater than 100 °C"
tir.setObjectTemperatureCallbackThreshold('>', (short)(100*10), (short)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.
BrickletTemperatureIR
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletTemperatureIR temperatureIR = new BrickletTemperatureIR("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletTemperatureIR.
getAmbientTemperature
()¶Rückgabe: |
|
---|
Gibt die Umgebungstemperatur des Sensors zurück.
Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen
den AmbientTemperatureListener
Listener zu nutzen und die Periode mit
setAmbientTemperatureCallbackPeriod()
vorzugeben.
BrickletTemperatureIR.
getObjectTemperature
()¶Rückgabe: |
|
---|
Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt.
Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem
Emissionsgrad. Der
Emissionsgrad des Materials kann mit setEmissivity()
gesetzt werden.
Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen
den ObjectTemperatureListener
Listener zu nutzen und die Periode mit
setObjectTemperatureCallbackPeriod()
vorzugeben.
BrickletTemperatureIR.
setEmissivity
(int emissivity)¶Parameter: |
|
---|
Setzt den Emissionsgrad,
welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von
getObjectTemperature()
zurückgegeben.
Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.
Der Parameter von setEmissivity()
muss mit eine Faktor von 65535 (16-Bit)
vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert
6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.
Bemerkung
Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.
Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.
BrickletTemperatureIR.
getEmissivity
()¶Rückgabe: |
|
---|
Gibt den Emissionsgrad zurück, wie von setEmissivity()
gesetzt.
BrickletTemperatureIR.
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.
BrickletTemperatureIR.
setAmbientTemperatureCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AmbientTemperatureListener
Listener
ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.
Der AmbientTemperatureListener
Listener wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR.
getAmbientTemperatureCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAmbientTemperatureCallbackPeriod()
gesetzt.
BrickletTemperatureIR.
setObjectTemperatureCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der ObjectTemperatureListener
Listener
ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.
Der ObjectTemperatureListener
Listener wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR.
getObjectTemperatureCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setObjectTemperatureCallbackPeriod()
gesetzt.
BrickletTemperatureIR.
setAmbientTemperatureCallbackThreshold
(char option, short min, short max)¶Parameter: |
|
---|
Setzt den Schwellwert für den AmbientTemperatureReachedListener
Listener.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Listener ist inaktiv |
'o' | Listener wird ausgelöst, wenn die Umgebungstemperatur außerhalb des min und max Wertes ist |
'i' | Listener wird ausgelöst, wenn die Umgebungstemperatur innerhalb des min und max Wertes ist |
'<' | Listener wird ausgelöst, wenn die Umgebungstemperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Listener wird ausgelöst, wenn die Umgebungstemperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletTemperatureIR.
getAmbientTemperatureCallbackThreshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setAmbientTemperatureCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletTemperatureIR.
setObjectTemperatureCallbackThreshold
(char option, short min, short max)¶Parameter: |
|
---|
Setzt den Schwellwert für den ObjectTemperatureReachedListener
Listener.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Listener ist inaktiv |
'o' | Listener wird ausgelöst, wenn die Objekttemperatur außerhalb des min und max Wertes ist |
'i' | Listener wird ausgelöst, wenn die Objekttemperatur innerhalb des min und max Wertes ist |
'<' | Listener wird ausgelöst, wenn die Objekttemperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Listener wird ausgelöst, wenn die Objekttemperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletTemperatureIR.
getObjectTemperatureCallbackThreshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setObjectTemperatureCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletTemperatureIR.
setDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Listeners
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletTemperatureIR.
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 BrickletTemperatureIR.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.
BrickletTemperatureIR.
AmbientTemperatureListener
()¶Dieser Listener kann mit der Funktion addAmbientTemperatureListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAmbientTemperatureListener()
wieder
entfernt werden.
ambientTemperature
(short temperature)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit setAmbientTemperatureCallbackPeriod()
,
ausgelöst. Der Parameter ist die Temperatur des Sensors.
Der AmbientTemperatureListener
Listener wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR.
ObjectTemperatureListener
()¶Dieser Listener kann mit der Funktion addObjectTemperatureListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeObjectTemperatureListener()
wieder
entfernt werden.
objectTemperature
(short temperature)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setObjectTemperatureCallbackPeriod()
, ausgelöst. Der
Parameter ist die Objekttemperatur des Sensors.
Der ObjectTemperatureListener
Listener wird nur ausgelöst, wenn sich die
Objekttemperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR.
AmbientTemperatureReachedListener
()¶Dieser Listener kann mit der Funktion addAmbientTemperatureReachedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAmbientTemperatureReachedListener()
wieder
entfernt werden.
ambientTemperatureReached
(short temperature)Parameter: |
|
---|
Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von
setAmbientTemperatureCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Umgebungstemperatur des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
BrickletTemperatureIR.
ObjectTemperatureReachedListener
()¶Dieser Listener kann mit der Funktion addObjectTemperatureReachedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeObjectTemperatureReachedListener()
wieder
entfernt werden.
objectTemperatureReached
(short temperature)Parameter: |
|
---|
Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von
setObjectTemperatureCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Objekttemperatur 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.
BrickletTemperatureIR.
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.
BrickletTemperatureIR.
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:
BrickletTemperatureIR.
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:
BrickletTemperatureIR.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.
BrickletTemperatureIR.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Temperature 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.
BrickletTemperatureIR.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.