Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / LED Strip Bricklet 2.0

C/C++ für Mikrocontroller - LED Strip Bricklet 2.0¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_led_strip_v2.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_LEDStripV2 ls;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_led_strip_v2_create(&ls, NULL, hal), "create device object");

    // Set first 3 LEDs to red, green and blue
    uint8_t value[9] = {255, 0, 0, 0, 255, 0, 0, 0, 255};
    check(tf_led_strip_v2_set_led_values(&ls, 0, value, 9), "call set_led_values");
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Callback¶

Download (example_callback.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_led_strip_v2.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

#define NUM_LEDS 16

static uint8_t rgb[NUM_LEDS * 3] = {0};
static uint16_t idx = 0;

static bool frame_started = false;
// Use frame started callback to trigger drawing the next frame.
static void frame_started_handler(TF_LEDStripV2 *device, uint16_t length, void *user_data) {
    (void)device; (void)length; (void)user_data; // avoid unused parameter warning

    frame_started = true;
}

static TF_LEDStripV2 ls;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_led_strip_v2_create(&ls, NULL, hal), "create device object");

    // Set frame duration to 50ms (20 frames per second)
    check(tf_led_strip_v2_set_frame_duration(&ls, 50), "call set_frame_duration");

    // Register frame started callback to function frame_started_handler
    tf_led_strip_v2_register_frame_started_callback(&ls,
                                                    frame_started_handler,
                                                    NULL);

    // Write one frame to trigger the frame started callback.
    tf_led_strip_v2_set_led_values(&ls, 0, rgb, NUM_LEDS * 3);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    // Polling with 0 will process one packet at most, so we can't miss a frame.
    tf_hal_callback_tick(hal, 0);
    if (!frame_started) {
        return;
    }

    frame_started = false;

    rgb[idx] = 0;
    idx += 3;
    if (idx >= NUM_LEDS * 3) {
        idx = 0;
    }
    rgb[idx] = 255;

    tf_led_strip_v2_set_led_values(&ls, 0, rgb, NUM_LEDS * 3);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_led_strip_v2_create(TF_LEDStripV2 *led_strip_v2, const char *uid, TF_HAL *hal)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt led_strip_v2 mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_LEDStripV2 led_strip_v2;
tf_led_strip_v2_create(&led_strip_v2, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_led_strip_v2_destroy(TF_LEDStripV2 *led_strip_v2)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
Rückgabe:	e_code – Typ: int

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

int tf_led_strip_v2_set_led_values(TF_LEDStripV2 *led_strip_v2, uint16_t index, const uint8_t *value, uint16_t value_length)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * index – Typ: uint16_t, Wertebereich: [0 bis 6144] value – Typ: const uint8_t , Wertebereich: [0 bis 255] value_length* – Typ: uint16_t
Rückgabe:	e_code – Typ: int

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 tf_led_strip_v2_set_chip_type()) und das richtige Channel Mapping (siehe tf_led_strip_v2_set_channel_mapping()) 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 tf_led_strip_v2_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 den Frame Started Callback.
Setze alle LEDs für den nächsten Frame.
Warte auf den Frame Started Callback.
Und so weiter.

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

int tf_led_strip_v2_get_led_values(TF_LEDStripV2 *led_strip_v2, uint16_t index, uint16_t length, uint8_t *ret_value, uint16_t *ret_value_length)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * index – Typ: uint16_t, Wertebereich: [0 bis 6144] length – Typ: uint16_t, Wertebereich: [0 bis 6144]
Ausgabeparameter:	ret_value – Typ: uint8_t , Wertebereich: [0 bis 255] ret_value_length* – Typ: uint16_t
Rückgabe:	e_code – Typ: int

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

int tf_led_strip_v2_set_frame_duration(TF_LEDStripV2 *led_strip_v2, uint16_t duration)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * 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 tf_led_strip_v2_set_led_values().

Standardwert: 100ms (10 Frames pro Sekunde).

int tf_led_strip_v2_get_frame_duration(TF_LEDStripV2 *led_strip_v2, uint16_t *ret_duration)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
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 tf_led_strip_v2_set_frame_duration() gesetzt.

