Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / Industrial Dual Analog In Bricklet 2.0

C/C++ für Mikrocontroller - Industrial Dual Analog In Bricklet 2.0¶

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

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

static TF_IndustrialDualAnalogInV2 idai;

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

    // Get current voltage from channel 0
    int32_t voltage;
    check(tf_industrial_dual_analog_in_v2_get_voltage(&idai, 0,
                                                      &voltage), "get voltage from channel 0");

    tf_hal_printf("Voltage (Channel 0): %d 1/%d V\n", voltage, 1000);
}

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_industrial_dual_analog_in_v2.h"

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

// Callback function for voltage callback
static void voltage_handler(TF_IndustrialDualAnalogInV2 *device, uint8_t channel,
                            int32_t voltage, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Channel: %I8u\n", channel);
    tf_hal_printf("Voltage: %d 1/%d V\n", voltage, 1000);
    tf_hal_printf("\n");
}

static TF_IndustrialDualAnalogInV2 idai;

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

    // Register voltage callback to function voltage_handler
    tf_industrial_dual_analog_in_v2_register_voltage_callback(&idai,
                                                              voltage_handler,
                                                              NULL);

    // Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold
    tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration(&idai, 0, 1000, false, 'x', 0, 0);
}

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

Threshold¶

Download (example_threshold.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_dual_analog_in_v2.h"

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

// Callback function for voltage callback
static void voltage_handler(TF_IndustrialDualAnalogInV2 *device, uint8_t channel,
                            int32_t voltage, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Channel: %I8u\n", channel);
    tf_hal_printf("Voltage: %d 1/%d V\n", voltage, 1000);
    tf_hal_printf("\n");
}

static TF_IndustrialDualAnalogInV2 idai;

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

    // Register voltage callback to function voltage_handler
    tf_industrial_dual_analog_in_v2_register_voltage_callback(&idai,
                                                              voltage_handler,
                                                              NULL);

    // Configure threshold for voltage (channel 0) "greater than 10 V"
    // with a debounce period of 10s (10000ms)
    tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration(&idai, 0, 10000, false, '>', 10*1000, 0);
}

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.

Das Bricklet hat zwei Eingangskanäle. Funktionen die sich direkt auf einen der Kanäle beziehen haben einen channel Parameter, um den Kanal anzugeben. Gültige Werte für der channel Parameter sind 0 und 1.

Grundfunktionen¶

int tf_industrial_dual_analog_in_v2_create(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, const char *uid, TF_HAL *hal)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_IndustrialDualAnalogInV2 industrial_dual_analog_in_v2;
tf_industrial_dual_analog_in_v2_create(&industrial_dual_analog_in_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_dual_analog_in_v2_destroy(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
Rückgabe:	e_code – Typ: int

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

int tf_industrial_dual_analog_in_v2_get_voltage(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, int32_t *ret_voltage)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
Ausgabeparameter:	ret_voltage – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]
Rückgabe:	e_code – Typ: int

Gibt die Spannung für den übergebenen Kanal zurück.

Wenn der Wert periodisch benötigt wird, kann auch der Voltage Callback verwendet werden. Der Callback wird mit der Funktion tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration() konfiguriert.

int tf_industrial_dual_analog_in_v2_set_channel_led_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, uint8_t config)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1] 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 kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.

Das Verhalten des Kanalstatus kann mittels tf_industrial_dual_analog_in_v2_set_channel_led_status_config() eingestellt werden.

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

Für config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int tf_industrial_dual_analog_in_v2_get_channel_led_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, uint8_t *ret_config)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
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_dual_analog_in_v2_set_channel_led_config() gesetzt.

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

Für ret_config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int tf_industrial_dual_analog_in_v2_set_channel_led_status_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, int32_t min, int32_t max, uint8_t config)¶

Parameter:

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1] min – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 10000 config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
channel – Typ: uint8_t, Wertebereich: [0 bis 1]
min – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 10000
config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1

