Dies ist die Beschreibung der Java API Bindings für das PTC Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des PTC 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.BrickletPTC;
public class ExampleSimple {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your PTC 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
BrickletPTC ptc = new BrickletPTC(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current temperature
int temperature = ptc.getTemperature(); // Can throw com.tinkerforge.TimeoutException
System.out.println("Temperature: " + temperature/100.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.BrickletPTC;
public class ExampleCallback {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your PTC 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
BrickletPTC ptc = new BrickletPTC(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Add temperature listener
ptc.addTemperatureListener(new BrickletPTC.TemperatureListener() {
public void temperature(int temperature) {
System.out.println("Temperature: " + temperature/100.0 + " °C");
}
});
// Set period for temperature callback to 1s (1000ms)
// Note: The temperature callback is only called every second
// if the temperature has changed since the last call!
ptc.setTemperatureCallbackPeriod(1000);
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.BrickletPTC;
public class ExampleThreshold {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your PTC 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
BrickletPTC ptc = new BrickletPTC(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)
ptc.setDebouncePeriod(10000);
// Add temperature reached listener
ptc.addTemperatureReachedListener(new BrickletPTC.TemperatureReachedListener() {
public void temperatureReached(int temperature) {
System.out.println("Temperature: " + temperature/100.0 + " °C");
}
});
// Configure threshold for temperature "greater than 30 °C"
ptc.setTemperatureCallbackThreshold('>', 30*100, 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.
BrickletPTC
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletPTC ptc = new BrickletPTC("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletPTC.
getTemperature
()¶Rückgabe: |
|
---|
Gibt die Temperatur des verbundenen Sensors zurück.
Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen
den TemperatureListener
Listener zu nutzen und die Periode mit
setTemperatureCallbackPeriod()
vorzugeben.
BrickletPTC.
isSensorConnected
()¶Rückgabe: |
|
---|
Gibt true zurück wenn ein Sensor korrekt verbunden ist.
Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.
BrickletPTC.
setWireMode
(short mode)¶Parameter: |
|
---|
Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPTC.
getWireMode
()¶Rückgabe: |
|
---|
Gibt die Leiter-Konfiguration zurück, wie von setWireMode()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPTC.
getResistance
()¶Rückgabe: |
|
---|
Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.
Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:
Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen
den ResistanceListener
Listener zu nutzen und die Periode mit
setResistanceCallbackPeriod()
vorzugeben.
BrickletPTC.
setNoiseRejectionFilter
(short filter)¶Parameter: |
|
---|
Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für filter:
BrickletPTC.
getNoiseRejectionFilter
()¶Rückgabe: |
|
---|
Gibt die Einstellung des Entstörfilters zurück, wie von
setNoiseRejectionFilter()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für filter:
BrickletPTC.
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.
BrickletPTC.
setTemperatureCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der TemperatureListener
Listener ausgelöst
wird. Ein Wert von 0 deaktiviert den Listener.
Der TemperatureListener
Listener wird nur ausgelöst, wenn sich die Temperatur seit
der letzten Auslösung geändert hat.
BrickletPTC.
getTemperatureCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setTemperatureCallbackPeriod()
gesetzt.
BrickletPTC.
setResistanceCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der ResistanceListener
Listener ausgelöst
wird. Ein Wert von 0 deaktiviert den Listener.
Der ResistanceListener
Listener wird nur ausgelöst, wenn sich der Widerstand seit
der letzten Auslösung geändert hat.
BrickletPTC.
getResistanceCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setResistanceCallbackPeriod()
gesetzt.
BrickletPTC.
setTemperatureCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den TemperatureReachedListener
Listener.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Listener ist inaktiv |
'o' | Listener wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist |
'i' | Listener wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist |
'<' | Listener wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Listener wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC.
getTemperatureCallbackThreshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setTemperatureCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC.
setResistanceCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den ResistanceReachedListener
Listener.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Listener ist inaktiv |
'o' | Listener wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist |
'i' | Listener wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist |
'<' | Listener wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Listener wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC.
getResistanceCallbackThreshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setResistanceCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC.
setDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Listener
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletPTC.
getDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von setDebouncePeriod()
gesetzt.
BrickletPTC.
setSensorConnectedCallbackConfiguration
(boolean enabled)¶Parameter: |
|
---|
Wenn dieser Listener aktiviert ist, wird der SensorConnectedListener
Listener
jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.
Neu in Version 2.0.2 (Plugin).
BrickletPTC.
getSensorConnectedCallbackConfiguration
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von setSensorConnectedCallbackConfiguration()
gesetzt.
Neu in Version 2.0.2 (Plugin).
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 BrickletPTC.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.
BrickletPTC.
TemperatureListener
()¶Dieser Listener kann mit der Funktion addTemperatureListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeTemperatureListener()
wieder
entfernt werden.
temperature
(int temperature)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit setTemperatureCallbackPeriod()
,
ausgelöst. Der Parameter ist die Temperatur des verbundenen Sensors.
Der TemperatureListener
Listener wird nur ausgelöst, wenn sich die Temperatur
seit der letzten Auslösung geändert hat.
BrickletPTC.
TemperatureReachedListener
()¶Dieser Listener kann mit der Funktion addTemperatureReachedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeTemperatureReachedListener()
wieder
entfernt werden.
temperatureReached
(int temperature)Parameter: |
|
---|
Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von
setTemperatureCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Temperatur des verbundenen Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
BrickletPTC.
ResistanceListener
()¶Dieser Listener kann mit der Funktion addResistanceListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeResistanceListener()
wieder
entfernt werden.
resistance
(int resistance)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit setResistanceCallbackPeriod()
,
ausgelöst. Der Parameter ist der Widerstand des verbundenen Sensors.
Der ResistanceListener
Listener wird nur ausgelöst, wenn sich der Widerstand seit
der letzten Auslösung geändert hat.
BrickletPTC.
ResistanceReachedListener
()¶Dieser Listener kann mit der Funktion addResistanceReachedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeResistanceReachedListener()
wieder
entfernt werden.
resistanceReached
(int resistance)Parameter: |
|
---|
Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von
setResistanceCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist der Widerstand des verbundenen Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
BrickletPTC.
SensorConnectedListener
()¶Dieser Listener kann mit der Funktion addSensorConnectedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeSensorConnectedListener()
wieder
entfernt werden.
sensorConnected
(boolean connected)Parameter: |
|
---|
Dieser Listener wird periodisch ausgelöst abhängig von der mittels
setSensorConnectedCallbackConfiguration()
gesetzten Konfiguration
Der Parameter ist der gleiche wie bei isSensorConnected()
.
Neu in Version 2.0.2 (Plugin).
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.
BrickletPTC.
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.
BrickletPTC.
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:
BrickletPTC.
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:
BrickletPTC.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.
BrickletPTC.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein PTC 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.
BrickletPTC.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.