Go - LED Strip Bricklet 2.0

Dies ist die Beschreibung der Go 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 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
package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ls, _ := led_strip_v2_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 3 LEDs to red, green and blue
    ls.SetLEDValues(0, []uint8{255, 0, 0, 0, 255, 0, 0, 0, 255})

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

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

// FIXME: This example is incomplete

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ls, _ := led_strip_v2_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)

    ls.RegisterFrameStartedCallback(func(length uint16) {
        fmt.Println("Length: ", length)
    })

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

API

Die API des LED Strip Bricklet 2.0 ist im Package github.com/Tinkerforge/go-api-bindings/led_strip_v2_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_v2_bricklet.New(uid string, ipcon *IPConnection) (device LEDStripV2Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: LEDStripV2Bricklet
  • err – Typ: error

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

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

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

func (*LEDStripV2Bricklet) SetLEDValues(index uint16, value []uint8) (err error)
Parameter:
  • index – Typ: uint16, Wertebereich: [0 bis 6144]
  • value – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Setzt die RGB(W) Werte der LEDs beginnend beim index. Es können bis zu 2048 RGB Werte oder 1536 RGBW Werte (jeweils 6144 Byte) 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 RegisterFrameStartedCallback Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf den RegisterFrameStartedCallback Callback.
  • Und so weiter.

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

func (*LEDStripV2Bricklet) GetLEDValues(index uint16, length uint16) (value []uint8, err error)
Parameter:
  • index – Typ: uint16, Wertebereich: [0 bis 6144]
  • length – Typ: uint16, Wertebereich: [0 bis 6144]
Rückgabe:
  • value – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255]
  • err – Typ: error

Gibt length RGB(W) Werte zurück, beginnend vom übergebenen index.

Wenn das Channel Mapping 3 Farben hat, werden die Werte in der Sequenz RGBRGBRGB... zurückgegeben, hat das Mapping 4 Farben, werden die Werte in der Sequenz RGBWRGBWRGBW... zurückgegeben (unter der Annahme, dass ein durch 3 (RGB) oder 4 (RGBW) teilbarer Index übergeben wird).

func (*LEDStripV2Bricklet) 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 SetLEDValues().

Standardwert: 100ms (10 Frames pro Sekunde).

func (*LEDStripV2Bricklet) 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 (*LEDStripV2Bricklet) 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 (*LEDStripV2Bricklet) 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.

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.

func (*LEDStripV2Bricklet) 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.

func (*LEDStripV2Bricklet) 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),
  • WS2813 / WS2815 (Chip Type = WS2812)
  • LPD8806 and
  • APA102 / DotStar.

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

Für chip:

  • led_strip_v2_bricklet.ChipTypeWS2801 = 2801
  • led_strip_v2_bricklet.ChipTypeWS2811 = 2811
  • led_strip_v2_bricklet.ChipTypeWS2812 = 2812
  • led_strip_v2_bricklet.ChipTypeLPD8806 = 8806
  • led_strip_v2_bricklet.ChipTypeAPA102 = 102
func (*LEDStripV2Bricklet) 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_v2_bricklet.ChipTypeWS2801 = 2801
  • led_strip_v2_bricklet.ChipTypeWS2811 = 2811
  • led_strip_v2_bricklet.ChipTypeWS2812 = 2812
  • led_strip_v2_bricklet.ChipTypeLPD8806 = 8806
  • led_strip_v2_bricklet.ChipTypeAPA102 = 102
func (*LEDStripV2Bricklet) 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 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.

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

