Go - LED Strip Bricklet

Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/led_strip_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LED Strip Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ls, _ := led_strip_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Set first 10 LEDs to green
    ls.SetRGBValues(0, 10, [16]uint8{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
        [16]uint8{255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0},
        [16]uint8{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0})

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Callback

Download (example_callback.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/led_strip_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LED Strip Bricklet.

const NUM_LEDS = 16

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ls, _ := led_strip_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

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

    var r [16]uint8
    g := [16]uint8{255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0}
    var b [16]uint8

    ls.SetRGBValues(0, 10, r, g, b)

    var rIndex uint8

    ls.RegisterFrameRenderedCallback(func(length uint16) {
        b[rIndex] = 0
        if rIndex == NUM_LEDS-1 {
            rIndex = 0
        } else {
            rIndex++
        }
        b[rIndex] = 255
        ls.SetRGBValues(0, NUM_LEDS, r, g, b)
    })

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des LED Strip Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/led_strip_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func led_strip_bricklet.New(uid string, ipcon *IPConnection) (device LEDStripBricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: LEDStripBricklet
  • err – Typ: error

Erzeugt ein neues LEDStripBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := led_strip_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*LEDStripBricklet) SetRGBValues(index uint16, length uint8, r [16]uint8, g [16]uint8, b [16]uint8) (err error)
Parameter:
  • index – Typ: uint16, Wertebereich: [0 bis 319]
  • length – Typ: uint8, Wertebereich: [0 bis 16]
  • r – Typ: [16]uint8, Wertebereich: [0 bis 255]
  • g – Typ: [16]uint8, Wertebereich: [0 bis 255]
  • b – Typ: [16]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

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

func (*LEDStripBricklet) GetRGBValues(index uint16, length uint8) (r [16]uint8, g [16]uint8, b [16]uint8, err error)
Parameter:
  • index – Typ: uint16, Wertebereich: [0 bis 319]
  • length – Typ: uint8, Wertebereich: [0 bis 16]
Rückgabe:
  • r – Typ: [16]uint8, Wertebereich: [0 bis 255]
  • g – Typ: [16]uint8, Wertebereich: [0 bis 255]
  • b – Typ: [16]uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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

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

func (*LEDStripBricklet) SetFrameDuration(duration uint16) (err error)
Parameter:
  • duration – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100
Rückgabe:
  • err – Typ: error

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

func (*LEDStripBricklet) GetFrameDuration() (duration uint16, err error)
Rückgabe:
  • duration – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100
  • err – Typ: error

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

func (*LEDStripBricklet) GetSupplyVoltage() (voltage uint16, err error)
Rückgabe:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

func (*LEDStripBricklet) SetClockFrequency(frequency uint32) (err error)
Parameter:
  • frequency – Typ: uint32, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666
Rückgabe:
  • err – Typ: error

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

func (*LEDStripBricklet) GetClockFrequency() (frequency uint32, err error)
Rückgabe:
  • frequency – Typ: uint32, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666
  • err – Typ: error

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

Neu in Version 2.0.1 (Plugin).

func (*LEDStripBricklet) SetChipType(chip uint16) (err error)
Parameter:
  • chip – Typ: uint16, Wertebereich: Siehe Konstanten, Standardwert: 2801
Rückgabe:
  • err – Typ: error

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:

  • led_strip_bricklet.ChipTypeWS2801 = 2801
  • led_strip_bricklet.ChipTypeWS2811 = 2811
  • led_strip_bricklet.ChipTypeWS2812 = 2812
  • led_strip_bricklet.ChipTypeLPD8806 = 8806
  • led_strip_bricklet.ChipTypeAPA102 = 102

Neu in Version 2.0.2 (Plugin).

func (*LEDStripBricklet) GetChipType() (chip uint16, err error)
Rückgabe:
  • chip – Typ: uint16, Wertebereich: Siehe Konstanten, Standardwert: 2801
  • err – Typ: error

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:

  • led_strip_bricklet.ChipTypeWS2801 = 2801
  • led_strip_bricklet.ChipTypeWS2811 = 2811
  • led_strip_bricklet.ChipTypeWS2812 = 2812
  • led_strip_bricklet.ChipTypeLPD8806 = 8806
  • led_strip_bricklet.ChipTypeAPA102 = 102

Neu in Version 2.0.2 (Plugin).

func (*LEDStripBricklet) SetRGBWValues(index uint16, length uint8, r [12]uint8, g [12]uint8, b [12]uint8, w [12]uint8) (err error)
Parameter:
  • index – Typ: uint16, Wertebereich: [0 bis 239]
  • length – Typ: uint8, Wertebereich: [0 bis 12]
  • r – Typ: [12]uint8, Wertebereich: [0 bis 255]
  • g – Typ: [12]uint8, Wertebereich: [0 bis 255]
  • b – Typ: [12]uint8, Wertebereich: [0 bis 255]
  • w – Typ: [12]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

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

func (*LEDStripBricklet) GetRGBWValues(index uint16, length uint8) (r [12]uint8, g [12]uint8, b [12]uint8, w [12]uint8, err error)
Parameter:
  • index – Typ: uint16, Wertebereich: [0 bis 239]
  • length – Typ: uint8, Wertebereich: [0 bis 12]
Rückgabe:
  • r – Typ: [12]uint8, Wertebereich: [0 bis 255]
  • g – Typ: [12]uint8, Wertebereich: [0 bis 255]
  • b – Typ: [12]uint8, Wertebereich: [0 bis 255]
  • w – Typ: [12]uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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

func (*LEDStripBricklet) SetChannelMapping(mapping uint8) (err error)
Parameter:
  • mapping – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 36
Rückgabe:
  • err – Typ: error

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:

  • led_strip_bricklet.ChannelMappingRGB = 6
  • led_strip_bricklet.ChannelMappingRBG = 9
  • led_strip_bricklet.ChannelMappingBRG = 33
  • led_strip_bricklet.ChannelMappingBGR = 36
  • led_strip_bricklet.ChannelMappingGRB = 18
  • led_strip_bricklet.ChannelMappingGBR = 24
  • led_strip_bricklet.ChannelMappingRGBW = 27
  • led_strip_bricklet.ChannelMappingRGWB = 30
  • led_strip_bricklet.ChannelMappingRBGW = 39
  • led_strip_bricklet.ChannelMappingRBWG = 45
  • led_strip_bricklet.ChannelMappingRWGB = 54
  • led_strip_bricklet.ChannelMappingRWBG = 57
  • led_strip_bricklet.ChannelMappingGRWB = 78
  • led_strip_bricklet.ChannelMappingGRBW = 75
  • led_strip_bricklet.ChannelMappingGBWR = 108
  • led_strip_bricklet.ChannelMappingGBRW = 99
  • led_strip_bricklet.ChannelMappingGWBR = 120
  • led_strip_bricklet.ChannelMappingGWRB = 114
  • led_strip_bricklet.ChannelMappingBRGW = 135
  • led_strip_bricklet.ChannelMappingBRWG = 141
  • led_strip_bricklet.ChannelMappingBGRW = 147
  • led_strip_bricklet.ChannelMappingBGWR = 156
  • led_strip_bricklet.ChannelMappingBWRG = 177
  • led_strip_bricklet.ChannelMappingBWGR = 180
  • led_strip_bricklet.ChannelMappingWRBG = 201
  • led_strip_bricklet.ChannelMappingWRGB = 198
  • led_strip_bricklet.ChannelMappingWGBR = 216
  • led_strip_bricklet.ChannelMappingWGRB = 210
  • led_strip_bricklet.ChannelMappingWBGR = 228
  • led_strip_bricklet.ChannelMappingWBRG = 225

Neu in Version 2.0.6 (Plugin).

func (*LEDStripBricklet) GetChannelMapping() (mapping uint8, err error)
Rückgabe:
  • mapping – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 36
  • err – Typ: error

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:

  • led_strip_bricklet.ChannelMappingRGB = 6
  • led_strip_bricklet.ChannelMappingRBG = 9
  • led_strip_bricklet.ChannelMappingBRG = 33
  • led_strip_bricklet.ChannelMappingBGR = 36
  • led_strip_bricklet.ChannelMappingGRB = 18
  • led_strip_bricklet.ChannelMappingGBR = 24
  • led_strip_bricklet.ChannelMappingRGBW = 27
  • led_strip_bricklet.ChannelMappingRGWB = 30
  • led_strip_bricklet.ChannelMappingRBGW = 39
  • led_strip_bricklet.ChannelMappingRBWG = 45
  • led_strip_bricklet.ChannelMappingRWGB = 54
  • led_strip_bricklet.ChannelMappingRWBG = 57
  • led_strip_bricklet.ChannelMappingGRWB = 78
  • led_strip_bricklet.ChannelMappingGRBW = 75
  • led_strip_bricklet.ChannelMappingGBWR = 108
  • led_strip_bricklet.ChannelMappingGBRW = 99
  • led_strip_bricklet.ChannelMappingGWBR = 120
  • led_strip_bricklet.ChannelMappingGWRB = 114
  • led_strip_bricklet.ChannelMappingBRGW = 135
  • led_strip_bricklet.ChannelMappingBRWG = 141
  • led_strip_bricklet.ChannelMappingBGRW = 147
  • led_strip_bricklet.ChannelMappingBGWR = 156
  • led_strip_bricklet.ChannelMappingBWRG = 177
  • led_strip_bricklet.ChannelMappingBWGR = 180
  • led_strip_bricklet.ChannelMappingWRBG = 201
  • led_strip_bricklet.ChannelMappingWRGB = 198
  • led_strip_bricklet.ChannelMappingWGBR = 216
  • led_strip_bricklet.ChannelMappingWGRB = 210
  • led_strip_bricklet.ChannelMappingWBGR = 228
  • led_strip_bricklet.ChannelMappingWBRG = 225

Neu in Version 2.0.6 (Plugin).

Fortgeschrittene Funktionen

func (*LEDStripBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

func (*LEDStripBricklet) EnableFrameRenderedCallback() (err error)
Rückgabe:
  • err – Typ: error

Aktiviert den RegisterFrameRenderedCallback Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

func (*LEDStripBricklet) DisableFrameRenderedCallback() (err error)
Rückgabe:
  • err – Typ: error

Deaktiviert den RegisterFrameRenderedCallback Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

func (*LEDStripBricklet) IsFrameRenderedCallbackEnabled() (enabled bool, err error)
Rückgabe:
  • enabled – Typ: bool, Standardwert: true
  • err – Typ: error

Gibt true zurück falls der RegisterFrameRenderedCallback 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 kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

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.

func (*LEDStripBricklet) RegisterFrameRenderedCallback(func(length uint16)) (registrationId uint64)
Callback-Parameter:
  • length – Typ: uint16, Wertebereich: [0 bis 320]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird direkt direkt nachdem ein Frame gerendert wurde ausgelöst. Der Parameter des Callbacks 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.

func (*LEDStripBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*LEDStripBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: error

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:

  • led_strip_bricklet.FunctionSetRGBValues = 1
  • led_strip_bricklet.FunctionSetFrameDuration = 3
  • led_strip_bricklet.FunctionSetClockFrequency = 7
  • led_strip_bricklet.FunctionSetChipType = 9
  • led_strip_bricklet.FunctionSetRGBWValues = 11
  • led_strip_bricklet.FunctionSetChannelMapping = 13
  • led_strip_bricklet.FunctionEnableFrameRenderedCallback = 15
  • led_strip_bricklet.FunctionDisableFrameRenderedCallback = 16
func (*LEDStripBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

  • led_strip_bricklet.FunctionSetRGBValues = 1
  • led_strip_bricklet.FunctionSetFrameDuration = 3
  • led_strip_bricklet.FunctionSetClockFrequency = 7
  • led_strip_bricklet.FunctionSetChipType = 9
  • led_strip_bricklet.FunctionSetRGBWValues = 11
  • led_strip_bricklet.FunctionSetChannelMapping = 13
  • led_strip_bricklet.FunctionEnableFrameRenderedCallback = 15
  • led_strip_bricklet.FunctionDisableFrameRenderedCallback = 16
func (*LEDStripBricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

Konstanten

led_strip_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein LED Strip Bricklet zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

led_strip_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet dar.