Java - LED Strip Bricklet 2.0

Dies ist die Beschreibung der Java API Bindings für das LED Strip Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LED Strip Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Java API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLEDStripV2;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your LED Strip 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
        BrickletLEDStripV2 ls = new BrickletLEDStripV2(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Set first 3 LEDs to red, green and blue
        ls.setLEDValues(0, new int[]{255, 0, 0, 0, 255, 0, 0, 0, 255});

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback

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.BrickletLEDStripV2;

// FIXME: This example is incomplete

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your LED Strip 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
        BrickletLEDStripV2 ls = new BrickletLEDStripV2(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Set frame duration to 50ms (20 frames per second)
        ls.setFrameDuration(50);

        // Use frame started callback to move the active LED every frame
        ls.addFrameStartedListener(new BrickletLEDStripV2.FrameStartedListener() {
            public void frameStarted(int length) {
                System.out.println("Length: " + length);
            }
        });

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API

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.

Grundfunktionen

public class BrickletLEDStripV2(String uid, IPConnection ipcon)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

BrickletLEDStripV2 ledStripV2 = new BrickletLEDStripV2("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

public void setLEDValues(int index, int[] value)

Setzt die RGB(W) Werte der LEDs beginnend beim index. Es können bis zu 2048 RGB Werte oder 1536 RGBW Werte gesetzt werden.

Damit die Farben richtig angezeigt werden muss den LEDs entsprechend der richtig Chip Type (siehe setChipType()) und das richtige Channel Mapping (siehe setChannelMapping()) eingestellt werden.

Wenn das Channel Mapping 3 Farben hat, müssen die Werte in der Sequenz RGBRGBRGB... übergeben werden. Hat das Mapping 4 Farben, müssen die Werte in der Sequenz RGBWRGBWRGBW... übergeben werden.

Die Daten werden Zwischengespeichert und die Farben werden auf die LEDs transferiert wenn die nächste frame duration abgelaufen ist (siehe setFrameDuration()).

Genereller Ansatz:

  • Setze frame duration auf einen Wert welcher der Anzahl der Bilder pro Sekunde entspricht die erreicht werden sollen.
  • Setze alle LEDs für einen Frame.
  • Warte auf den FrameStartedListener Listener.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf den FrameStartedListener Listener.
  • Und so weiter.

Dieser Ansatz garantiert, dass die LED Farben mit einer festen Framerate angezeigt werden.

public int[] getLEDValues(int index, int length)

Gibt die RGB(W) Werte zurück, wie von setLEDValues() gesetzt.

public void setFrameDuration(int duration)

Setzt die frame duration (Länge des Frames) in ms.

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die Länge des Frames auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Für eine Erklärung des generellen Ansatzes siehe setLEDValues().

Standardwert: 100ms (10 Frames pro Sekunde).

public int getFrameDuration()

Gibt die frame duration (Länge des Frames) in ms zurück, wie von setFrameDuration() gesetzt.

public int getSupplyVoltage()

Gibt die aktuelle Versorgungsspannung der LEDs zurück. Die Spannung ist in mV angegeben.

public void setClockFrequency(long frequency)

Setzt die Frequenz der Clock-Leitung in Hz. Der erlaubte Wertebereich beläuft von sich 10000Hz (10kHz) bis 2000000Hz (2MHz).

Das Bricklet wählt die nächst mögliche erreichbare Frequenz. Diese kann ein paar Hz neben des gesetzten Wertes liegen. Die exakte Frequenz wie sie genutzt wird kann mit getClockFrequency() erfragt werden.

Wenn Probleme mit flackernden LEDs auftreten kann es daran liegen das Bits auf der Leitung flippen. Dies kann behoben werden in dem man die Verbindung zwischen Bricklet und LEDs verringert oder in dem man die Frequenz reduziert.

Mit abnehmender Frequenz nimmt allerdings auch die maximale Framerate ab.

Der Standardwert ist 1,66MHz

public long getClockFrequency()

Gibt die aktuell genutzte Clock-Frequenz zurück, wie von setClockFrequency() gesetzt.

public void setChipType(int chip)

Setzt den Typ des LED-Treiber-Chips. Aktuell unterstützen wir die folgenden Chips

  • WS2801,
  • WS2811,
  • WS2812 / SK6812 / NeoPixel RGB,
  • SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812),
  • LPD8806 and
  • APA102 / DotStar.

Der Standardwert ist WS2801 (2801).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletLEDStripV2.CHIP_TYPE_WS2801 = 2801
  • BrickletLEDStripV2.CHIP_TYPE_WS2811 = 2811
  • BrickletLEDStripV2.CHIP_TYPE_WS2812 = 2812
  • BrickletLEDStripV2.CHIP_TYPE_LPD8806 = 8806
  • BrickletLEDStripV2.CHIP_TYPE_APA102 = 102
public int getChipType()

Gibt den aktuell genutzten Typ des Chips zurück, wie von setChipType() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletLEDStripV2.CHIP_TYPE_WS2801 = 2801
  • BrickletLEDStripV2.CHIP_TYPE_WS2811 = 2811
  • BrickletLEDStripV2.CHIP_TYPE_WS2812 = 2812
  • BrickletLEDStripV2.CHIP_TYPE_LPD8806 = 8806
  • BrickletLEDStripV2.CHIP_TYPE_APA102 = 102
public void setChannelMapping(int mapping)

Setzt das Channel Mapping für die angeschlossenen LEDs.

Falls das Mapping 4 Farben hat, erwartet die Funktion setLEDValues() 4 Werte pro Pixel. Bei einem Mapping mit 3 Farben werden 3 Werte pro Pixel erwartet.

Die Funktion erwartet immer die Reihenfolge RGB(W). Die angeschlossenen LED-Treiber-Chips können die Daten für ihre 3 oder 4 Kanäle in einer anderen Reihenfolge erwarten. Zum Beispiel verwenden WS2801 Chips typischerweise BGR Reihenfolge, WS2812 Chips verwenden typischerweise GRB Reihenfolge und APA102 verwenden typischerweise WBGR Reihenfolge.

Die APA102 haben eine Besonderheit. Sie haben drei 8-Bit Kanäle für RGB und einen zusätzlichen 5-Bit Kanal für die Helligkeit der RGB LED. Dadurch ist der APA102 insgesamt ein 4-Kanal Chip. Intern ist der Helligkeitskanal der erste Kanal. Daher sollte eines der Wxyz Channel Mappings verwendet werden. Dann kann über den W Kanal die Helligkeit eingestellt werden.

Der Standardwert ist BGR (36).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletLEDStripV2.CHANNEL_MAPPING_RGB = 6
  • BrickletLEDStripV2.CHANNEL_MAPPING_RBG = 9
  • BrickletLEDStripV2.CHANNEL_MAPPING_BRG = 33
  • BrickletLEDStripV2.CHANNEL_MAPPING_BGR = 36
  • BrickletLEDStripV2.CHANNEL_MAPPING_GRB = 18
  • BrickletLEDStripV2.CHANNEL_MAPPING_GBR = 24
  • BrickletLEDStripV2.CHANNEL_MAPPING_RGBW = 27
  • BrickletLEDStripV2.CHANNEL_MAPPING_RGWB = 30
  • BrickletLEDStripV2.CHANNEL_MAPPING_RBGW = 39
  • BrickletLEDStripV2.CHANNEL_MAPPING_RBWG = 45
  • BrickletLEDStripV2.CHANNEL_MAPPING_RWGB = 54
  • BrickletLEDStripV2.CHANNEL_MAPPING_RWBG = 57
  • BrickletLEDStripV2.CHANNEL_MAPPING_GRWB = 78
  • BrickletLEDStripV2.CHANNEL_MAPPING_GRBW = 75
  • BrickletLEDStripV2.CHANNEL_MAPPING_GBWR = 108
  • BrickletLEDStripV2.CHANNEL_MAPPING_GBRW = 99
  • BrickletLEDStripV2.CHANNEL_MAPPING_GWBR = 120
  • BrickletLEDStripV2.CHANNEL_MAPPING_GWRB = 114
  • BrickletLEDStripV2.CHANNEL_MAPPING_BRGW = 135
  • BrickletLEDStripV2.CHANNEL_MAPPING_BRWG = 141
  • BrickletLEDStripV2.CHANNEL_MAPPING_BGRW = 147
  • BrickletLEDStripV2.CHANNEL_MAPPING_BGWR = 156
  • BrickletLEDStripV2.CHANNEL_MAPPING_BWRG = 177
  • BrickletLEDStripV2.CHANNEL_MAPPING_BWGR = 180
  • BrickletLEDStripV2.CHANNEL_MAPPING_WRBG = 201
  • BrickletLEDStripV2.CHANNEL_MAPPING_WRGB = 198
  • BrickletLEDStripV2.CHANNEL_MAPPING_WGBR = 216
  • BrickletLEDStripV2.CHANNEL_MAPPING_WGRB = 210
  • BrickletLEDStripV2.CHANNEL_MAPPING_WBGR = 228
  • BrickletLEDStripV2.CHANNEL_MAPPING_WBRG = 225
public int getChannelMapping()

Gibt die aktuell genutzten Channel Mapping zurück, wie von setChannelMapping() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletLEDStripV2.CHANNEL_MAPPING_RGB = 6
  • BrickletLEDStripV2.CHANNEL_MAPPING_RBG = 9
  • BrickletLEDStripV2.CHANNEL_MAPPING_BRG = 33
  • BrickletLEDStripV2.CHANNEL_MAPPING_BGR = 36
  • BrickletLEDStripV2.CHANNEL_MAPPING_GRB = 18
  • BrickletLEDStripV2.CHANNEL_MAPPING_GBR = 24
  • BrickletLEDStripV2.CHANNEL_MAPPING_RGBW = 27
  • BrickletLEDStripV2.CHANNEL_MAPPING_RGWB = 30
  • BrickletLEDStripV2.CHANNEL_MAPPING_RBGW = 39
  • BrickletLEDStripV2.CHANNEL_MAPPING_RBWG = 45
  • BrickletLEDStripV2.CHANNEL_MAPPING_RWGB = 54
  • BrickletLEDStripV2.CHANNEL_MAPPING_RWBG = 57
  • BrickletLEDStripV2.CHANNEL_MAPPING_GRWB = 78
  • BrickletLEDStripV2.CHANNEL_MAPPING_GRBW = 75
  • BrickletLEDStripV2.CHANNEL_MAPPING_GBWR = 108
  • BrickletLEDStripV2.CHANNEL_MAPPING_GBRW = 99
  • BrickletLEDStripV2.CHANNEL_MAPPING_GWBR = 120
  • BrickletLEDStripV2.CHANNEL_MAPPING_GWRB = 114
  • BrickletLEDStripV2.CHANNEL_MAPPING_BRGW = 135
  • BrickletLEDStripV2.CHANNEL_MAPPING_BRWG = 141
  • BrickletLEDStripV2.CHANNEL_MAPPING_BGRW = 147
  • BrickletLEDStripV2.CHANNEL_MAPPING_BGWR = 156
  • BrickletLEDStripV2.CHANNEL_MAPPING_BWRG = 177
  • BrickletLEDStripV2.CHANNEL_MAPPING_BWGR = 180
  • BrickletLEDStripV2.CHANNEL_MAPPING_WRBG = 201
  • BrickletLEDStripV2.CHANNEL_MAPPING_WRGB = 198
  • BrickletLEDStripV2.CHANNEL_MAPPING_WGBR = 216
  • BrickletLEDStripV2.CHANNEL_MAPPING_WGRB = 210
  • BrickletLEDStripV2.CHANNEL_MAPPING_WBGR = 228
  • BrickletLEDStripV2.CHANNEL_MAPPING_WBRG = 225

Fortgeschrittene Funktionen

public int[] getAPIVersion()

Gibt die Version der API Definition (Major, Minor, Revision) 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.

public boolean getResponseExpected(int functionId)

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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void setResponseExpected(int functionId, boolean responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletLEDStripV2.FUNCTION_SET_LED_VALUES = 1
  • BrickletLEDStripV2.FUNCTION_SET_FRAME_DURATION = 3
  • BrickletLEDStripV2.FUNCTION_SET_CLOCK_FREQUENCY = 7
  • BrickletLEDStripV2.FUNCTION_SET_CHIP_TYPE = 9
  • BrickletLEDStripV2.FUNCTION_SET_CHANNEL_MAPPING = 11
  • BrickletLEDStripV2.FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
  • BrickletLEDStripV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletLEDStripV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletLEDStripV2.FUNCTION_RESET = 243
  • BrickletLEDStripV2.FUNCTION_WRITE_UID = 248
public void setResponseExpectedAll(boolean responseExpected)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.

public BrickletLEDStripV2.SPITFPErrorCount getSPITFPErrorCount()

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame und long errorCountOverflow.

public int setBootloaderMode(int mode)

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 Bootlodaer- 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:

  • BrickletLEDStripV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLEDStripV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletLEDStripV2.BOOTLOADER_STATUS_OK = 0
  • BrickletLEDStripV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletLEDStripV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletLEDStripV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletLEDStripV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletLEDStripV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
public int getBootloaderMode()

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletLEDStripV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLEDStripV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLEDStripV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
public void setWriteFirmwarePointer(long pointer)

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.

public int writeFirmware(int[] data)

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.

public void setStatusLEDConfig(int config)

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:

  • BrickletLEDStripV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletLEDStripV2.STATUS_LED_CONFIG_ON = 1
  • BrickletLEDStripV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLEDStripV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getStatusLEDConfig()

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletLEDStripV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletLEDStripV2.STATUS_LED_CONFIG_ON = 1
  • BrickletLEDStripV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLEDStripV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getChipTemperature()

Gibt die Temperatur in °C, 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.

public void 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.

public void writeUID(long uid)

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.

public long readUID()

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

public BrickletLEDStripV2.Identity getIdentity()

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Listener

public void setFrameStartedCallbackConfiguration(boolean enable)

Aktiviert/deaktiviert den FrameStartedListener Listener.

Standardmäßig ist der Listener aktiviert.

public boolean getFrameStartedCallbackConfiguration()

Gibt die Konfiguration zurück, wie von setFrameStartedCallbackConfiguration() gesetzt.

Listener

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 BrickletLEDStripV2.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.

public class BrickletLEDStripV2.FrameStartedListener()

Dieser Listener kann mit der Funktion addFrameStartedListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeFrameStartedListener() wieder entfernt werden.

public void frameStarted(int length)

Dieser Listener wird direkt nachdem dem start eines Frames ausgelöst. Der Parameter ist die Anzahl der LEDs in diesem Frame.

Die Daten für das nächste Frame sollten direkt nach dem auslösen dieses Callbacks übertragen werden.

Für eine Erklärung des generellen Ansatzes siehe setLEDValues().

Konstanten

public static final int BrickletLEDStripV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein LED Strip 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.

public static final String BrickletLEDStripV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet 2.0 dar.