Rückgabe:

e_code – Typ: int

Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Kanal-LED auf Kanalstatus eingestellt ist, siehe tf_industrial_dual_analog_in_v2_set_channel_led_config().

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10V wird die LED eingeschaltet sobald die gemessene Spannung über 10V steigt und wieder ausgeschaltet sobald der Strom unter 10V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald die gemessene Spannung unter 10V fällt und wieder ausgeschaltet sobald der Strom über 10V steigt.

Im Intensitätsmodus kann ein Bereich in mV angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4V und max=20V: Die LED ist bei 4V und darunter aus, bei 20V und darüber an und zwischen 4V und 20V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

int tf_industrial_dual_analog_in_v2_get_channel_led_status_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, int32_t *ret_min, int32_t *ret_max, uint8_t *ret_config)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
Ausgabeparameter:	ret_min – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 ret_max – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 10000 ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen¶

int tf_industrial_dual_analog_in_v2_set_sample_rate(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t rate)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 6
Rückgabe:	e_code – Typ: int

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

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

Für rate:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_976_SPS = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_488_SPS = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_244_SPS = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_122_SPS = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_61_SPS = 4
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_4_SPS = 5
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_2_SPS = 6
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_1_SPS = 7

int tf_industrial_dual_analog_in_v2_get_sample_rate(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t *ret_rate)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
Ausgabeparameter:	ret_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 6
Rückgabe:	e_code – Typ: int

Gibt die Abtastrate zurück, wie von tf_industrial_dual_analog_in_v2_set_sample_rate() gesetzt.

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

Für ret_rate:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_976_SPS = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_488_SPS = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_244_SPS = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_122_SPS = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_61_SPS = 4
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_4_SPS = 5
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_2_SPS = 6
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_1_SPS = 7

int tf_industrial_dual_analog_in_v2_set_calibration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, const int32_t offset[2], const int32_t gain[2])¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * offset – Typ: const int32_t[2], Wertebereich: [-2²³ bis 2²³ - 1] gain – Typ: const int32_t[2], Wertebereich: [-2²³ bis 2²³ - 1]
Rückgabe:	e_code – Typ: int

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet 2.0 wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

int tf_industrial_dual_analog_in_v2_get_calibration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int32_t ret_offset[2], int32_t ret_gain[2])¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
Ausgabeparameter:	ret_offset – Typ: int32_t[2], Wertebereich: [-2²³ bis 2²³ - 1] ret_gain – Typ: int32_t[2], Wertebereich: [-2²³ bis 2²³ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Kalibrierung zurück, wie von tf_industrial_dual_analog_in_v2_set_calibration() gesetzt.

int tf_industrial_dual_analog_in_v2_get_adc_values(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int32_t ret_value[2])¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
Ausgabeparameter:	ret_value – Typ: int32_t[2], Wertebereich: [-2²³ bis 2²³ - 1]
Rückgabe:	e_code – Typ: int

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe tf_industrial_dual_analog_in_v2_set_calibration().

int tf_industrial_dual_analog_in_v2_get_all_voltages(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int32_t ret_voltages[2])¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
Ausgabeparameter:	ret_voltages – Typ: int32_t[2], Einheit: 1 mV, Wertebereich: [-35000 bis 35000]
Rückgabe:	e_code – Typ: int

Gibt die Spannung aller Kanäle zurück.

Wenn der Wert periodisch benötigt wird, kann auch der All Voltages Callback verwendet werden. Der Callback wird mit der Funktion tf_industrial_dual_analog_in_v2_set_all_voltages_callback_configuration() konfiguriert.

Neu in Version 2.0.6 (Plugin).

int tf_industrial_dual_analog_in_v2_get_spitfp_error_count(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_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_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
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_dual_analog_in_v2_set_status_led_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t config)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * 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_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_dual_analog_in_v2_get_status_led_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t *ret_config)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
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_dual_analog_in_v2_set_status_led_config() gesetzt.

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