int tf_led_strip_v2_get_supply_voltage(TF_LEDStripV2 *led_strip_v2, uint16_t *ret_voltage)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
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 tf_led_strip_v2_set_clock_frequency(TF_LEDStripV2 *led_strip_v2, uint32_t frequency)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * 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.

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

int tf_led_strip_v2_get_clock_frequency(TF_LEDStripV2 *led_strip_v2, uint32_t *ret_frequency)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
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 tf_led_strip_v2_set_clock_frequency() gesetzt.

int tf_led_strip_v2_set_chip_type(TF_LEDStripV2 *led_strip_v2, uint16_t chip)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * 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),
WS2813 / WS2815 (Chip Type = WS2812)
LPD8806 and
APA102 / DotStar.

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

Für chip:

TF_LED_STRIP_V2_CHIP_TYPE_WS2801 = 2801
TF_LED_STRIP_V2_CHIP_TYPE_WS2811 = 2811
TF_LED_STRIP_V2_CHIP_TYPE_WS2812 = 2812
TF_LED_STRIP_V2_CHIP_TYPE_LPD8806 = 8806
TF_LED_STRIP_V2_CHIP_TYPE_APA102 = 102

int tf_led_strip_v2_get_chip_type(TF_LEDStripV2 *led_strip_v2, uint16_t *ret_chip)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
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 tf_led_strip_v2_set_chip_type() gesetzt.

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

Für ret_chip:

TF_LED_STRIP_V2_CHIP_TYPE_WS2801 = 2801
TF_LED_STRIP_V2_CHIP_TYPE_WS2811 = 2811
TF_LED_STRIP_V2_CHIP_TYPE_WS2812 = 2812
TF_LED_STRIP_V2_CHIP_TYPE_LPD8806 = 8806
TF_LED_STRIP_V2_CHIP_TYPE_APA102 = 102

int tf_led_strip_v2_set_channel_mapping(TF_LEDStripV2 *led_strip_v2, uint8_t mapping)¶

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

Setzt das Channel Mapping für die angeschlossenen LEDs.

Falls das Mapping 4 Farben hat, erwartet die Funktion tf_led_strip_v2_set_led_values() 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:

TF_LED_STRIP_V2_CHANNEL_MAPPING_RGB = 6
TF_LED_STRIP_V2_CHANNEL_MAPPING_RBG = 9
TF_LED_STRIP_V2_CHANNEL_MAPPING_BRG = 33
TF_LED_STRIP_V2_CHANNEL_MAPPING_BGR = 36
TF_LED_STRIP_V2_CHANNEL_MAPPING_GRB = 18
TF_LED_STRIP_V2_CHANNEL_MAPPING_GBR = 24
TF_LED_STRIP_V2_CHANNEL_MAPPING_RGBW = 27
TF_LED_STRIP_V2_CHANNEL_MAPPING_RGWB = 30
TF_LED_STRIP_V2_CHANNEL_MAPPING_RBGW = 39
TF_LED_STRIP_V2_CHANNEL_MAPPING_RBWG = 45
TF_LED_STRIP_V2_CHANNEL_MAPPING_RWGB = 54
TF_LED_STRIP_V2_CHANNEL_MAPPING_RWBG = 57
TF_LED_STRIP_V2_CHANNEL_MAPPING_GRWB = 78
TF_LED_STRIP_V2_CHANNEL_MAPPING_GRBW = 75
TF_LED_STRIP_V2_CHANNEL_MAPPING_GBWR = 108
TF_LED_STRIP_V2_CHANNEL_MAPPING_GBRW = 99
TF_LED_STRIP_V2_CHANNEL_MAPPING_GWBR = 120
TF_LED_STRIP_V2_CHANNEL_MAPPING_GWRB = 114
TF_LED_STRIP_V2_CHANNEL_MAPPING_BRGW = 135
TF_LED_STRIP_V2_CHANNEL_MAPPING_BRWG = 141
TF_LED_STRIP_V2_CHANNEL_MAPPING_BGRW = 147
TF_LED_STRIP_V2_CHANNEL_MAPPING_BGWR = 156
TF_LED_STRIP_V2_CHANNEL_MAPPING_BWRG = 177
TF_LED_STRIP_V2_CHANNEL_MAPPING_BWGR = 180
TF_LED_STRIP_V2_CHANNEL_MAPPING_WRBG = 201
TF_LED_STRIP_V2_CHANNEL_MAPPING_WRGB = 198
TF_LED_STRIP_V2_CHANNEL_MAPPING_WGBR = 216
TF_LED_STRIP_V2_CHANNEL_MAPPING_WGRB = 210
TF_LED_STRIP_V2_CHANNEL_MAPPING_WBGR = 228
TF_LED_STRIP_V2_CHANNEL_MAPPING_WBRG = 225

