Dies ist die Beschreibung der Java API Bindings für das Color Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Color 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 32 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletColor;
import com.tinkerforge.BrickletColor.Color;
public class ExampleSimple {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Color 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
BrickletColor c = new BrickletColor(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current color
Color color = c.getColor(); // Can throw com.tinkerforge.TimeoutException
System.out.println("Color [R]: " + color.r);
System.out.println("Color [G]: " + color.g);
System.out.println("Color [B]: " + color.b);
System.out.println("Color [C]: " + color.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 36 37 38 39 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletColor;
public class ExampleCallback {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Color 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
BrickletColor c = new BrickletColor(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Add color listener
c.addColorListener(new BrickletColor.ColorListener() {
public void color(int r, int g, int b, int c) {
System.out.println("Color [R]: " + r);
System.out.println("Color [G]: " + g);
System.out.println("Color [B]: " + b);
System.out.println("Color [C]: " + c);
System.out.println("");
}
});
// Set period for color callback to 1s (1000ms)
// Note: The color callback is only called every second
// if the color has changed since the last call!
c.setColorCallbackPeriod(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 37 38 39 40 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletColor;
public class ExampleThreshold {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Color 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
BrickletColor c = new BrickletColor(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)
c.setDebouncePeriod(10000);
// Add color reached listener
c.addColorReachedListener(new BrickletColor.ColorReachedListener() {
public void colorReached(int r, int g, int b, int c) {
System.out.println("Color [R]: " + r);
System.out.println("Color [G]: " + g);
System.out.println("Color [B]: " + b);
System.out.println("Color [C]: " + c);
System.out.println("");
}
});
// Configure threshold for color "greater than 100, 200, 300, 400"
c.setColorCallbackThreshold('>', 100, 0, 200, 0, 300, 0, 400, 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.
BrickletColor
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletColor color = new BrickletColor("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletColor.
getColor
()¶Rückgabeobjekt: |
|
---|
Gibt die gemessene Farbe des Sensors zurück.
Die rot (r), grün (g), blau (b) und clear (c) werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:
Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen
den ColorListener
Listener zu nutzen und die Periode mit
setColorCallbackPeriod()
vorzugeben.
BrickletColor.
lightOn
()¶Aktiviert die LED.
BrickletColor.
lightOff
()¶Deaktiviert die LED.
BrickletColor.
isLightOn
()¶Rückgabe: |
|
---|
Gibt den Zustand der LED zurück. Mögliche Werte sind:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für light:
BrickletColor.
setConfig
(short gain, short integrationTime)¶Parameter: |
|
---|
Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.
Für die Konfiguration der Verstärkung:
Für die Konfiguration der Integrationszeit:
Eine Erhöhung der Verstärkung ermöglicht es dem Sensor Farben aus größeren Entfernungen zu erkennen.
Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger bis ein Resultat bereitsteht.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
Für integrationTime:
BrickletColor.
getConfig
()¶Rückgabeobjekt: |
|
---|
Gibt die Einstellungen zurück, wie von setConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
Für integrationTime:
BrickletColor.
getIlluminance
()¶Rückgabe: |
|
---|
Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die
Integrationszeit zurück. Verstärkung und Integrationszeit können mit
setConfig()
eingestellt werden. Um die Beleuchtungsstärke in Lux zu
ermitteln muss folgende Formel angewendet werden:
lux = illuminance * 700 / gain / integration_time
Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt
sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein
Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall
kann die Verstärkung per setConfig()
reduziert werden.
BrickletColor.
getColorTemperature
()¶Rückgabe: |
|
---|
Gibt die Farbtemperatur zurück.
Für eine korrekte Messung der Farbtemperatur muss sichergestellt
sein das die Farbwerte (R, G oder B) nicht saturiert sind. Ein
Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall
kann die Verstärkung per setConfig()
reduziert werden.
BrickletColor.
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.
BrickletColor.
setColorCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der ColorListener
Listener ausgelöst wird.
Ein Wert von 0 deaktiviert den Listener.
Der ColorListener
Listener wird nur ausgelöst, wenn sich die Color seit der
letzten Auslösung geändert hat.
BrickletColor.
getColorCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setColorCallbackPeriod()
gesetzt.
BrickletColor.
setColorCallbackThreshold
(char option, int minR, int maxR, int minG, int maxG, int minB, int maxB, int minC, int maxC)¶Parameter: |
|
---|
Setzt den Schwellwert für den ColorReachedListener
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:
BrickletColor.
getColorCallbackThreshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setColorCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletColor.
setDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Listener
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletColor.
getDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von setDebouncePeriod()
gesetzt.
BrickletColor.
setIlluminanceCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der IlluminanceListener
Listener ausgelöst
wird. Ein Wert von 0 deaktiviert den Listener.
Der IlluminanceListener
Listener wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
BrickletColor.
getIlluminanceCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setIlluminanceCallbackPeriod()
gesetzt.
BrickletColor.
setColorTemperatureCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der ColorTemperatureListener
Listener
ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.
Der ColorTemperatureListener
Listener wird nur ausgelöst, wenn sich die
Farbtemperatur seit der letzten Auslösung geändert hat.
BrickletColor.
getColorTemperatureCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setColorTemperatureCallbackPeriod()
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 BrickletColor.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.
BrickletColor.
ColorListener
()¶Dieser Listener kann mit der Funktion addColorListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeColorListener()
wieder
entfernt werden.
color
(int r, int g, int b, int c)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit setColorCallbackPeriod()
,
ausgelöst. Der Parameter ist die Farbe des Sensors als RGBC.
Der ColorListener
Listener wird nur ausgelöst, wenn sich die Farbe seit der
letzten Auslösung geändert hat.
BrickletColor.
ColorReachedListener
()¶Dieser Listener kann mit der Funktion addColorReachedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeColorReachedListener()
wieder
entfernt werden.
colorReached
(int r, int g, int b, int c)Parameter: |
|
---|
Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von
setColorCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Farbe des Sensors als RGBC.
Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
BrickletColor.
IlluminanceListener
()¶Dieser Listener kann mit der Funktion addIlluminanceListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeIlluminanceListener()
wieder
entfernt werden.
illuminance
(long illuminance)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit setIlluminanceCallbackPeriod()
,
ausgelöst. Der Parameter ist die Beleuchtungsstärke des Sensors.
Siehe getIlluminance()
für eine Erklärung wie dieser zu interpretieren ist.
Der IlluminanceListener
Listener wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
BrickletColor.
ColorTemperatureListener
()¶Dieser Listener kann mit der Funktion addColorTemperatureListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeColorTemperatureListener()
wieder
entfernt werden.
colorTemperature
(int colorTemperature)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setColorTemperatureCallbackPeriod()
, ausgelöst. Der Parameter
ist die Farbtemperatur des Sensors.
Der ColorTemperatureListener
Listener wird nur ausgelöst, wenn sich die
Farbtemperatur seit der letzten Auslösung geändert hat.
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.
BrickletColor.
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.
BrickletColor.
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:
BrickletColor.
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:
BrickletColor.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.
BrickletColor.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Color 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.
BrickletColor.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.