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

C/C++ für Mikrocontroller - Industrial Counter Bricklet¶

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

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

static TF_IndustrialCounter ic;

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

    // Get current counter from channel 0
    int64_t counter;
    check(tf_industrial_counter_get_counter(&ic, TF_INDUSTRIAL_COUNTER_CHANNEL_0,
                                            &counter), "get counter from channel 0");

    tf_hal_printf("Counter (Channel 0): %I64d\n", counter);

    // Get current signal data from channel 0
    uint16_t duty_cycle; uint64_t period; uint32_t frequency; bool value;
    check(tf_industrial_counter_get_signal_data(&ic, TF_INDUSTRIAL_COUNTER_CHANNEL_0,
                                                &duty_cycle, &period, &frequency,
                                                &value), "get signal data from channel 0");

    tf_hal_printf("Duty Cycle (Channel 0): %d 1/%d %%\n", duty_cycle, 100);
    tf_hal_printf("Period (Channel 0): %I64u ns\n", period);
    tf_hal_printf("Frequency (Channel 0): %d 1/%d Hz\n", frequency, 1000);
    tf_hal_printf("Value (Channel 0): %s\n", value ? "true" : "false");
}

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

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

// Callback function for all counter callback
static void all_counter_handler(TF_IndustrialCounter *device, int64_t counter[4],
                                void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Counter (Channel 0): %I64d\n", counter[0]);
    tf_hal_printf("Counter (Channel 1): %I64d\n", counter[1]);
    tf_hal_printf("Counter (Channel 2): %I64d\n", counter[2]);
    tf_hal_printf("Counter (Channel 3): %I64d\n", counter[3]);
    tf_hal_printf("\n");
}

static TF_IndustrialCounter ic;

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

    // Register all counter callback to function all_counter_handler
    tf_industrial_counter_register_all_counter_callback(&ic,
                                                        all_counter_handler,
                                                        NULL);

    // Set period for all counter callback to 1s (1000ms)
    tf_industrial_counter_set_all_counter_callback_configuration(&ic, 1000, true);
}

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_counter_create(TF_IndustrialCounter *industrial_counter, const char *uid, TF_HAL *hal)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_IndustrialCounter industrial_counter;
tf_industrial_counter_create(&industrial_counter, 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_counter_destroy(TF_IndustrialCounter *industrial_counter)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
Rückgabe:	e_code – Typ: int

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

int tf_industrial_counter_get_counter(TF_IndustrialCounter *industrial_counter, uint8_t channel, int64_t *ret_counter)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_counter – Typ: int64_t, Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1]
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Zählerstand für den gegebenen Kanal zurück.

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

Für channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_get_all_counter(TF_IndustrialCounter *industrial_counter, int64_t ret_counter[4])¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
Ausgabeparameter:	ret_counter – Typ: int64_t[4], Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Zählerstände für alle vier Kanäle zurück.

int tf_industrial_counter_set_counter(TF_IndustrialCounter *industrial_counter, uint8_t channel, int64_t counter)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten counter – Typ: int64_t, Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1]
Rückgabe:	e_code – Typ: int

Setzt den Zählerstand für den gegebenen Kanal.

Der Standardwert für alle Zähler nach dem Start ist 0.

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

Für channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_set_all_counter(TF_IndustrialCounter *industrial_counter, const int64_t counter[4])¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * counter – Typ: const int64_t[4], Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1]
Rückgabe:	e_code – Typ: int

Setzt die Zählerstände für alle vier Kanäle.

Der Standardwert für die Zähler nach dem Starten ist 0.

int tf_industrial_counter_get_signal_data(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint16_t *ret_duty_cycle, uint64_t *ret_period, uint32_t *ret_frequency, bool *ret_value)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_duty_cycle – Typ: uint16_t, Einheit: 1/100 %, Wertebereich: [0 bis 10000] ret_period – Typ: uint64_t, Einheit: 1 ns, Wertebereich: [0 bis 2⁶⁴ - 1] ret_frequency – Typ: uint32_t, Einheit: 1/1000 Hz, Wertebereich: [0 bis 2³² - 1] ret_value – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für den gegebenen Kanal.

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

Für channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_get_all_signal_data(TF_IndustrialCounter *industrial_counter, uint16_t ret_duty_cycle[4], uint64_t ret_period[4], uint32_t ret_frequency[4], bool ret_value[4])¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
Ausgabeparameter:	ret_duty_cycle – Typ: uint16_t[4], Einheit: 1/100 %, Wertebereich: [0 bis 10000] ret_period – Typ: uint64_t[4], Einheit: 1 ns, Wertebereich: [0 bis 2⁶⁴ - 1] ret_frequency – Typ: uint32_t[4], Einheit: 1/1000 Hz, Wertebereich: [0 bis 2³² - 1] ret_value – Typ: bool[4]
Rückgabe:	e_code – Typ: int

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für alle vier Kanäle zurück.

int tf_industrial_counter_set_counter_active(TF_IndustrialCounter *industrial_counter, uint8_t channel, bool active)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten active – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