Für mapping:

  • led_strip_v2_bricklet.ChannelMappingRGB = 6
  • led_strip_v2_bricklet.ChannelMappingRBG = 9
  • led_strip_v2_bricklet.ChannelMappingBRG = 33
  • led_strip_v2_bricklet.ChannelMappingBGR = 36
  • led_strip_v2_bricklet.ChannelMappingGRB = 18
  • led_strip_v2_bricklet.ChannelMappingGBR = 24
  • led_strip_v2_bricklet.ChannelMappingRGBW = 27
  • led_strip_v2_bricklet.ChannelMappingRGWB = 30
  • led_strip_v2_bricklet.ChannelMappingRBGW = 39
  • led_strip_v2_bricklet.ChannelMappingRBWG = 45
  • led_strip_v2_bricklet.ChannelMappingRWGB = 54
  • led_strip_v2_bricklet.ChannelMappingRWBG = 57
  • led_strip_v2_bricklet.ChannelMappingGRWB = 78
  • led_strip_v2_bricklet.ChannelMappingGRBW = 75
  • led_strip_v2_bricklet.ChannelMappingGBWR = 108
  • led_strip_v2_bricklet.ChannelMappingGBRW = 99
  • led_strip_v2_bricklet.ChannelMappingGWBR = 120
  • led_strip_v2_bricklet.ChannelMappingGWRB = 114
  • led_strip_v2_bricklet.ChannelMappingBRGW = 135
  • led_strip_v2_bricklet.ChannelMappingBRWG = 141
  • led_strip_v2_bricklet.ChannelMappingBGRW = 147
  • led_strip_v2_bricklet.ChannelMappingBGWR = 156
  • led_strip_v2_bricklet.ChannelMappingBWRG = 177
  • led_strip_v2_bricklet.ChannelMappingBWGR = 180
  • led_strip_v2_bricklet.ChannelMappingWRBG = 201
  • led_strip_v2_bricklet.ChannelMappingWRGB = 198
  • led_strip_v2_bricklet.ChannelMappingWGBR = 216
  • led_strip_v2_bricklet.ChannelMappingWGRB = 210
  • led_strip_v2_bricklet.ChannelMappingWBGR = 228
  • led_strip_v2_bricklet.ChannelMappingWBRG = 225
func (*LEDStripV2Bricklet) 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_v2_bricklet.ChannelMappingRGB = 6
  • led_strip_v2_bricklet.ChannelMappingRBG = 9
  • led_strip_v2_bricklet.ChannelMappingBRG = 33
  • led_strip_v2_bricklet.ChannelMappingBGR = 36
  • led_strip_v2_bricklet.ChannelMappingGRB = 18
  • led_strip_v2_bricklet.ChannelMappingGBR = 24
  • led_strip_v2_bricklet.ChannelMappingRGBW = 27
  • led_strip_v2_bricklet.ChannelMappingRGWB = 30
  • led_strip_v2_bricklet.ChannelMappingRBGW = 39
  • led_strip_v2_bricklet.ChannelMappingRBWG = 45
  • led_strip_v2_bricklet.ChannelMappingRWGB = 54
  • led_strip_v2_bricklet.ChannelMappingRWBG = 57
  • led_strip_v2_bricklet.ChannelMappingGRWB = 78
  • led_strip_v2_bricklet.ChannelMappingGRBW = 75
  • led_strip_v2_bricklet.ChannelMappingGBWR = 108
  • led_strip_v2_bricklet.ChannelMappingGBRW = 99
  • led_strip_v2_bricklet.ChannelMappingGWBR = 120
  • led_strip_v2_bricklet.ChannelMappingGWRB = 114
  • led_strip_v2_bricklet.ChannelMappingBRGW = 135
  • led_strip_v2_bricklet.ChannelMappingBRWG = 141
  • led_strip_v2_bricklet.ChannelMappingBGRW = 147
  • led_strip_v2_bricklet.ChannelMappingBGWR = 156
  • led_strip_v2_bricklet.ChannelMappingBWRG = 177
  • led_strip_v2_bricklet.ChannelMappingBWGR = 180
  • led_strip_v2_bricklet.ChannelMappingWRBG = 201
  • led_strip_v2_bricklet.ChannelMappingWRGB = 198
  • led_strip_v2_bricklet.ChannelMappingWGBR = 216
  • led_strip_v2_bricklet.ChannelMappingWGRB = 210
  • led_strip_v2_bricklet.ChannelMappingWBGR = 228
  • led_strip_v2_bricklet.ChannelMappingWBRG = 225

Fortgeschrittene Funktionen

