C/C++ - RGB LED Matrix Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das RGB LED Matrix Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RGB LED Matrix 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).

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. 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 (wird seit 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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void rgb_led_matrix_create(RGBLEDMatrix *rgb_led_matrix, const char *uid, IPConnection *ipcon)

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

RGBLEDMatrix rgb_led_matrix;
rgb_led_matrix_create(&rgb_led_matrix, "YOUR_DEVICE_UID", &ipcon);

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

void rgb_led_matrix_destroy(RGBLEDMatrix *rgb_led_matrix)

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

int rgb_led_matrix_set_red(RGBLEDMatrix *rgb_led_matrix, uint8_t red[64])

Setzt die Werte der 64 roten LEDs der Matrix.

int rgb_led_matrix_get_red(RGBLEDMatrix *rgb_led_matrix, uint8_t ret_red[64])

Gibt die Werte der roten LED zurück, wie von rgb_led_matrix_set_red() gesetzt.

int rgb_led_matrix_set_green(RGBLEDMatrix *rgb_led_matrix, uint8_t green[64])

Setzt die Werte der 64 grünen LEDs der Matrix.

int rgb_led_matrix_get_green(RGBLEDMatrix *rgb_led_matrix, uint8_t ret_green[64])

Gibt die Werte der grünen LED zurück, wie von rgb_led_matrix_set_green() gesetzt.

int rgb_led_matrix_set_blue(RGBLEDMatrix *rgb_led_matrix, uint8_t blue[64])

Setzt die Werte der 64 blauen LEDs der Matrix.

int rgb_led_matrix_get_blue(RGBLEDMatrix *rgb_led_matrix, uint8_t ret_blue[64])

Gibt die Werte der blauen LED zurück, wie von rgb_led_matrix_set_blue() gesetzt.

int rgb_led_matrix_set_frame_duration(RGBLEDMatrix *rgb_led_matrix, uint16_t frame_duration)

Setzt die Frame Duration (Dauer des Frames) in ms.

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die Länge des Frames auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Setze diesen Wert auf 0 um das automatische schreiben der Frames auszustellen.

Vorgehensweise:

Für eine Frame Duration von 0 siehe rgb_led_matrix_draw_frame().

Standardwert: 0 = aus.

int rgb_led_matrix_get_frame_duration(RGBLEDMatrix *rgb_led_matrix, uint16_t *ret_frame_duration)

Gibt die Frame Duration (Dauer des Frames) in ms zurück, wie von rgb_led_matrix_set_frame_duration() gesetzt.

int rgb_led_matrix_draw_frame(RGBLEDMatrix *rgb_led_matrix)

Wenn die Frame Duration (Dauer des Frames) auf 0 gesetzt ist (siehe rgb_led_matrix_set_frame_duration()), dann kann diese Funktionen aufgerufen werden um den Frame auf die Matrix zu übertragen.

Vorgehensweise:

Fortgeschrittene Funktionen

int rgb_led_matrix_get_supply_voltage(RGBLEDMatrix *rgb_led_matrix, uint16_t *ret_voltage)

Gibt die aktuelle Versorgungsspannung des Bricklets zurück. Die Spannung ist in mV angegeben.

int rgb_led_matrix_get_api_version(RGBLEDMatrix *rgb_led_matrix, uint8_t ret_api_version[3])

Gibt die Version der API Definition (Major, Minor, Revision) 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 rgb_led_matrix_get_response_expected(RGBLEDMatrix *rgb_led_matrix, uint8_t function_id, bool *ret_response_expected)

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

  • RGB_LED_MATRIX_FUNCTION_SET_RED = 1
  • RGB_LED_MATRIX_FUNCTION_SET_GREEN = 3
  • RGB_LED_MATRIX_FUNCTION_SET_BLUE = 5
  • RGB_LED_MATRIX_FUNCTION_SET_FRAME_DURATION = 7
  • RGB_LED_MATRIX_FUNCTION_DRAW_FRAME = 9
  • RGB_LED_MATRIX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • RGB_LED_MATRIX_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • RGB_LED_MATRIX_FUNCTION_RESET = 243
  • RGB_LED_MATRIX_FUNCTION_WRITE_UID = 248
int rgb_led_matrix_set_response_expected(RGBLEDMatrix *rgb_led_matrix, uint8_t function_id, bool response_expected)

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

  • RGB_LED_MATRIX_FUNCTION_SET_RED = 1
  • RGB_LED_MATRIX_FUNCTION_SET_GREEN = 3
  • RGB_LED_MATRIX_FUNCTION_SET_BLUE = 5
  • RGB_LED_MATRIX_FUNCTION_SET_FRAME_DURATION = 7
  • RGB_LED_MATRIX_FUNCTION_DRAW_FRAME = 9
  • RGB_LED_MATRIX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • RGB_LED_MATRIX_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • RGB_LED_MATRIX_FUNCTION_RESET = 243
  • RGB_LED_MATRIX_FUNCTION_WRITE_UID = 248
int rgb_led_matrix_set_response_expected_all(RGBLEDMatrix *rgb_led_matrix, bool response_expected)

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

int rgb_led_matrix_get_spitfp_error_count(RGBLEDMatrix *rgb_led_matrix, 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)

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 rgb_led_matrix_set_bootloader_mode(RGBLEDMatrix *rgb_led_matrix, uint8_t mode, uint8_t *ret_status)

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

  • RGB_LED_MATRIX_BOOTLOADER_MODE_BOOTLOADER = 0
  • RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE = 1
  • RGB_LED_MATRIX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • RGB_LED_MATRIX_BOOTLOADER_STATUS_OK = 0
  • RGB_LED_MATRIX_BOOTLOADER_STATUS_INVALID_MODE = 1
  • RGB_LED_MATRIX_BOOTLOADER_STATUS_NO_CHANGE = 2
  • RGB_LED_MATRIX_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • RGB_LED_MATRIX_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • RGB_LED_MATRIX_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int rgb_led_matrix_get_bootloader_mode(RGBLEDMatrix *rgb_led_matrix, uint8_t *ret_mode)

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

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

  • RGB_LED_MATRIX_BOOTLOADER_MODE_BOOTLOADER = 0
  • RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE = 1
  • RGB_LED_MATRIX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • RGB_LED_MATRIX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int rgb_led_matrix_set_write_firmware_pointer(RGBLEDMatrix *rgb_led_matrix, uint32_t pointer)

Setzt den Firmware-Pointer für rgb_led_matrix_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 rgb_led_matrix_write_firmware(RGBLEDMatrix *rgb_led_matrix, uint8_t data[64], uint8_t *ret_status)

Schreibt 64 Bytes Firmware an die Position die vorher von rgb_led_matrix_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 rgb_led_matrix_set_status_led_config(RGBLEDMatrix *rgb_led_matrix, uint8_t config)

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:

  • RGB_LED_MATRIX_STATUS_LED_CONFIG_OFF = 0
  • RGB_LED_MATRIX_STATUS_LED_CONFIG_ON = 1
  • RGB_LED_MATRIX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • RGB_LED_MATRIX_STATUS_LED_CONFIG_SHOW_STATUS = 3
int rgb_led_matrix_get_status_led_config(RGBLEDMatrix *rgb_led_matrix, uint8_t *ret_config)

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

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

  • RGB_LED_MATRIX_STATUS_LED_CONFIG_OFF = 0
  • RGB_LED_MATRIX_STATUS_LED_CONFIG_ON = 1
  • RGB_LED_MATRIX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • RGB_LED_MATRIX_STATUS_LED_CONFIG_SHOW_STATUS = 3
int rgb_led_matrix_get_chip_temperature(RGBLEDMatrix *rgb_led_matrix, int16_t *ret_temperature)

Gibt die Temperatur in °C, 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 rgb_led_matrix_reset(RGBLEDMatrix *rgb_led_matrix)

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 rgb_led_matrix_write_uid(RGBLEDMatrix *rgb_led_matrix, uint32_t uid)

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 rgb_led_matrix_read_uid(RGBLEDMatrix *rgb_led_matrix, uint32_t *ret_uid)

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

int rgb_led_matrix_get_identity(RGBLEDMatrix *rgb_led_matrix, 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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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 rgb_led_matrix_register_callback(RGBLEDMatrix *rgb_led_matrix, int16_t callback_id, void (*function)(void), void *user_data)

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.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion rgb_led_matrix_register_callback() durchgeführt werden. Die Parameter bestehen aus dem Geräteobjekt, der Callback ID, der Callback Funktion und optionalen Benutzer Daten:

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

rgb_led_matrix_register_callback(&rgb_led_matrix, RGB_LED_MATRIX_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

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

RGB_LED_MATRIX_CALLBACK_FRAME_STARTED
void callback(uint32_t frame_number, void *user_data)

Dieser Callback wird aufgerufen sobald die Übertragung des Frames auf die Matrix beginnt. Die LED Werte werden in einem Doublebuffer gespeichert, so dass der nächste Frame an das Bricklet übertragen werden kann sobald dieser Callback ausgelöst wird.

Konstanten

RGB_LED_MATRIX_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RGB LED Matrix Bricklet zu identifizieren.

Die rgb_led_matrix_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.

RGB_LED_MATRIX_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RGB LED Matrix Bricklet dar.