Aktiviert/Deaktiviert den Zähler für den gegebenen Kanal.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

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

Für channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_set_all_counter_active(TF_IndustrialCounter *industrial_counter, const bool active[4])¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * active – Typ: const bool[4], Standardwert: {true, true, true, true}
Rückgabe:	e_code – Typ: int

Aktiviert/Deaktiviert den Zähler für alle vier Kanäle.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

int tf_industrial_counter_get_counter_active(TF_IndustrialCounter *industrial_counter, uint8_t channel, bool *ret_active)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_active – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

Gibt den Zustand (aktiviert/deaktiviert) des gegebenen Zähler zurück.

true = aktiviert, false = deaktiviert.

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

Für channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_get_all_counter_active(TF_IndustrialCounter *industrial_counter, bool ret_active[4])¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
Ausgabeparameter:	ret_active – Typ: bool[4], Standardwert: {true, true, true, true}
Rückgabe:	e_code – Typ: int

Gibt den Zustand (aktiviert/deaktiviert) aller vier Zähler zurück.

true = aktiviert, false = deaktiviert.

int tf_industrial_counter_set_counter_configuration(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint8_t count_edge, uint8_t count_direction, uint8_t duty_cycle_prescaler, uint8_t frequency_integration_time)¶

Parameter:

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten count_edge – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 count_direction – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 duty_cycle_prescaler – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 frequency_integration_time – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

industrial_counter – Typ: TF_IndustrialCounter *
channel – Typ: uint8_t, Wertebereich: Siehe Konstanten
count_edge – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
count_direction – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
duty_cycle_prescaler – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
frequency_integration_time – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3

Rückgabe:

e_code – Typ: int

Setzt die Zähler-Konfiguration für den gegebenen Kanal.

Zählflanke: Der Zähler kann bei der steigenden, fallenden oder beiden Flanken zählen.
Zählrichtung: Der Zähler kann hoch- oder runterzählen. Es kann auch ein weiterer Kanal als Richtungseingang genutzt werden. Siehe hier für weitere Details.
Tastverhältnis Prescaler: Setzt einen Teiler für die interne Clock. Siehe hier für weitere Details.
Frequenz-Integration: Setzt die Integrationszeit für die Frequenzmessung. Siehe hier für weitere Details.

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

Für channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

Für count_edge:

TF_INDUSTRIAL_COUNTER_COUNT_EDGE_RISING = 0
TF_INDUSTRIAL_COUNTER_COUNT_EDGE_FALLING = 1
TF_INDUSTRIAL_COUNTER_COUNT_EDGE_BOTH = 2

Für count_direction:

TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_UP = 0
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_DOWN = 1
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_UP = 2
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für duty_cycle_prescaler:

TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1 = 0
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2 = 1
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4 = 2
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8 = 3
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16 = 4
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32 = 5
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_64 = 6
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_128 = 7
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_256 = 8
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_512 = 9
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1024 = 10
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2048 = 11
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4096 = 12
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8192 = 13
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16384 = 14
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32768 = 15

Für frequency_integration_time:

TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_128_MS = 0
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_256_MS = 1
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_512_MS = 2
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_32768_MS = 8

int tf_industrial_counter_get_counter_configuration(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint8_t *ret_count_edge, uint8_t *ret_count_direction, uint8_t *ret_duty_cycle_prescaler, uint8_t *ret_frequency_integration_time)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_count_edge – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_count_direction – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_duty_cycle_prescaler – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_frequency_integration_time – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Zähler-Konfiguration zurück, wie Sie mittels tf_industrial_counter_set_counter_configuration() gesetzt wurde.

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

Für channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

Für ret_count_edge:

TF_INDUSTRIAL_COUNTER_COUNT_EDGE_RISING = 0
TF_INDUSTRIAL_COUNTER_COUNT_EDGE_FALLING = 1
TF_INDUSTRIAL_COUNTER_COUNT_EDGE_BOTH = 2

Für ret_count_direction:

TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_UP = 0
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_DOWN = 1
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_UP = 2
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für ret_duty_cycle_prescaler:

TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1 = 0
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2 = 1
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4 = 2
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8 = 3
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16 = 4
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32 = 5
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_64 = 6
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_128 = 7
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_256 = 8
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_512 = 9
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1024 = 10
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2048 = 11
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4096 = 12
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8192 = 13
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16384 = 14
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32768 = 15

Für ret_frequency_integration_time:

TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_128_MS = 0
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_256_MS = 1
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_512_MS = 2
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_32768_MS = 8

int tf_industrial_counter_set_channel_led_config(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint8_t config)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten 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 channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

Für config:

TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int tf_industrial_counter_get_channel_led_config(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint8_t *ret_config)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * channel – Typ: uint8_t, Wertebereich: Siehe Konstanten
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_counter_set_channel_led_config() gesetzt.

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

Für channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

Für ret_config:

TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen¶

