Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / Industrial Digital Out 4 Bricklet 2.0

C/C++ für Mikrocontroller - Industrial Digital Out 4 Bricklet 2.0¶

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

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

static TF_IndustrialDigitalOut4V2 ido4;

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

    // Set channels alternating high/low 10 times with 100 ms delay
    int i;
    for (i = 0; i < 10; ++i) {
        tf_hal_sleep_us(hal, 100 * 1000);
        bool value[4] = {true, false, false, false};
        check(tf_industrial_digital_out_4_v2_set_value(&ido4, value), "call set_value");
        tf_hal_sleep_us(hal, 100 * 1000);
        bool value_1[4] = {false, true, false, false};
        check(tf_industrial_digital_out_4_v2_set_value(&ido4, value_1), "call set_value");
        tf_hal_sleep_us(hal, 100 * 1000);
        bool value_2[4] = {false, false, true, false};
        check(tf_industrial_digital_out_4_v2_set_value(&ido4, value_2), "call set_value");
        tf_hal_sleep_us(hal, 100 * 1000);
        bool value_3[4] = {false, false, false, true};
        check(tf_industrial_digital_out_4_v2_set_value(&ido4, value_3), "call set_value");
    }
}

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_industrial_digital_out_4_v2_create(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, const char *uid, TF_HAL *hal)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_IndustrialDigitalOut4V2 industrial_digital_out_4_v2;
tf_industrial_digital_out_4_v2_create(&industrial_digital_out_4_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_industrial_digital_out_4_v2_destroy(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 *
Rückgabe:	e_code – Typ: int

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

int tf_industrial_digital_out_4_v2_set_value(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, const bool value[4])¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * value – Typ: const bool[4]
Rückgabe:	e_code – Typ: int

Setzt den Zustand aller vier Kanäle. Der Wert true bzw. false erzeugen logisch 1 bzw. logisch 0 auf dem entsprechenden Kanal.

Mittels tf_industrial_digital_out_4_v2_set_selected_value() können auch einzelnen Kanäle gesetzt werden.

Alle laufenden Monoflop Timer und PWMs werden abgebrochen, wenn diese Funktion aufgerufen wird.

Beispiel: (True, True, False, False) setzt die Kanäle 0-1 auf logisch 1 und die Kanäle 2-3 auf logisch 0.

int tf_industrial_digital_out_4_v2_get_value(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, bool ret_value[4])¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 *
Ausgabeparameter:	ret_value – Typ: bool[4]
Rückgabe:	e_code – Typ: int

Gibt die aktuellen Zustände der Kanäle zurück.

int tf_industrial_digital_out_4_v2_set_selected_value(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t channel, bool value)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * channel – Typ: uint8_t, Wertebereich: [0 bis 3] value – Typ: bool
Rückgabe:	e_code – Typ: int

Setzt den Ausgabewert des spezifizierten Kanals ohne die anderen Kanäle zu beeinflussen.

Ein laufender Monoflop Timer oder PWM für den spezifizierten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

int tf_industrial_digital_out_4_v2_set_channel_led_config(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t channel, uint8_t config)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * channel – Typ: uint8_t, Wertebereich: [0 bis 3] config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

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

Für config:

TF_INDUSTRIAL_DIGITAL_OUT_4_V2_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int tf_industrial_digital_out_4_v2_get_channel_led_config(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t channel, uint8_t *ret_config)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * channel – Typ: uint8_t, Wertebereich: [0 bis 3]
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Kanal-LED-Konfiguration zurück, wie von tf_industrial_digital_out_4_v2_set_channel_led_config() gesetzt.

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

Für ret_config:

TF_INDUSTRIAL_DIGITAL_OUT_4_V2_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen¶

int tf_industrial_digital_out_4_v2_set_monoflop(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t channel, bool value, uint32_t time)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * channel – Typ: uint8_t, Wertebereich: [0 bis 3] value – Typ: bool time – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Der erste Parameter ist der gewünschte Zustand des Kanals (true bedeutet high und false low). Der zweite Parameter stellt die Zeit dar, in welcher der Kanal den Zustand halten soll.

Wenn diese Funktion mit den Parametern (true, 1500) aufgerufen wird: Der Kanal wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-4 Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Kanal wird die gesamte Zeit eingeschaltet sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden ausschalten.

int tf_industrial_digital_out_4_v2_get_monoflop(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t channel, bool *ret_value, uint32_t *ret_time, uint32_t *ret_time_remaining)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * channel – Typ: uint8_t, Wertebereich: [0 bis 3]
Ausgabeparameter:	ret_value – Typ: bool ret_time – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1] ret_time_remaining – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt (für den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von tf_industrial_digital_out_4_v2_set_monoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

int tf_industrial_digital_out_4_v2_set_pwm_configuration(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t channel, uint32_t frequency, uint16_t duty_cycle)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * channel – Typ: uint8_t, Wertebereich: [0 bis 3] frequency – Typ: uint32_t, Einheit: 1/10 Hz, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 duty_cycle – Typ: uint16_t, Einheit: 1/100 %, Wertebereich: [0 bis 10000], Standardwert: 0
Rückgabe:	e_code – Typ: int

Aktiviert ein PWM auf dem angegebenen Kanal.

Um die PWM wieder auszustellen, kann die Frequenz auf 0 gesetzt werden oder eine andere Funktion aufgerufen werden die Einstellungen am Kanal verändert (z.B. tf_industrial_digital_out_4_v2_set_selected_value()).

Der auf dem Industrial Digital Out 4 Bricklet 2.0 verwendete Optokoppler hat eine Anstiegszeit und Abfallzeit von jeweils 11.5us bei einer Spannung von 24V. Dadurch ist ergibt sich ein maximaler Frequenzwert von ca. 400000 (40kHz).

Ein laufender Monoflop Timer für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

int tf_industrial_digital_out_4_v2_get_pwm_configuration(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t channel, uint32_t *ret_frequency, uint16_t *ret_duty_cycle)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * channel – Typ: uint8_t, Wertebereich: [0 bis 3]
Ausgabeparameter:	ret_frequency – Typ: uint32_t, Einheit: 1/10 Hz, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_duty_cycle – Typ: uint16_t, Einheit: 1/100 %, Wertebereich: [0 bis 10000], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int tf_industrial_digital_out_4_v2_get_spitfp_error_count(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_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:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 *
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_industrial_digital_out_4_v2_set_status_led_config(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t config)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * 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_INDUSTRIAL_DIGITAL_OUT_4_V2_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_digital_out_4_v2_get_status_led_config(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t *ret_config)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 *
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_industrial_digital_out_4_v2_set_status_led_config() gesetzt.

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

Für ret_config:

TF_INDUSTRIAL_DIGITAL_OUT_4_V2_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_digital_out_4_v2_get_chip_temperature(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, int16_t *ret_temperature)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 *
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_industrial_digital_out_4_v2_reset(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 *
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_industrial_digital_out_4_v2_get_identity(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_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:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 *
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¶

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_industrial_digital_out_4_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_industrial_digital_out_4_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_industrial_digital_out_4_v2_register_monoflop_done_callback(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, TF_IndustrialDigitalOut4V2_MonoflopDoneHandler handler, void *user_data)¶

void handler(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t channel, bool value, void *user_data)

Callback-Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * channel – Typ: uint8_t, Wertebereich: [0 bis 3] value – Typ: bool user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Kanal und den aktuellen Zustand des Kanals (der Zustand nach dem Monoflop).

Virtuelle Funktionen¶

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

int tf_industrial_digital_out_4_v2_get_response_expected(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * 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_industrial_digital_out_4_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_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_VALUE = 1
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_SELECTED_VALUE = 3
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_MONOFLOP = 4
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 7
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_PWM_CONFIGURATION = 9
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_RESET = 243
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_WRITE_UID = 248

int tf_industrial_digital_out_4_v2_set_response_expected(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t function_id, bool response_expected)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * 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_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_VALUE = 1
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_SELECTED_VALUE = 3
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_MONOFLOP = 4
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 7
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_PWM_CONFIGURATION = 9
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_RESET = 243
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_FUNCTION_WRITE_UID = 248

int tf_industrial_digital_out_4_v2_set_response_expected_all(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, bool response_expected)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * 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_industrial_digital_out_4_v2_set_bootloader_mode(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * 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_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_STATUS_OK = 0
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_industrial_digital_out_4_v2_get_bootloader_mode(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_DIGITAL_OUT_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_industrial_digital_out_4_v2_set_write_firmware_pointer(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint32_t pointer)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * 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_industrial_digital_out_4_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_industrial_digital_out_4_v2_write_firmware(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * 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_industrial_digital_out_4_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_industrial_digital_out_4_v2_write_uid(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint32_t uid)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 * 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_industrial_digital_out_4_v2_read_uid(TF_IndustrialDigitalOut4V2 *industrial_digital_out_4_v2, uint32_t *ret_uid)¶

Parameter:	industrial_digital_out_4_v2 – Typ: TF_IndustrialDigitalOut4V2 *
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_INDUSTRIAL_DIGITAL_OUT_4_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Digital Out 4 Bricklet 2.0 zu identifizieren.

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

TF_INDUSTRIAL_DIGITAL_OUT_4_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Digital Out 4 Bricklet 2.0 dar.