Visual Basic .NET - LED Strip Bricklet¶

Simple¶

Download (ExampleSimple.vb)

 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

Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your LED Strip Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ls As New BrickletLEDStrip(UID, ipcon) ' Create device object

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

        ' Set first 10 LEDs to green
        ls.SetRGBValues(0, 10, _
                        new Byte(){0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, _
                        new Byte(){255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0}, _
                        new Byte(){0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0})

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback¶

Download (ExampleCallback.vb)

 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
41
42
43
44
45
46
47
48
49

Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your LED Strip Bricklet
    Const NUM_LEDS As Integer = 16

    Dim rIndex As Integer = 0
    Dim r() As Byte = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}
    Dim g() As Byte = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}
    Dim b() As Byte = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

    ' Use frame rendered callback to move the active LED every frame
    Sub FrameRenderedCB(ByVal sender As BrickletLEDStrip, ByVal length As Integer)
        b(rIndex) = 0
        If rIndex = NUM_LEDS-1 Then
            rIndex = 0
        Else
            rIndex = rIndex + 1
        End If
        b(rIndex) = 255

        ' Set new data for next render cycle
        sender.SetRGBValues(0, NUM_LEDS, r, g, b)
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ls As New BrickletLEDStrip(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)

        ' Register frame rendered callback to subroutine FrameRenderedCB
        AddHandler ls.FrameRenderedCallback, AddressOf FrameRenderedCB

        ' Set initial rgb values to get started
        ls.SetRGBValues(0, NUM_LEDS, r, g, b)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Grundfunktionen¶

Class BrickletLEDStrip(ByVal uid As String, ByVal ipcon As IPConnection)¶

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

