Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / DMX Bricklet

C/C++ für Mikrocontroller - DMX Bricklet¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das DMX Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DMX Bricklet 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_dmx.h"

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

static TF_DMX dmx;

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

    // Configure Bricklet as DMX master
    check(tf_dmx_set_dmx_mode(&dmx, TF_DMX_DMX_MODE_MASTER), "call set_dmx_mode");

    // Write DMX frame with 3 channels
    uint8_t frame[3] = {255, 128, 0};
    check(tf_dmx_write_frame(&dmx, frame, 3), "call write_frame");
}

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

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_dmx_create(TF_DMX *dmx, const char *uid, TF_HAL *hal)¶

Parameter:	dmx – Typ: TF_DMX * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_DMX dmx;
tf_dmx_create(&dmx, 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_dmx_destroy(TF_DMX *dmx)¶

Parameter:	dmx – Typ: TF_DMX *
Rückgabe:	e_code – Typ: int

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

int tf_dmx_set_dmx_mode(TF_DMX *dmx, uint8_t dmx_mode)¶

Parameter:	dmx – Typ: TF_DMX * dmx_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt den DMX Modus entweder auf Master oder Slave.

Ein Aufruf dieser Funktion setzt die Frame-Nummer auf 0.

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

Für dmx_mode:

TF_DMX_DMX_MODE_MASTER = 0
TF_DMX_DMX_MODE_SLAVE = 1

int tf_dmx_get_dmx_mode(TF_DMX *dmx, uint8_t *ret_dmx_mode)¶

Parameter:	dmx – Typ: TF_DMX *
Ausgabeparameter:	ret_dmx_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt den DMX Modus zurück, wie von tf_dmx_set_dmx_mode() gesetzt.

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

Für ret_dmx_mode:

TF_DMX_DMX_MODE_MASTER = 0
TF_DMX_DMX_MODE_SLAVE = 1

int tf_dmx_write_frame(TF_DMX *dmx, const uint8_t *frame, uint16_t frame_length)¶

Parameter:	dmx – Typ: TF_DMX * frame – Typ: const uint8_t , Wertebereich: [0 bis 255] frame_length* – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Schreibt einen DMX Frame. Die maximale Framegröße ist 512 Byte. Jedes Byte stellt dabei einen Kanal dar.

Das nächste Frame kann geschrieben werden nachdem der Frame Started Callback aufgerufen wurde. Das Frame verfügt über einen Doublebuffer, so dass ein neues Frame geschrieben werden kann, sobald das vorherige Frame geschrieben wurde.

Die Daten werden transferiert, wenn die nächste Frame Duration abgelaufen ist, siehe see tf_dmx_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 Kanäle für den ersten Frame.
Warte auf Frame Started Callback.
Setze alle Kanäle für den nächsten Frame.
Warte auf Frame Started Callback.
Und so weiter.

Dieser Ansatz garantiert, dass DMX Daten mit einer festen Framerate gesetzt werden.

Diese Funktion kann nur im Master Modus aufgerufen werden.

int tf_dmx_read_frame(TF_DMX *dmx, uint8_t *ret_frame, uint16_t *ret_frame_length, uint32_t *ret_frame_number)¶

Parameter:	dmx – Typ: TF_DMX *
Ausgabeparameter:	ret_frame – Typ: uint8_t , Wertebereich: [0 bis 255] ret_frame_length* – Typ: uint16_t ret_frame_number – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt das letzte Frame zurück, dass von dem DMX Master geschrieben wurde. Die Größe des Arrays ist identisch zu der Anzahl der Kanäle im Frame. Jedes Byte repräsentiert ein Kanal.

Das nächste Frame ist verfügbar nachdem der Frame Available Callback aufgerufen wurde.

Genereller Ansatz:

Aufruf von tf_dmx_read_frame() um das erste Frame zu bekommen.
Warten auf den Frame Available Callback.
Aufruf von tf_dmx_read_frame() um das zweite Frame zu bekommen.
Warten auf den Frame Available Callback.
Und so weiter.

Anstatt das diese Funktion gepollt wird, kann auch der Frame Low Level Callback genutzt werden. Der Callback kann mit tf_dmx_set_frame_callback_config() aktiviert werden.

Die frame number startet mit 0 und wird für jedes empfangene Frame erhöht.

Diese Funktion kann nur im Slave Modus aufgerufen werden.

int tf_dmx_set_frame_duration(TF_DMX *dmx, uint16_t frame_duration)¶

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

Setzt die Dauer eines Frames.

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die frame duration auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Soll jeweils ein Frame so schnell wie möglich gesendet werden, so sollte die frame duration auf 0 gesetzt werden.

Diese Einstellung wird nur im Master Modus genutzt.

int tf_dmx_get_frame_duration(TF_DMX *dmx, uint16_t *ret_frame_duration)¶

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

Gibt die Frame duration zurück die mittels tf_dmx_set_frame_duration() gesetzt wurde.

Fortgeschrittene Funktionen¶

int tf_dmx_get_frame_error_count(TF_DMX *dmx, uint32_t *ret_overrun_error_count, uint32_t *ret_framing_error_count)¶

Parameter:	dmx – Typ: TF_DMX *
Ausgabeparameter:	ret_overrun_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_framing_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Anzahl an Overrun und Framing Fehlern zurück.

int tf_dmx_set_communication_led_config(TF_DMX *dmx, uint8_t config)¶

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

Setzt die Konfiguration der Kommunikations-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 Bootloadermodus befindet ist die LED aus.

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

Für config:

TF_DMX_COMMUNICATION_LED_CONFIG_OFF = 0
TF_DMX_COMMUNICATION_LED_CONFIG_ON = 1
TF_DMX_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_dmx_get_communication_led_config(TF_DMX *dmx, uint8_t *ret_config)¶

Parameter:	dmx – Typ: TF_DMX *
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_dmx_set_communication_led_config() gesetzt.

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

Für ret_config:

TF_DMX_COMMUNICATION_LED_CONFIG_OFF = 0
TF_DMX_COMMUNICATION_LED_CONFIG_ON = 1
TF_DMX_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_dmx_set_error_led_config(TF_DMX *dmx, uint8_t config)¶

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

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe Frame Error Count Callback). Wenn diese Funktion danach nochmal mit der Show-Error-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

