Dies ist die Beschreibung der LabVIEW API Bindings für das LED Strip Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LED Strip Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die LabVIEW API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt
eine Tinkerforge.TimeoutException
melden. Dieser Fehler wird
gemeldet 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.
Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist
Tinkerforge.*
.
BrickletLEDStrip
(uid, ipcon) → ledStrip¶Eingabe: |
|
---|---|
Ausgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
.
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletLEDStrip.
SetRGBValues
(index, length, r, g, b)¶Eingabe: |
|
---|
Setzt length RGB Werte für die LEDs, beginnend vom angegebenen index.
Damit die Farben richtig angezeigt werden muss den LEDs entsprechend der
richtig Chip Type (SetChipType()
) und das richtige 3-Kanal Channel Mapping
(SetChannelMapping()
) eingestellt werden.
Beispiel: Wenn
gesetzt wird, wird die LED an Index 5 die Farbe Rot annehmen, 6 wird Grün und 7 wird Blau.
Bemerkung
Abhängig von der internen LED Schaltung können die Farben vertauscht sein.
Die Farben werden auf die tatsächlichen LEDs transferiert wenn die
nächste frame duration abgelaufen ist, siehe SetFrameDuration()
.
Genereller Ansatz:
FrameRenderedCallback
Callback.FrameRenderedCallback
Callback.Dieser Ansatz garantiert, dass die LED Farben mit einer festen Framerate angezeigt werden.
Die effektive Anzahl steuerbarer LEDs ist abhängig von der Anzahl
der freien Bricklet Ports (siehe hier).
Ein Aufruf von SetRGBValues()
mit index + length größer als die
Begrenzung werden komplett ingnoriert.
BrickletLEDStrip.
GetRGBValues
(index, length) → r, g, b¶Eingabe: |
|
---|---|
Ausgabe: |
|
Gibt length R, G und B Werte zurück, beginnend von der übergebenen LED index.
Die Werte sind die letzten von SetRGBValues()
gesetzten Werte.
BrickletLEDStrip.
SetFrameDuration
(duration)¶Eingabe: |
|
---|
Setzt die frame duration (Länge des Frames).
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 SetRGBValues()
.
BrickletLEDStrip.
GetFrameDuration
() → duration¶Ausgabe: |
|
---|
Gibt die frame duration (Länge des Frames) zurück, wie von
SetFrameDuration()
gesetzt.
BrickletLEDStrip.
GetSupplyVoltage
() → voltage¶Ausgabe: |
|
---|
Gibt die aktuelle Versorgungsspannung der LEDs zurück.
BrickletLEDStrip.
SetClockFrequency
(frequency)¶Eingabe: |
|
---|
Setzt die Frequenz der Clock-Leitung. 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.
Bemerkung
Die Frequenz in Firmware Version 2.0.0 ist fest auf 2MHz gesetzt.
Neu in Version 2.0.1 (Plugin).
BrickletLEDStrip.
GetClockFrequency
() → frequency¶Ausgabe: |
|
---|
Gibt die aktuell genutzte Clock-Frequenz zurück, wie von
SetClockFrequency()
gesetzt.
Neu in Version 2.0.1 (Plugin).
BrickletLEDStrip.
SetChipType
(chip)¶Eingabe: |
|
---|
Setzt den Typ des LED-Treiber-Chips. Aktuell unterstützen wir die folgenden Chips
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für chip:
Neu in Version 2.0.2 (Plugin).
BrickletLEDStrip.
GetChipType
() → chip¶Ausgabe: |
|
---|
Gibt den aktuell genutzten Typ des Chips zurück, wie von
SetChipType()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für chip:
Neu in Version 2.0.2 (Plugin).
BrickletLEDStrip.
SetRGBWValues
(index, length, r, g, b, w)¶Eingabe: |
|
---|
Setzt length RGBW Werte für die LEDs beginnend vom angegebenen index.
Damit die Farben richtig angezeigt werden muss den LEDs der
entsprechende Chip Type (SetChipType()
) und das richtige 4-Kanal Channel Mapping
(SetChannelMapping()
) eingestellt werden.
Beispiel: Wenn
gesetzt wird, wird die LED an Index 5 die Farbe Rot annehmen, 6 wird Grün, 7 wird Blau und 8 wird Weiß.
Bemerkung
Abhängig von der internen LED Schaltung können die Farben vertauscht sein.
Die Farben werden auf die tatsächlichen LEDs transferiert wenn die
nächste frame duration abgelaufen ist, siehe SetFrameDuration()
.
Genereller Ansatz:
FrameRenderedCallback
Callback.FrameRenderedCallback
Callback.Dieser Ansatz garantiert das die LED Farben mit einer festen Framerate angezeigt werden.
Die effektive Anzahl steuerbarer LEDs ist abhängig von der Anzahl
der freien Bricklet Ports (siehe hier).
Ein Aufruf von SetRGBWValues()
mit index + length größer als die
Begrenzung werden komplett ignoriert.
Die LPD8806 LED-Treiber-Chips haben 7-Bit Kanäle für RGB. Intern teilt das LED Strip Bricklet die 8-Bit Werte die mit dieser Funktion gesetzt werden durch 2, um daraus 7-Bit Werte zu machen. Daher kann der normale Wertebereich (0-255) auch für LPD8806 LEDs verwendet werden.
Der Helligkeitskanal der APA102 LED-Treiber-Chips hat 5-Bit. Intern teilt das LED Strip Bricklet die 8-Bit Werte die mit dieser Funktion gesetzt werden durch 8, um daraus 5-Bit Werte zu machen. Daher kann der normale Wertebereich (0-255) auch für den Helligkeitskanal von APA102 LEDs verwendet werden.
Neu in Version 2.0.6 (Plugin).
BrickletLEDStrip.
GetRGBWValues
(index, length) → r, g, b, w¶Eingabe: |
|
---|---|
Ausgabe: |
|
Gibt length RGBW Werte zurück, beginnend vom übergebenen index.
Die Werte sind die letzten von SetRGBWValues()
gesetzten Werte.
Neu in Version 2.0.6 (Plugin).
BrickletLEDStrip.
SetChannelMapping
(mapping)¶Eingabe: |
|
---|
Setzt das Channel Mapping für die angeschlossenene LEDs.
SetRGBValues()
und SetRGBWValues()
nehmen die Daten in RGB(W)
Reihenfolge entgegen. Aber die angeschlossenen LED-Treiber-Chips erwarten die
Daten für ihre 3 oder 4 Kanäle in einer anderen Reihenfolge. 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.
Wenn ein 3-Kanal Mapping ausgewählt wurde, dann muss auch SetRGBValues()
für das setzen der Farben verwendet werden. SetRGBWValues()
zusammen
mit einem 3-Kanal Mapping führt zu falscher Darstellung der Farben. Im Gegenzug
muss bei einem 4-Kanal Mapping SetRGBWValues()
für das setzen der Farben
verwendet werden. SetRGBValues()
zusammen mit einem 4-Kanal Mapping führt
zu falscher Darstellung der Farben.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mapping:
Neu in Version 2.0.6 (Plugin).
BrickletLEDStrip.
GetChannelMapping
() → mapping¶Ausgabe: |
|
---|
Gibt die aktuell genutzten Channel Mapping zurück, wie von
SetChannelMapping()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mapping:
Neu in Version 2.0.6 (Plugin).
BrickletLEDStrip.
GetIdentity
() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶Ausgabe: |
|
---|
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.
BrickletLEDStrip.
EnableFrameRenderedCallback
()¶Aktiviert den FrameRenderedCallback
Callback.
Standardmäßig ist der Callback aktiviert.
Neu in Version 2.0.6 (Plugin).
BrickletLEDStrip.
DisableFrameRenderedCallback
()¶Deaktiviert den FrameRenderedCallback
Callback.
Standardmäßig ist der Callback aktiviert.
Neu in Version 2.0.6 (Plugin).
BrickletLEDStrip.
IsFrameRenderedCallbackEnabled
() → enabled¶Ausgabe: |
|
---|
Gibt true zurück falls der FrameRenderedCallback
Callback aktiviert ist, false
sonst.
Neu in Version 2.0.6 (Plugin).
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.
Bemerkung
Callbacks 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.
BrickletLEDStrip.
FrameRenderedCallback
→ sender, length¶Callback-Ausgabe: |
|
---|
Dieser Callback wird direkt direkt nachdem ein Frame gerendert wurde ausgelöst. Der Parameter ist die Anzahl der RGB oder RGBW 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 SetRGBValues()
.
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.
BrickletLEDStrip.
GetAPIVersion
() → apiVersion¶Ausgabe: |
|
---|
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.
BrickletLEDStrip.
GetResponseExpected
(functionId) → responseExpected¶Eingabe: |
|
---|---|
Ausgabe: |
|
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 Callbacks 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:
BrickletLEDStrip.
SetResponseExpected
(functionId, responseExpected)¶Eingabe: |
|
---|
Ä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 Callbacks (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:
BrickletLEDStrip.
SetResponseExpectedAll
(responseExpected)¶Eingabe: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletLEDStrip.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein LED Strip Bricklet zu identifizieren.
Die GetIdentity()
Funktion und der
IPConnection.EnumerateCallback
Callback der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletLEDStrip.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet dar.