int tf_led_strip_v2_get_channel_mapping(TF_LEDStripV2 *led_strip_v2, uint8_t *ret_mapping)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
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 tf_led_strip_v2_set_channel_mapping() gesetzt.

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

Für ret_mapping:

TF_LED_STRIP_V2_CHANNEL_MAPPING_RGB = 6
TF_LED_STRIP_V2_CHANNEL_MAPPING_RBG = 9
TF_LED_STRIP_V2_CHANNEL_MAPPING_BRG = 33
TF_LED_STRIP_V2_CHANNEL_MAPPING_BGR = 36
TF_LED_STRIP_V2_CHANNEL_MAPPING_GRB = 18
TF_LED_STRIP_V2_CHANNEL_MAPPING_GBR = 24
TF_LED_STRIP_V2_CHANNEL_MAPPING_RGBW = 27
TF_LED_STRIP_V2_CHANNEL_MAPPING_RGWB = 30
TF_LED_STRIP_V2_CHANNEL_MAPPING_RBGW = 39
TF_LED_STRIP_V2_CHANNEL_MAPPING_RBWG = 45
TF_LED_STRIP_V2_CHANNEL_MAPPING_RWGB = 54
TF_LED_STRIP_V2_CHANNEL_MAPPING_RWBG = 57
TF_LED_STRIP_V2_CHANNEL_MAPPING_GRWB = 78
TF_LED_STRIP_V2_CHANNEL_MAPPING_GRBW = 75
TF_LED_STRIP_V2_CHANNEL_MAPPING_GBWR = 108
TF_LED_STRIP_V2_CHANNEL_MAPPING_GBRW = 99
TF_LED_STRIP_V2_CHANNEL_MAPPING_GWBR = 120
TF_LED_STRIP_V2_CHANNEL_MAPPING_GWRB = 114
TF_LED_STRIP_V2_CHANNEL_MAPPING_BRGW = 135
TF_LED_STRIP_V2_CHANNEL_MAPPING_BRWG = 141
TF_LED_STRIP_V2_CHANNEL_MAPPING_BGRW = 147
TF_LED_STRIP_V2_CHANNEL_MAPPING_BGWR = 156
TF_LED_STRIP_V2_CHANNEL_MAPPING_BWRG = 177
TF_LED_STRIP_V2_CHANNEL_MAPPING_BWGR = 180
TF_LED_STRIP_V2_CHANNEL_MAPPING_WRBG = 201
TF_LED_STRIP_V2_CHANNEL_MAPPING_WRGB = 198
TF_LED_STRIP_V2_CHANNEL_MAPPING_WGBR = 216
TF_LED_STRIP_V2_CHANNEL_MAPPING_WGRB = 210
TF_LED_STRIP_V2_CHANNEL_MAPPING_WBGR = 228
TF_LED_STRIP_V2_CHANNEL_MAPPING_WBRG = 225

Fortgeschrittene Funktionen¶