Dim ledStrip As New BrickletLEDStrip("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

Sub BrickletLEDStrip.SetRGBValues(ByVal index As Integer, ByVal length As Byte, ByVal r() As Byte, ByVal g() As Byte, ByVal b() As Byte)¶

Parameter:	index – Typ: Integer, Wertebereich: [0 bis 319] length – Typ: Byte, Wertebereich: [0 bis 16] r – Typ: Byte Array, Länge: 16, Wertebereich: [0 bis 255] g – Typ: Byte Array, Länge: 16, Wertebereich: [0 bis 255] b – Typ: Byte Array, Länge: 16, Wertebereich: [0 bis 255]

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

• index auf 5,
• length auf 3,
• r auf [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
• g auf [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] und
• b auf [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

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:

• 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 FrameRenderedCallback Callback.
• Setze alle LEDs für den nächsten Frame.
• Warte auf FrameRenderedCallback Callback.
• Und so weiter.

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.

Sub BrickletLEDStrip.GetRGBValues(ByVal index As Integer, ByVal length As Byte, ByRef r() As Byte, ByRef g() As Byte, ByRef b() As Byte)¶

Parameter:	index – Typ: Integer, Wertebereich: [0 bis 319] length – Typ: Byte, Wertebereich: [0 bis 16]
Ausgabeparameter:	r – Typ: Byte Array, Länge: 16, Wertebereich: [0 bis 255] g – Typ: Byte Array, Länge: 16, Wertebereich: [0 bis 255] b – Typ: Byte Array, Länge: 16, Wertebereich: [0 bis 255]

Gibt length R, G und B Werte zurück, beginnend von der übergebenen LED index.

Die Werte sind die letzten von SetRGBValues() gesetzten Werte.

Sub BrickletLEDStrip.SetFrameDuration(ByVal duration As Integer)¶

Parameter:	duration – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

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().

Function BrickletLEDStrip.GetFrameDuration() As Integer¶

Rückgabe:	duration – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

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

Function BrickletLEDStrip.GetSupplyVoltage() As Integer¶

Rückgabe:	voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

Sub BrickletLEDStrip.SetClockFrequency(ByVal frequency As Long)¶

Parameter:	frequency – Typ: Long, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

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

Function BrickletLEDStrip.GetClockFrequency() As Long¶

Rückgabe:	frequency – Typ: Long, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

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

Neu in Version 2.0.1 (Plugin).

Sub BrickletLEDStrip.SetChipType(ByVal chip As Integer)¶

Parameter:	chip – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: 2801

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.

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

Für chip:

• BrickletLEDStrip.CHIP_TYPE_WS2801 = 2801
• BrickletLEDStrip.CHIP_TYPE_WS2811 = 2811
• BrickletLEDStrip.CHIP_TYPE_WS2812 = 2812
• BrickletLEDStrip.CHIP_TYPE_LPD8806 = 8806
• BrickletLEDStrip.CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

Function BrickletLEDStrip.GetChipType() As Integer¶

Rückgabe:	chip – Typ: Integer, Wertebereich: Siehe Konstanten, Standardwert: 2801

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:

• BrickletLEDStrip.CHIP_TYPE_WS2801 = 2801
• BrickletLEDStrip.CHIP_TYPE_WS2811 = 2811
• BrickletLEDStrip.CHIP_TYPE_WS2812 = 2812
• BrickletLEDStrip.CHIP_TYPE_LPD8806 = 8806
• BrickletLEDStrip.CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

Sub BrickletLEDStrip.SetRGBWValues(ByVal index As Integer, ByVal length As Byte, ByVal r() As Byte, ByVal g() As Byte, ByVal b() As Byte, ByVal w() As Byte)¶

Parameter:	index – Typ: Integer, Wertebereich: [0 bis 239] length – Typ: Byte, Wertebereich: [0 bis 12] r – Typ: Byte Array, Länge: 12, Wertebereich: [0 bis 255] g – Typ: Byte Array, Länge: 12, Wertebereich: [0 bis 255] b – Typ: Byte Array, Länge: 12, Wertebereich: [0 bis 255] w – Typ: Byte Array, Länge: 12, Wertebereich: [0 bis 255]

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

• index auf 5,
• length auf 4,
• r auf [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
• g auf [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
• b auf [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] und
• w auf [0, 0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0]

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:

• 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 FrameRenderedCallback Callback.
• Setze alle LEDs für den nächsten Frame.
• Warte auf FrameRenderedCallback Callback.
• Und so weiter.

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

Sub BrickletLEDStrip.GetRGBWValues(ByVal index As Integer, ByVal length As Byte, ByRef r() As Byte, ByRef g() As Byte, ByRef b() As Byte, ByRef w() As Byte)¶

Parameter:	index – Typ: Integer, Wertebereich: [0 bis 239] length – Typ: Byte, Wertebereich: [0 bis 12]
Ausgabeparameter:	r – Typ: Byte Array, Länge: 12, Wertebereich: [0 bis 255] g – Typ: Byte Array, Länge: 12, Wertebereich: [0 bis 255] b – Typ: Byte Array, Länge: 12, Wertebereich: [0 bis 255] w – Typ: Byte Array, Länge: 12, Wertebereich: [0 bis 255]

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

Sub BrickletLEDStrip.SetChannelMapping(ByVal mapping As Byte)¶

Parameter:	mapping – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 36

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:

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

Neu in Version 2.0.6 (Plugin).

Function BrickletLEDStrip.GetChannelMapping() As Byte¶

Rückgabe:	mapping – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 36

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:

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

Neu in Version 2.0.6 (Plugin).

Fortgeschrittene Funktionen¶

Sub BrickletLEDStrip.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: Integer, Wertebereich: [0 bis 216 - 1]

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.

Konfigurationsfunktionen für Callbacks¶

Sub BrickletLEDStrip.EnableFrameRenderedCallback()¶

Aktiviert den FrameRenderedCallback Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

Sub BrickletLEDStrip.DisableFrameRenderedCallback()¶

Deaktiviert den FrameRenderedCallback Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

Function BrickletLEDStrip.IsFrameRenderedCallbackEnabled() As Boolean¶

Rückgabe:	enabled – Typ: Boolean, Standardwert: true

Gibt true zurück falls der FrameRenderedCallback Callback aktiviert ist, false sonst.

Neu in Version 2.0.6 (Plugin).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletLEDStrip, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler ledStrip.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Event BrickletLEDStrip.FrameRenderedCallback(ByVal sender As BrickletLEDStrip, ByVal length As Integer)¶

Callback-Parameter:	sender – Typ: BrickletLEDStrip length – Typ: Integer, Wertebereich: [0 bis 320]

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¶

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.

Function BrickletLEDStrip.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

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.

Function BrickletLEDStrip.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: Boolean

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.FUNCTION_SET_RGB_VALUES = 1
• BrickletLEDStrip.FUNCTION_SET_FRAME_DURATION = 3
• BrickletLEDStrip.FUNCTION_SET_CLOCK_FREQUENCY = 7
• BrickletLEDStrip.FUNCTION_SET_CHIP_TYPE = 9
• BrickletLEDStrip.FUNCTION_SET_RGBW_VALUES = 11
• BrickletLEDStrip.FUNCTION_SET_CHANNEL_MAPPING = 13
• BrickletLEDStrip.FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
• BrickletLEDStrip.FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16

Sub BrickletLEDStrip.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten responseExpected – Typ: Boolean

Ä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.FUNCTION_SET_RGB_VALUES = 1
• BrickletLEDStrip.FUNCTION_SET_FRAME_DURATION = 3
• BrickletLEDStrip.FUNCTION_SET_CLOCK_FREQUENCY = 7
• BrickletLEDStrip.FUNCTION_SET_CHIP_TYPE = 9
• BrickletLEDStrip.FUNCTION_SET_RGBW_VALUES = 11
• BrickletLEDStrip.FUNCTION_SET_CHANNEL_MAPPING = 13
• BrickletLEDStrip.FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
• BrickletLEDStrip.FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16

Sub BrickletLEDStrip.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameter:	responseExpected – Typ: Boolean

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

Konstanten¶

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

Const BrickletLEDStrip.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet dar.