Für ret_config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_dual_analog_in_v2_get_chip_temperature(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int16_t *ret_temperature)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
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_dual_analog_in_v2_reset(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
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_dual_analog_in_v2_get_identity(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_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_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
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_industrial_dual_analog_in_v2_set_voltage_callback_configuration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameter:

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1] period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
channel – Typ: uint8_t, Wertebereich: [0 bis 1]
period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Die Periode ist die Periode mit der der Voltage Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den Voltage Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_OFF = 'x'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_industrial_dual_analog_in_v2_get_voltage_callback_configuration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 ret_max – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration() gesetzt.

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

Für ret_option:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_OFF = 'x'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_industrial_dual_analog_in_v2_set_all_voltages_callback_configuration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t period, bool value_has_to_change)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der All Voltages Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

Neu in Version 2.0.6 (Plugin).

int tf_industrial_dual_analog_in_v2_get_all_voltages_callback_configuration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_industrial_dual_analog_in_v2_set_all_voltages_callback_configuration() gesetzt.

Neu in Version 2.0.6 (Plugin).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_industrial_dual_analog_in_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_dual_analog_in_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_dual_analog_in_v2_register_voltage_callback(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, TF_IndustrialDualAnalogInV2_VoltageHandler handler, void *user_data)¶

void handler(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, int32_t voltage, void *user_data)

Callback-Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1] voltage – Typ: int32_t, Einheit: 1 mV, Wertebereich: [-35000 bis 35000] user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie tf_industrial_dual_analog_in_v2_get_voltage().

int tf_industrial_dual_analog_in_v2_register_all_voltages_callback(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, TF_IndustrialDualAnalogInV2_AllVoltagesHandler handler, void *user_data)¶

void handler(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int32_t voltages[2], void *user_data)

Callback-Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * voltages – Typ: int32_t[2], Einheit: 1 mV, Wertebereich: [-35000 bis 35000] user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels tf_industrial_dual_analog_in_v2_set_all_voltages_callback_configuration() gesetzten Konfiguration

Die Parameter sind der gleiche wie tf_industrial_dual_analog_in_v2_get_all_voltages().

Neu in Version 2.0.6 (Plugin).

Virtuelle Funktionen¶

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

int tf_industrial_dual_analog_in_v2_get_response_expected(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * 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_dual_analog_in_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_DUAL_ANALOG_IN_V2_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_SAMPLE_RATE = 5
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CALIBRATION = 7
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 10
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_RESET = 243
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_WRITE_UID = 248

int tf_industrial_dual_analog_in_v2_set_response_expected(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t function_id, bool response_expected)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * 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_DUAL_ANALOG_IN_V2_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_SAMPLE_RATE = 5
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CALIBRATION = 7
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 10
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_RESET = 243
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_WRITE_UID = 248

int tf_industrial_dual_analog_in_v2_set_response_expected_all(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, bool response_expected)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * 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_dual_analog_in_v2_set_bootloader_mode(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * 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_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_OK = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_industrial_dual_analog_in_v2_get_bootloader_mode(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t *ret_mode)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
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_dual_analog_in_v2_set_bootloader_mode().

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

Für ret_mode:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_industrial_dual_analog_in_v2_set_write_firmware_pointer(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t pointer)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * 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_dual_analog_in_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_dual_analog_in_v2_write_firmware(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * 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_dual_analog_in_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_dual_analog_in_v2_write_uid(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t uid)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 * 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_dual_analog_in_v2_read_uid(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t *ret_uid)¶

Parameter:	industrial_dual_analog_in_v2 – Typ: TF_IndustrialDualAnalogInV2 *
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_DUAL_ANALOG_IN_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Dual Analog In Bricklet 2.0 zu identifizieren.

Die Funktionen tf_industrial_dual_analog_in_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_DUAL_ANALOG_IN_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Dual Analog In Bricklet 2.0 dar.