int tf_led_strip_v2_get_spitfp_error_count(TF_LEDStripV2 *led_strip_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_led_strip_v2_set_status_led_config(TF_LEDStripV2 *led_strip_v2, uint8_t config)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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:

TF_LED_STRIP_V2_STATUS_LED_CONFIG_OFF = 0
TF_LED_STRIP_V2_STATUS_LED_CONFIG_ON = 1
TF_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_led_strip_v2_get_status_led_config(TF_LEDStripV2 *led_strip_v2, uint8_t *ret_config)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

TF_LED_STRIP_V2_STATUS_LED_CONFIG_OFF = 0
TF_LED_STRIP_V2_STATUS_LED_CONFIG_ON = 1
TF_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_led_strip_v2_get_chip_temperature(TF_LEDStripV2 *led_strip_v2, int16_t *ret_temperature)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_led_strip_v2_reset(TF_LEDStripV2 *led_strip_v2)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
Rückgabe:	e_code – Typ: int

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.

int tf_led_strip_v2_get_identity(TF_LEDStripV2 *led_strip_v2, 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_v2 – Typ: TF_LEDStripV2 *
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¶

int tf_led_strip_v2_set_frame_started_callback_configuration(TF_LEDStripV2 *led_strip_v2, bool enable)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * enable – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

Aktiviert/deaktiviert den Frame Started Callback.

int tf_led_strip_v2_get_frame_started_callback_configuration(TF_LEDStripV2 *led_strip_v2, bool *ret_enable)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
Ausgabeparameter:	ret_enable – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

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

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_led_strip_v2_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_led_strip_v2_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.

Warnung

Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.

int tf_led_strip_v2_register_frame_started_callback(TF_LEDStripV2 *led_strip_v2, TF_LEDStripV2_FrameStartedHandler handler, void *user_data)¶

void handler(TF_LEDStripV2 *led_strip_v2, uint16_t length, void *user_data)

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

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

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_led_strip_v2_get_response_expected(TF_LEDStripV2 *led_strip_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * 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 tf_led_strip_v2_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:

TF_LED_STRIP_V2_FUNCTION_SET_LED_VALUES = 1
TF_LED_STRIP_V2_FUNCTION_SET_FRAME_DURATION = 3
TF_LED_STRIP_V2_FUNCTION_SET_CLOCK_FREQUENCY = 7
TF_LED_STRIP_V2_FUNCTION_SET_CHIP_TYPE = 9
TF_LED_STRIP_V2_FUNCTION_SET_CHANNEL_MAPPING = 11
TF_LED_STRIP_V2_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
TF_LED_STRIP_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_LED_STRIP_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_LED_STRIP_V2_FUNCTION_RESET = 243
TF_LED_STRIP_V2_FUNCTION_WRITE_UID = 248

int tf_led_strip_v2_set_response_expected(TF_LEDStripV2 *led_strip_v2, uint8_t function_id, bool response_expected)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * 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:

TF_LED_STRIP_V2_FUNCTION_SET_LED_VALUES = 1
TF_LED_STRIP_V2_FUNCTION_SET_FRAME_DURATION = 3
TF_LED_STRIP_V2_FUNCTION_SET_CLOCK_FREQUENCY = 7
TF_LED_STRIP_V2_FUNCTION_SET_CHIP_TYPE = 9
TF_LED_STRIP_V2_FUNCTION_SET_CHANNEL_MAPPING = 11
TF_LED_STRIP_V2_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
TF_LED_STRIP_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_LED_STRIP_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_LED_STRIP_V2_FUNCTION_RESET = 243
TF_LED_STRIP_V2_FUNCTION_WRITE_UID = 248

int tf_led_strip_v2_set_response_expected_all(TF_LEDStripV2 *led_strip_v2, bool response_expected)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * 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.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int tf_led_strip_v2_set_bootloader_mode(TF_LEDStripV2 *led_strip_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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:

TF_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_LED_STRIP_V2_BOOTLOADER_STATUS_OK = 0
TF_LED_STRIP_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_LED_STRIP_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_LED_STRIP_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_LED_STRIP_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_LED_STRIP_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_led_strip_v2_get_bootloader_mode(TF_LEDStripV2 *led_strip_v2, uint8_t *ret_mode)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

TF_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_led_strip_v2_set_write_firmware_pointer(TF_LEDStripV2 *led_strip_v2, uint32_t pointer)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_led_strip_v2_write_firmware(). 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.

int tf_led_strip_v2_write_firmware(TF_LEDStripV2 *led_strip_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von tf_led_strip_v2_set_write_firmware_pointer() 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.

int tf_led_strip_v2_write_uid(TF_LEDStripV2 *led_strip_v2, uint32_t uid)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_led_strip_v2_read_uid(TF_LEDStripV2 *led_strip_v2, uint32_t *ret_uid)¶

Parameter:	led_strip_v2 – Typ: TF_LEDStripV2 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

Konstanten¶

TF_LED_STRIP_V2_DEVICE_IDENTIFIER¶

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

Die Funktionen tf_led_strip_v2_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

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