TF_DMX_ERROR_LED_CONFIG_OFF = 0
TF_DMX_ERROR_LED_CONFIG_ON = 1
TF_DMX_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_dmx_get_error_led_config(TF_DMX *dmx, uint8_t *ret_config)¶

Parameter:	dmx – Typ: TF_DMX *
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_dmx_set_error_led_config() gesetzt.

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

Für ret_config:

TF_DMX_ERROR_LED_CONFIG_OFF = 0
TF_DMX_ERROR_LED_CONFIG_ON = 1
TF_DMX_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_dmx_get_spitfp_error_count(TF_DMX *dmx, 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:	dmx – Typ: TF_DMX *
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_dmx_set_status_led_config(TF_DMX *dmx, uint8_t config)¶

Parameter:	dmx – Typ: TF_DMX * 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_DMX_STATUS_LED_CONFIG_OFF = 0
TF_DMX_STATUS_LED_CONFIG_ON = 1
TF_DMX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_dmx_get_status_led_config(TF_DMX *dmx, uint8_t *ret_config)¶

Parameter:	dmx – Typ: TF_DMX *
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_dmx_set_status_led_config() gesetzt.

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

Für ret_config:

TF_DMX_STATUS_LED_CONFIG_OFF = 0
TF_DMX_STATUS_LED_CONFIG_ON = 1
TF_DMX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_dmx_get_chip_temperature(TF_DMX *dmx, int16_t *ret_temperature)¶

Parameter:	dmx – Typ: TF_DMX *
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_dmx_reset(TF_DMX *dmx)¶

Parameter:	dmx – Typ: TF_DMX *
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_dmx_get_identity(TF_DMX *dmx, 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:	dmx – Typ: TF_DMX *
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_dmx_set_frame_callback_config(TF_DMX *dmx, bool frame_started_callback_enabled, bool frame_available_callback_enabled, bool frame_callback_enabled, bool frame_error_count_callback_enabled)¶

Parameter:	dmx – Typ: TF_DMX * frame_started_callback_enabled – Typ: bool, Standardwert: true frame_available_callback_enabled – Typ: bool, Standardwert: true frame_callback_enabled – Typ: bool, Standardwert: false frame_error_count_callback_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert/Deaktiviert die verschiedenen Callback. Standardmäßig sind der Frame Started Callback und der Frame Available Callback aktiviert, während der Frame Low Level Callback und der Frame Error Count Callback deaktiviert sind.

Wenn der Frame Low Level Callback aktiviert wird dann kann der Frame Available Callback deaktiviert werden, da dieser dann redundant ist.

int tf_dmx_get_frame_callback_config(TF_DMX *dmx, bool *ret_frame_started_callback_enabled, bool *ret_frame_available_callback_enabled, bool *ret_frame_callback_enabled, bool *ret_frame_error_count_callback_enabled)¶

Parameter:	dmx – Typ: TF_DMX *
Ausgabeparameter:	ret_frame_started_callback_enabled – Typ: bool, Standardwert: true ret_frame_available_callback_enabled – Typ: bool, Standardwert: true ret_frame_callback_enabled – Typ: bool, Standardwert: false ret_frame_error_count_callback_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Frame Callback Konfiguration zurück, wie von tf_dmx_set_frame_callback_config() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_dmx_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_dmx_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_dmx_register_frame_started_callback(TF_DMX *dmx, TF_DMX_FrameStartedHandler handler, void *user_data)¶

void handler(TF_DMX *dmx, void *user_data)

Callback-Parameter:	dmx – Typ: TF_DMX * user_data – Typ: void *

Dieser Callback wird ausgelöst sobald ein neuer Frame gestartet wurde. Nachdem dieser Callback empfangen wurde sollten die Daten für den nächsten Frame geschrieben werden.

Für eine Erklärung siehe die Beschreibung in der Funktion tf_dmx_write_frame().

Der Callback kann mittels tf_dmx_set_frame_callback_config() aktiviert werden.

Dieser Callback wird nur im Master Modus ausgelöst.

int tf_dmx_register_frame_available_callback(TF_DMX *dmx, TF_DMX_FrameAvailableHandler handler, void *user_data)¶

void handler(TF_DMX *dmx, uint32_t frame_number, void *user_data)

Callback-Parameter:	dmx – Typ: TF_DMX * frame_number – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] user_data – Typ: void *

Dieser Callback wird im Slave Modus ausgelöst, wenn ein neuer Frame vom DMX Master empfangen wurde und nun ausgelesen werden kann. Der Frame muss ausgelesen werden, bevor der Master ein neues Frame schreibt. Siehe tf_dmx_read_frame() für weitere Details.

Der Parameter ist die Frame-Nummer, diese wird für jeden empfangenen Frame um eins erhöht.

Der Callback kann mittels tf_dmx_set_frame_callback_config() aktiviert werden.

Dieser Callback kann nur im Slave Modus ausgelöst werden.

int tf_dmx_register_frame_low_level_callback(TF_DMX *dmx, TF_DMX_FrameLowLevelHandler handler, void *user_data)¶

void handler(TF_DMX *dmx, uint16_t frame_length, uint16_t frame_chunk_offset, uint8_t frame_chunk_data[56], uint32_t frame_number, void *user_data)

Callback-Parameter:	dmx – Typ: TF_DMX * frame_length – Typ: uint16_t, Wertebereich: [0 bis 2⁹] frame_chunk_offset – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] frame_chunk_data – Typ: uint8_t[56], Wertebereich: [0 bis 255] frame_number – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] user_data – Typ: void *

