C/C++ - LED Strip Bricklet¶

Dies ist die Beschreibung der C/C++ 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 C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_led_strip.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your LED Strip Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    LEDStrip ls;
    led_strip_create(&ls, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Set first 10 LEDs to green
    uint8_t r[16] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
    uint8_t g[16] = {255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0};
    uint8_t b[16] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
    led_strip_set_rgb_values(&ls, 0, 10, r, g, b);

    printf("Press key to exit\n");
    getchar();
    led_strip_destroy(&ls);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_led_strip.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your LED Strip Bricklet
#define NUM_LEDS 16

uint8_t r[NUM_LEDS] = {0};
uint8_t g[NUM_LEDS] = {0};
uint8_t b[NUM_LEDS] = {0};
uint8_t r_index = 0;

// Use frame rendered callback to move the active LED every frame
void cb_frame_rendered(uint16_t length, void *user_data) {
    (void)length; // avoid unused parameter warning

    LEDStrip *ls = (LEDStrip *)user_data;

    b[r_index] = 0;

    if(r_index == NUM_LEDS-1) {
        r_index = 0;
    } else {
        r_index++;
    }

    b[r_index] = 255;

    // Set new data for next render cycle
    led_strip_set_rgb_values(ls, 0, NUM_LEDS, r, g, b);
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    LEDStrip ls;
    led_strip_create(&ls, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Set frame duration to 50ms (20 frames per second)
    led_strip_set_frame_duration(&ls, 50);

    // Register frame rendered callback to function cb_frame_rendered
    led_strip_register_callback(&ls,
                                LED_STRIP_CALLBACK_FRAME_RENDERED,
                                (void (*)(void))cb_frame_rendered,
                                &ls);

    // Set initial rgb values to get started
    led_strip_set_rgb_values(&ls, 0, NUM_LEDS, r, g, b);

    printf("Press key to exit\n");
    getchar();
    led_strip_destroy(&ls);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

E_OK = 0
E_TIMEOUT = -1
E_NO_STREAM_SOCKET = -2
E_HOSTNAME_INVALID = -3
E_NO_CONNECT = -4
E_NO_THREAD = -5
E_NOT_ADDED = -6 (seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
E_ALREADY_CONNECTED = -7
E_NOT_CONNECTED = -8
E_INVALID_PARAMETER = -9
E_NOT_SUPPORTED = -10
E_UNKNOWN_ERROR_CODE = -11
E_STREAM_OUT_OF_SYNC = -12
E_INVALID_UID = -13
E_NON_ASCII_CHAR_IN_SECRET = -14
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void led_strip_create(LEDStrip *led_strip, const char *uid, IPConnection *ipcon)¶

Parameter:	led_strip – Typ: LEDStrip * uid – Typ: const char * ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt led_strip mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

LEDStrip led_strip;
led_strip_create(&led_strip, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void led_strip_destroy(LEDStrip *led_strip)¶

Parameter:	led_strip – Typ: LEDStrip *

Entfernt das Geräteobjekt led_strip von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int led_strip_set_rgb_values(LEDStrip *led_strip, uint16_t index, uint8_t length, uint8_t r[16], uint8_t g[16], uint8_t b[16])¶

Parameter:	led_strip – Typ: LEDStrip * index – Typ: uint16_t, Wertebereich: [0 bis 319] length – Typ: uint8_t, Wertebereich: [0 bis 16] r – Typ: uint8_t[16], Wertebereich: [0 bis 255] g – Typ: uint8_t[16], Wertebereich: [0 bis 255] b – Typ: uint8_t[16], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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 (led_strip_set_chip_type()) und das richtige 3-Kanal Channel Mapping (led_strip_set_channel_mapping()) 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 led_strip_set_frame_duration().

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 LED_STRIP_CALLBACK_FRAME_RENDERED Callback.
Setze alle LEDs für den nächsten Frame.
Warte auf LED_STRIP_CALLBACK_FRAME_RENDERED 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 led_strip_set_rgb_values() mit index + length größer als die Begrenzung werden komplett ingnoriert.

int led_strip_get_rgb_values(LEDStrip *led_strip, uint16_t index, uint8_t length, uint8_t ret_r[16], uint8_t ret_g[16], uint8_t ret_b[16])¶

Parameter:	led_strip – Typ: LEDStrip * index – Typ: uint16_t, Wertebereich: [0 bis 319] length – Typ: uint8_t, Wertebereich: [0 bis 16]
Ausgabeparameter:	ret_r – Typ: uint8_t[16], Wertebereich: [0 bis 255] ret_g – Typ: uint8_t[16], Wertebereich: [0 bis 255] ret_b – Typ: uint8_t[16], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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

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

int led_strip_set_frame_duration(LEDStrip *led_strip, uint16_t duration)¶

Parameter:	led_strip – Typ: LEDStrip * duration – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

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

int led_strip_get_frame_duration(LEDStrip *led_strip, uint16_t *ret_duration)¶

Parameter:	led_strip – Typ: LEDStrip *
Ausgabeparameter:	ret_duration – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

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

int led_strip_get_supply_voltage(LEDStrip *led_strip, uint16_t *ret_voltage)¶

Parameter:	led_strip – Typ: LEDStrip *
Ausgabeparameter:	ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

int led_strip_set_clock_frequency(LEDStrip *led_strip, uint32_t frequency)¶

Parameter:	led_strip – Typ: LEDStrip * frequency – Typ: uint32_t, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666
Rückgabe:	e_code – Typ: int

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

Added in version 2.0.1$nbsp;(Plugin).

int led_strip_get_clock_frequency(LEDStrip *led_strip, uint32_t *ret_frequency)¶

Parameter:	led_strip – Typ: LEDStrip *
Ausgabeparameter:	ret_frequency – Typ: uint32_t, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666
Rückgabe:	e_code – Typ: int

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

Added in version 2.0.1$nbsp;(Plugin).

int led_strip_set_chip_type(LEDStrip *led_strip, uint16_t chip)¶

Parameter:	led_strip – Typ: LEDStrip * chip – Typ: uint16_t, Wertebereich: Siehe Konstanten, Standardwert: 2801
Rückgabe:	e_code – Typ: int

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_CHIP_TYPE_WS2801 = 2801
LED_STRIP_CHIP_TYPE_WS2811 = 2811
LED_STRIP_CHIP_TYPE_WS2812 = 2812
LED_STRIP_CHIP_TYPE_LPD8806 = 8806
LED_STRIP_CHIP_TYPE_APA102 = 102

Added in version 2.0.2$nbsp;(Plugin).

int led_strip_get_chip_type(LEDStrip *led_strip, uint16_t *ret_chip)¶

Parameter:	led_strip – Typ: LEDStrip *
Ausgabeparameter:	ret_chip – Typ: uint16_t, Wertebereich: Siehe Konstanten, Standardwert: 2801
Rückgabe:	e_code – Typ: int

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

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

Für ret_chip:

LED_STRIP_CHIP_TYPE_WS2801 = 2801
LED_STRIP_CHIP_TYPE_WS2811 = 2811
LED_STRIP_CHIP_TYPE_WS2812 = 2812
LED_STRIP_CHIP_TYPE_LPD8806 = 8806
LED_STRIP_CHIP_TYPE_APA102 = 102

Added in version 2.0.2$nbsp;(Plugin).

int led_strip_set_rgbw_values(LEDStrip *led_strip, uint16_t index, uint8_t length, uint8_t r[12], uint8_t g[12], uint8_t b[12], uint8_t w[12])¶

Parameter:	led_strip – Typ: LEDStrip * index – Typ: uint16_t, Wertebereich: [0 bis 239] length – Typ: uint8_t, Wertebereich: [0 bis 12] r – Typ: uint8_t[12], Wertebereich: [0 bis 255] g – Typ: uint8_t[12], Wertebereich: [0 bis 255] b – Typ: uint8_t[12], Wertebereich: [0 bis 255] w – Typ: uint8_t[12], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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 (led_strip_set_chip_type()) und das richtige 4-Kanal Channel Mapping (led_strip_set_channel_mapping()) 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 led_strip_set_frame_duration().

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

Added in version 2.0.6$nbsp;(Plugin).

int led_strip_get_rgbw_values(LEDStrip *led_strip, uint16_t index, uint8_t length, uint8_t ret_r[12], uint8_t ret_g[12], uint8_t ret_b[12], uint8_t ret_w[12])¶

Parameter:	led_strip – Typ: LEDStrip * index – Typ: uint16_t, Wertebereich: [0 bis 239] length – Typ: uint8_t, Wertebereich: [0 bis 12]
Ausgabeparameter:	ret_r – Typ: uint8_t[12], Wertebereich: [0 bis 255] ret_g – Typ: uint8_t[12], Wertebereich: [0 bis 255] ret_b – Typ: uint8_t[12], Wertebereich: [0 bis 255] ret_w – Typ: uint8_t[12], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Gibt length RGBW Werte zurück, beginnend vom übergebenen index.

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

Added in version 2.0.6$nbsp;(Plugin).

int led_strip_set_channel_mapping(LEDStrip *led_strip, uint8_t mapping)¶

Parameter:	led_strip – Typ: LEDStrip * mapping – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 36
Rückgabe:	e_code – Typ: int

Setzt das Channel Mapping für die angeschlossenene LEDs.

led_strip_set_rgb_values() und led_strip_set_rgbw_values() 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 led_strip_set_rgb_values() für das setzen der Farben verwendet werden. led_strip_set_rgbw_values() zusammen mit einem 3-Kanal Mapping führt zu falscher Darstellung der Farben. Im Gegenzug muss bei einem 4-Kanal Mapping led_strip_set_rgbw_values() für das setzen der Farben verwendet werden. led_strip_set_rgb_values() 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_CHANNEL_MAPPING_RGB = 6
LED_STRIP_CHANNEL_MAPPING_RBG = 9
LED_STRIP_CHANNEL_MAPPING_BRG = 33
LED_STRIP_CHANNEL_MAPPING_BGR = 36
LED_STRIP_CHANNEL_MAPPING_GRB = 18
LED_STRIP_CHANNEL_MAPPING_GBR = 24
LED_STRIP_CHANNEL_MAPPING_RGBW = 27
LED_STRIP_CHANNEL_MAPPING_RGWB = 30
LED_STRIP_CHANNEL_MAPPING_RBGW = 39
LED_STRIP_CHANNEL_MAPPING_RBWG = 45
LED_STRIP_CHANNEL_MAPPING_RWGB = 54
LED_STRIP_CHANNEL_MAPPING_RWBG = 57
LED_STRIP_CHANNEL_MAPPING_GRWB = 78
LED_STRIP_CHANNEL_MAPPING_GRBW = 75
LED_STRIP_CHANNEL_MAPPING_GBWR = 108
LED_STRIP_CHANNEL_MAPPING_GBRW = 99
LED_STRIP_CHANNEL_MAPPING_GWBR = 120
LED_STRIP_CHANNEL_MAPPING_GWRB = 114
LED_STRIP_CHANNEL_MAPPING_BRGW = 135
LED_STRIP_CHANNEL_MAPPING_BRWG = 141
LED_STRIP_CHANNEL_MAPPING_BGRW = 147
LED_STRIP_CHANNEL_MAPPING_BGWR = 156
LED_STRIP_CHANNEL_MAPPING_BWRG = 177
LED_STRIP_CHANNEL_MAPPING_BWGR = 180
LED_STRIP_CHANNEL_MAPPING_WRBG = 201
LED_STRIP_CHANNEL_MAPPING_WRGB = 198
LED_STRIP_CHANNEL_MAPPING_WGBR = 216
LED_STRIP_CHANNEL_MAPPING_WGRB = 210
LED_STRIP_CHANNEL_MAPPING_WBGR = 228
LED_STRIP_CHANNEL_MAPPING_WBRG = 225

Added in version 2.0.6$nbsp;(Plugin).

int led_strip_get_channel_mapping(LEDStrip *led_strip, uint8_t *ret_mapping)¶

Parameter:	led_strip – Typ: LEDStrip *
Ausgabeparameter:	ret_mapping – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 36
Rückgabe:	e_code – Typ: int

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

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

Für ret_mapping:

LED_STRIP_CHANNEL_MAPPING_RGB = 6
LED_STRIP_CHANNEL_MAPPING_RBG = 9
LED_STRIP_CHANNEL_MAPPING_BRG = 33
LED_STRIP_CHANNEL_MAPPING_BGR = 36
LED_STRIP_CHANNEL_MAPPING_GRB = 18
LED_STRIP_CHANNEL_MAPPING_GBR = 24
LED_STRIP_CHANNEL_MAPPING_RGBW = 27
LED_STRIP_CHANNEL_MAPPING_RGWB = 30
LED_STRIP_CHANNEL_MAPPING_RBGW = 39
LED_STRIP_CHANNEL_MAPPING_RBWG = 45
LED_STRIP_CHANNEL_MAPPING_RWGB = 54
LED_STRIP_CHANNEL_MAPPING_RWBG = 57
LED_STRIP_CHANNEL_MAPPING_GRWB = 78
LED_STRIP_CHANNEL_MAPPING_GRBW = 75
LED_STRIP_CHANNEL_MAPPING_GBWR = 108
LED_STRIP_CHANNEL_MAPPING_GBRW = 99
LED_STRIP_CHANNEL_MAPPING_GWBR = 120
LED_STRIP_CHANNEL_MAPPING_GWRB = 114
LED_STRIP_CHANNEL_MAPPING_BRGW = 135
LED_STRIP_CHANNEL_MAPPING_BRWG = 141
LED_STRIP_CHANNEL_MAPPING_BGRW = 147
LED_STRIP_CHANNEL_MAPPING_BGWR = 156
LED_STRIP_CHANNEL_MAPPING_BWRG = 177
LED_STRIP_CHANNEL_MAPPING_BWGR = 180
LED_STRIP_CHANNEL_MAPPING_WRBG = 201
LED_STRIP_CHANNEL_MAPPING_WRGB = 198
LED_STRIP_CHANNEL_MAPPING_WGBR = 216
LED_STRIP_CHANNEL_MAPPING_WGRB = 210
LED_STRIP_CHANNEL_MAPPING_WBGR = 228
LED_STRIP_CHANNEL_MAPPING_WBRG = 225

Added in version 2.0.6$nbsp;(Plugin).

Fortgeschrittene Funktionen¶

int led_strip_get_identity(LEDStrip *led_strip, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶

Parameter:	led_strip – Typ: LEDStrip *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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¶

void led_strip_register_callback(LEDStrip *led_strip, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	led_strip – Typ: LEDStrip * callback_id – Typ: int16_t function – Typ: void ()(void) user_data* – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int led_strip_enable_frame_rendered_callback(LEDStrip *led_strip)¶

Parameter:	led_strip – Typ: LEDStrip *
Rückgabe:	e_code – Typ: int

Aktiviert den LED_STRIP_CALLBACK_FRAME_RENDERED Callback.

Standardmäßig ist der Callback aktiviert.

Added in version 2.0.6$nbsp;(Plugin).

int led_strip_disable_frame_rendered_callback(LEDStrip *led_strip)¶

Parameter:	led_strip – Typ: LEDStrip *
Rückgabe:	e_code – Typ: int

Deaktiviert den LED_STRIP_CALLBACK_FRAME_RENDERED Callback.

Standardmäßig ist der Callback aktiviert.

Added in version 2.0.6$nbsp;(Plugin).

int led_strip_is_frame_rendered_callback_enabled(LEDStrip *led_strip, bool *ret_enabled)¶

Parameter:	led_strip – Typ: LEDStrip *
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

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

Added in version 2.0.6$nbsp;(Plugin).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der led_strip_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

led_strip_register_callback(&led_strip,
                            LED_STRIP_CALLBACK_EXAMPLE,
                            (void (*)(void))my_callback,
                            NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen 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.

LED_STRIP_CALLBACK_FRAME_RENDERED¶

void callback(uint16_t length, void *user_data)

Callback-Parameter:	length – Typ: uint16_t, Wertebereich: [0 bis 320] user_data – Typ: void *

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

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.

int led_strip_get_api_version(LEDStrip *led_strip, uint8_t ret_api_version[3])¶

Parameter:	led_strip – Typ: LEDStrip *
Ausgabeparameter:	ret_api_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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.

int led_strip_get_response_expected(LEDStrip *led_strip, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	led_strip – Typ: LEDStrip * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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 led_strip_set_response_expected(). 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 function_id:

LED_STRIP_FUNCTION_SET_RGB_VALUES = 1
LED_STRIP_FUNCTION_SET_FRAME_DURATION = 3
LED_STRIP_FUNCTION_SET_CLOCK_FREQUENCY = 7
LED_STRIP_FUNCTION_SET_CHIP_TYPE = 9
LED_STRIP_FUNCTION_SET_RGBW_VALUES = 11
LED_STRIP_FUNCTION_SET_CHANNEL_MAPPING = 13
LED_STRIP_FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
LED_STRIP_FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16

int led_strip_set_response_expected(LEDStrip *led_strip, uint8_t function_id, bool response_expected)¶

Parameter:	led_strip – Typ: LEDStrip * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

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

Für function_id:

LED_STRIP_FUNCTION_SET_RGB_VALUES = 1
LED_STRIP_FUNCTION_SET_FRAME_DURATION = 3
LED_STRIP_FUNCTION_SET_CLOCK_FREQUENCY = 7
LED_STRIP_FUNCTION_SET_CHIP_TYPE = 9
LED_STRIP_FUNCTION_SET_RGBW_VALUES = 11
LED_STRIP_FUNCTION_SET_CHANNEL_MAPPING = 13
LED_STRIP_FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
LED_STRIP_FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16

int led_strip_set_response_expected_all(LEDStrip *led_strip, bool response_expected)¶

Parameter:	led_strip – Typ: LEDStrip * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

Konstanten¶

LED_STRIP_DEVICE_IDENTIFIER¶

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

Die led_strip_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

LED_STRIP_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet dar.