func (*LEDStripV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Rückgabe:
  • errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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.

func (*LEDStripV2Bricklet) SetBootloaderMode(mode uint8) (status uint8, err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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:

  • led_strip_v2_bricklet.BootloaderModeBootloader = 0
  • led_strip_v2_bricklet.BootloaderModeFirmware = 1
  • led_strip_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • led_strip_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • led_strip_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

  • led_strip_v2_bricklet.BootloaderStatusOK = 0
  • led_strip_v2_bricklet.BootloaderStatusInvalidMode = 1
  • led_strip_v2_bricklet.BootloaderStatusNoChange = 2
  • led_strip_v2_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • led_strip_v2_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • led_strip_v2_bricklet.BootloaderStatusCRCMismatch = 5
func (*LEDStripV2Bricklet) GetBootloaderMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

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

Für mode:

  • led_strip_v2_bricklet.BootloaderModeBootloader = 0
  • led_strip_v2_bricklet.BootloaderModeFirmware = 1
  • led_strip_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • led_strip_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • led_strip_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*LEDStripV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Parameter:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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.

func (*LEDStripV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Parameter:
  • data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*LEDStripV2Bricklet) SetStatusLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

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:

  • led_strip_v2_bricklet.StatusLEDConfigOff = 0
  • led_strip_v2_bricklet.StatusLEDConfigOn = 1
  • led_strip_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • led_strip_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*LEDStripV2Bricklet) GetStatusLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für config:

  • led_strip_v2_bricklet.StatusLEDConfigOff = 0
  • led_strip_v2_bricklet.StatusLEDConfigOn = 1
  • led_strip_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • led_strip_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*LEDStripV2Bricklet) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
  • err – Typ: error

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.

func (*LEDStripV2Bricklet) Reset() (err error)
Rückgabe:
  • err – Typ: error

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.

func (*LEDStripV2Bricklet) WriteUID(uid uint32) (err error)
Parameter:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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.

func (*LEDStripV2Bricklet) ReadUID() (uid uint32, err error)
Rückgabe:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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

func (*LEDStripV2Bricklet) 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 (*LEDStripV2Bricklet) SetFrameStartedCallbackConfiguration(enable bool) (err error)
Parameter:
  • enable – Typ: bool, Standardwert: true
Rückgabe:
  • err – Typ: error

Aktiviert/deaktiviert den RegisterFrameStartedCallback Callback.

func (*LEDStripV2Bricklet) GetFrameStartedCallbackConfiguration() (enable bool, err error)
Rückgabe:
  • enable – Typ: bool, Standardwert: true
  • err – Typ: error

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

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 (*LEDStripV2Bricklet) RegisterFrameStartedCallback(func(length uint16)) (registrationId uint64)
Callback-Parameter:
  • length – Typ: uint16, Wertebereich: [0 bis 6144]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird direkt nachdem dem start eines Frames ausgelöst. Der Parameter des Callbacks 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().

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 (*LEDStripV2Bricklet) 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 (*LEDStripV2Bricklet) 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_v2_bricklet.FunctionSetLEDValues = 1
  • led_strip_v2_bricklet.FunctionSetFrameDuration = 3
  • led_strip_v2_bricklet.FunctionSetClockFrequency = 7
  • led_strip_v2_bricklet.FunctionSetChipType = 9
  • led_strip_v2_bricklet.FunctionSetChannelMapping = 11
  • led_strip_v2_bricklet.FunctionSetFrameStartedCallbackConfiguration = 13
  • led_strip_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • led_strip_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • led_strip_v2_bricklet.FunctionReset = 243
  • led_strip_v2_bricklet.FunctionWriteUID = 248
func (*LEDStripV2Bricklet) 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_v2_bricklet.FunctionSetLEDValues = 1
  • led_strip_v2_bricklet.FunctionSetFrameDuration = 3
  • led_strip_v2_bricklet.FunctionSetClockFrequency = 7
  • led_strip_v2_bricklet.FunctionSetChipType = 9
  • led_strip_v2_bricklet.FunctionSetChannelMapping = 11
  • led_strip_v2_bricklet.FunctionSetFrameStartedCallbackConfiguration = 13
  • led_strip_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • led_strip_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • led_strip_v2_bricklet.FunctionReset = 243
  • led_strip_v2_bricklet.FunctionWriteUID = 248
func (*LEDStripV2Bricklet) 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_v2_bricklet.DeviceIdentifier

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

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