Dieser Callback wird aufgerufen sobald ein neuer Frame verfügbar ist (vom DMX Master geschrieben).

Die Größe des Arrays ist gleichbedeutend zu der Anzahl an Kanälen in dem Frame. Jedes Byte stellt einen Kanal dar.

Der Callback kann mittels tf_dmx_set_frame_callback_config() aktiviert werden.

Dieser Callback kann nur im Slave Modus ausgelöst werden.

int tf_dmx_register_frame_error_count_callback(TF_DMX *dmx, TF_DMX_FrameErrorCountHandler handler, void *user_data)¶

void handler(TF_DMX *dmx, uint32_t overrun_error_count, uint32_t framing_error_count, void *user_data)

Callback-Parameter:	dmx – Typ: TF_DMX * overrun_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] framing_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] user_data – Typ: void *

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Framing Fehler zurück.

Virtuelle Funktionen¶

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

int tf_dmx_get_response_expected(TF_DMX *dmx, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	dmx – Typ: TF_DMX * 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_dmx_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_DMX_FUNCTION_SET_DMX_MODE = 1
TF_DMX_FUNCTION_WRITE_FRAME = 3
TF_DMX_FUNCTION_SET_FRAME_DURATION = 5
TF_DMX_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
TF_DMX_FUNCTION_SET_ERROR_LED_CONFIG = 10
TF_DMX_FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
TF_DMX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_DMX_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_DMX_FUNCTION_RESET = 243
TF_DMX_FUNCTION_WRITE_UID = 248

int tf_dmx_set_response_expected(TF_DMX *dmx, uint8_t function_id, bool response_expected)¶

Parameter:	dmx – Typ: TF_DMX * 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_DMX_FUNCTION_SET_DMX_MODE = 1
TF_DMX_FUNCTION_WRITE_FRAME = 3
TF_DMX_FUNCTION_SET_FRAME_DURATION = 5
TF_DMX_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
TF_DMX_FUNCTION_SET_ERROR_LED_CONFIG = 10
TF_DMX_FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
TF_DMX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_DMX_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_DMX_FUNCTION_RESET = 243
TF_DMX_FUNCTION_WRITE_UID = 248

int tf_dmx_set_response_expected_all(TF_DMX *dmx, bool response_expected)¶

Parameter:	dmx – Typ: TF_DMX * 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_dmx_set_bootloader_mode(TF_DMX *dmx, uint8_t mode, uint8_t *ret_status)¶

Parameter:	dmx – Typ: TF_DMX * 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_DMX_BOOTLOADER_MODE_BOOTLOADER = 0
TF_DMX_BOOTLOADER_MODE_FIRMWARE = 1
TF_DMX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_DMX_BOOTLOADER_STATUS_OK = 0
TF_DMX_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_DMX_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_DMX_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_DMX_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_DMX_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_dmx_get_bootloader_mode(TF_DMX *dmx, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_DMX_BOOTLOADER_MODE_BOOTLOADER = 0
TF_DMX_BOOTLOADER_MODE_FIRMWARE = 1
TF_DMX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_dmx_set_write_firmware_pointer(TF_DMX *dmx, uint32_t pointer)¶

Parameter:	dmx – Typ: TF_DMX * 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_dmx_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_dmx_write_firmware(TF_DMX *dmx, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	dmx – Typ: TF_DMX * 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_dmx_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_dmx_write_uid(TF_DMX *dmx, uint32_t uid)¶

Parameter:	dmx – Typ: TF_DMX * 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_dmx_read_uid(TF_DMX *dmx, uint32_t *ret_uid)¶

Parameter:	dmx – Typ: TF_DMX *
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_DMX_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein DMX Bricklet zu identifizieren.

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

TF_DMX_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines DMX Bricklet dar.