int tf_industrial_counter_get_spitfp_error_count(TF_IndustrialCounter *industrial_counter, 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_counter – Typ: TF_IndustrialCounter *
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_counter_set_status_led_config(TF_IndustrialCounter *industrial_counter, uint8_t config)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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_COUNTER_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_counter_get_status_led_config(TF_IndustrialCounter *industrial_counter, uint8_t *ret_config)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
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_counter_set_status_led_config() gesetzt.

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

Für ret_config:

TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_counter_get_chip_temperature(TF_IndustrialCounter *industrial_counter, int16_t *ret_temperature)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
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_counter_reset(TF_IndustrialCounter *industrial_counter)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
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_counter_get_identity(TF_IndustrialCounter *industrial_counter, 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_counter – Typ: TF_IndustrialCounter *
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_counter_set_all_counter_callback_configuration(TF_IndustrialCounter *industrial_counter, uint32_t period, bool value_has_to_change)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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 Counter 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.

int tf_industrial_counter_get_all_counter_callback_configuration(TF_IndustrialCounter *industrial_counter, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
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_counter_set_all_counter_callback_configuration() gesetzt.

int tf_industrial_counter_set_all_signal_data_callback_configuration(TF_IndustrialCounter *industrial_counter, uint32_t period, bool value_has_to_change)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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 Signal Data Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int tf_industrial_counter_get_all_signal_data_callback_configuration(TF_IndustrialCounter *industrial_counter, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
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_counter_set_all_signal_data_callback_configuration() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_industrial_counter_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_counter_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_counter_register_all_counter_callback(TF_IndustrialCounter *industrial_counter, TF_IndustrialCounter_AllCounterHandler handler, void *user_data)¶

void handler(TF_IndustrialCounter *industrial_counter, int64_t counter[4], void *user_data)

Callback-Parameter:	industrial_counter – Typ: TF_IndustrialCounter * counter – Typ: int64_t[4], Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1] user_data – Typ: void *

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

Die Parameter sind der gleiche wie tf_industrial_counter_get_all_counter().

int tf_industrial_counter_register_all_signal_data_callback(TF_IndustrialCounter *industrial_counter, TF_IndustrialCounter_AllSignalDataHandler handler, void *user_data)¶

void handler(TF_IndustrialCounter *industrial_counter, uint16_t duty_cycle[4], uint64_t period[4], uint32_t frequency[4], bool value[4], void *user_data)

Callback-Parameter:	industrial_counter – Typ: TF_IndustrialCounter * duty_cycle – Typ: uint16_t[4], Einheit: 1/100 %, Wertebereich: [0 bis 10000] period – Typ: uint64_t[4], Einheit: 1 ns, Wertebereich: [0 bis 2⁶⁴ - 1] frequency – Typ: uint32_t[4], Einheit: 1/1000 Hz, Wertebereich: [0 bis 2³² - 1] value – Typ: bool[4] user_data – Typ: void *

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

Die Parameter sind der gleiche wie tf_industrial_counter_get_all_signal_data().

Virtuelle Funktionen¶

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

int tf_industrial_counter_get_response_expected(TF_IndustrialCounter *industrial_counter, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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_counter_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_COUNTER_FUNCTION_SET_COUNTER = 3
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER = 4
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_ACTIVE = 7
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_CONFIGURATION = 11
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_COUNTER_FUNCTION_RESET = 243
TF_INDUSTRIAL_COUNTER_FUNCTION_WRITE_UID = 248

int tf_industrial_counter_set_response_expected(TF_IndustrialCounter *industrial_counter, uint8_t function_id, bool response_expected)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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_COUNTER_FUNCTION_SET_COUNTER = 3
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER = 4
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_ACTIVE = 7
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_CONFIGURATION = 11
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_COUNTER_FUNCTION_RESET = 243
TF_INDUSTRIAL_COUNTER_FUNCTION_WRITE_UID = 248

int tf_industrial_counter_set_response_expected_all(TF_IndustrialCounter *industrial_counter, bool response_expected)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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_counter_set_bootloader_mode(TF_IndustrialCounter *industrial_counter, uint8_t mode, uint8_t *ret_status)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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_COUNTER_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_OK = 0
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_industrial_counter_get_bootloader_mode(TF_IndustrialCounter *industrial_counter, uint8_t *ret_mode)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
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_counter_set_bootloader_mode().

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

Für ret_mode:

TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_industrial_counter_set_write_firmware_pointer(TF_IndustrialCounter *industrial_counter, uint32_t pointer)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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_counter_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_counter_write_firmware(TF_IndustrialCounter *industrial_counter, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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_counter_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_counter_write_uid(TF_IndustrialCounter *industrial_counter, uint32_t uid)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter * 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_counter_read_uid(TF_IndustrialCounter *industrial_counter, uint32_t *ret_uid)¶

Parameter:	industrial_counter – Typ: TF_IndustrialCounter *
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_COUNTER_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Counter Bricklet zu identifizieren.

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

TF_INDUSTRIAL_COUNTER_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Counter Bricklet dar.