Dies ist die Beschreibung der Java API Bindings für das Segment Display 4x7 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Segment Display 4x7 Bricklet 2.0 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).
Download (ExampleNumericValue.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 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletSegmentDisplay4x7V2;
public class ExampleNumericValue {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0
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
BrickletSegmentDisplay4x7V2 sd =
new BrickletSegmentDisplay4x7V2(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
sd.setBrightness(7); // Set to full brightness
// Show "- 42" on the Display
sd.setNumericValue(new int[]{-2, -1, 4, 2});
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
Download (ExampleSetSegments.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 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletSegmentDisplay4x7V2;
public class ExampleSetSegments {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0
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
BrickletSegmentDisplay4x7V2 sd =
new BrickletSegmentDisplay4x7V2(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
sd.setBrightness(7); // Set to full brightness
// Activate all segments
sd.setSegments(new boolean[]{true, true, true, true, true, true, true, true},
new boolean[]{true, true, true, true, true, true, true, true},
new boolean[]{true, true, true, true, true, true, true, true},
new boolean[]{true, true, true, true, true, true, true, true},
new boolean[]{true, true}, true);
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
Download (ExampleBlinkColon.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.BrickletSegmentDisplay4x7V2;
public class ExampleBlinkColon {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0
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
BrickletSegmentDisplay4x7V2 sd =
new BrickletSegmentDisplay4x7V2(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
sd.setBrightness(7); // Set to full brightness
// Blink colon 10 times
for(int i = 0; i < 10; i++) {
// Activate segments of colon
sd.setSelectedSegment(32, true);
sd.setSelectedSegment(33, true);
Thread.sleep(250);
// Deactivate segments of colon
sd.setSelectedSegment(32, false);
sd.setSelectedSegment(33, false);
}
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.
BrickletSegmentDisplay4x7V2
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletSegmentDisplay4x7V2 segmentDisplay4x7V2 = new BrickletSegmentDisplay4x7V2("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletSegmentDisplay4x7V2.
setSegments
(boolean[] digit0, boolean[] digit1, boolean[] digit2, boolean[] digit3, boolean[] colon, boolean tick)¶Parameter: |
|
---|
Setzt die einzelnen Segmente des Segment Display 4x7 Bricklet 2.0 Segment für Segment.
Die Daten sind aufgeteilt in die vier Ziffern (digit0-3), dem Doppelpunkt (colon) und dem Hochkomma (tick).
Die Indizes der Segmente in den Ziffern und dem Doppelpunkt sind wie folgt aufgeteilt:
BrickletSegmentDisplay4x7V2.
getSegments
()¶Rückgabeobjekt: |
|
---|
Gibt die Segmentdaten zurück, wie von setSegments()
gesetzt.
BrickletSegmentDisplay4x7V2.
setBrightness
(int brightness)¶Parameter: |
|
---|
Die Helligkeit kann zwischen 0 (dunkel) und 7 (hell) gesetzt werden.
BrickletSegmentDisplay4x7V2.
getBrightness
()¶Rückgabe: |
|
---|
Gibt die Helligkeit zurück, wie von setBrightness()
gesetzt.
BrickletSegmentDisplay4x7V2.
setNumericValue
(int[] value)¶Parameter: |
|
---|
Setzt einen numerischen Wert für jede Ziffer. Die Werte repräsentieren:
Beispiel: Ein Aufruf mit [-2, -1, 4, 2] erzeugt eine Anzeige auf dem Display von "- 42".
BrickletSegmentDisplay4x7V2.
setSelectedSegment
(int segment, boolean value)¶Parameter: |
|
---|
Aktiviert/deaktiviert ein selektiertes Segment.
Die Indizes sind wie folgt aufgeteilt:
BrickletSegmentDisplay4x7V2.
getSelectedSegment
(int segment)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den Wert eines einzelnen Segments zurück.
BrickletSegmentDisplay4x7V2.
startCounter
(int valueFrom, int valueTo, int increment, long length)¶Parameter: |
|
---|
Starter einen Zähler mit dem from Wert der bis zum to Wert zählt mit einer Schrittweite von increment. Das Argument length ist die Länge der Pause zwischen zwei Inkrements.
Beispiel: Wenn from auf 0, to auf 100, increment auf 1 und length auf 1000 gesetzt wird, wird ein Zähler gestartet der von 0 bis 100 zählt mit Rate von einer Sekunde zwischen jeder Erhöhung.
Wenn increment negativ ist läuft der Zähler rückwärts.
Der Zähler kann jederzeit durch einen Aufruf von setSegments()
oder
setNumericValue()
gestoppt werden.
BrickletSegmentDisplay4x7V2.
getCounterValue
()¶Rückgabe: |
|
---|
Gibt den aktuellen Zählerstand zurück der auf der Anzeige angezeigt wird.
Wenn kein Zähler läuft wird eine 0 zurückgegeben.
BrickletSegmentDisplay4x7V2.
getSPITFPErrorCount
()¶Rückgabeobjekt: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletSegmentDisplay4x7V2.
setStatusLEDConfig
(int config)¶Parameter: |
|
---|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletSegmentDisplay4x7V2.
getStatusLEDConfig
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von setStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletSegmentDisplay4x7V2.
getChipTemperature
()¶Rückgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletSegmentDisplay4x7V2.
reset
()¶Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
BrickletSegmentDisplay4x7V2.
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.
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 BrickletSegmentDisplay4x7V2.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.
BrickletSegmentDisplay4x7V2.
CounterFinishedListener
()¶Dieser Listener kann mit der Funktion addCounterFinishedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeCounterFinishedListener()
wieder
entfernt werden.
counterFinished
()Diese Listener wird ausgelöst, wenn der Zähler (siehe startCounter()
)
fertig ist.
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.
BrickletSegmentDisplay4x7V2.
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.
BrickletSegmentDisplay4x7V2.
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:
BrickletSegmentDisplay4x7V2.
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:
BrickletSegmentDisplay4x7V2.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
BrickletSegmentDisplay4x7V2.
setBootloaderMode
(int mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
BrickletSegmentDisplay4x7V2.
getBootloaderMode
()¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletSegmentDisplay4x7V2.
setWriteFirmwarePointer
(long pointer)¶Parameter: |
|
---|
Setzt den Firmware-Pointer für writeFirmware()
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletSegmentDisplay4x7V2.
writeFirmware
(int[] data)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
setWriteFirmwarePointer()
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletSegmentDisplay4x7V2.
writeUID
(long uid)¶Parameter: |
|
---|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
BrickletSegmentDisplay4x7V2.
readUID
()¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletSegmentDisplay4x7V2.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Segment Display 4x7 Bricklet 2.0 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.
BrickletSegmentDisplay4x7V2.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Segment Display 4x7 Bricklet 2.0 dar.