Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / Real-Time Clock Bricklet 2.0

C/C++ für Mikrocontroller - Real-Time Clock Bricklet 2.0¶

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

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

static TF_RealTimeClockV2 rtc;

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

    // Get current date and time
    uint16_t year; uint8_t month, day, hour, minute, second, centisecond, weekday;
    int64_t timestamp;
    check(tf_real_time_clock_v2_get_date_time(&rtc, &year, &month, &day, &hour, &minute,
                                              &second, &centisecond, &weekday,
                                              &timestamp), "get date and time");

    tf_hal_printf("Year: %I16u\n", year);
    tf_hal_printf("Month: %I8u\n", month);
    tf_hal_printf("Day: %I8u\n", day);
    tf_hal_printf("Hour: %I8u\n", hour);
    tf_hal_printf("Minute: %I8u\n", minute);
    tf_hal_printf("Second: %I8u\n", second);
    tf_hal_printf("Centisecond: %I8u\n", centisecond);

    if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_MONDAY) {
        tf_hal_printf("Weekday: Monday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_TUESDAY) {
        tf_hal_printf("Weekday: Tuesday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_WEDNESDAY) {
        tf_hal_printf("Weekday: Wednesday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_THURSDAY) {
        tf_hal_printf("Weekday: Thursday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_FRIDAY) {
        tf_hal_printf("Weekday: Friday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_SATURDAY) {
        tf_hal_printf("Weekday: Saturday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_SUNDAY) {
        tf_hal_printf("Weekday: Sunday\n");
    }

    tf_hal_printf("Timestamp: %I64d ms\n", timestamp);
}

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

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

// Callback function for date and time callback
static void date_time_handler(TF_RealTimeClockV2 *device, uint16_t year, uint8_t month,
                              uint8_t day, uint8_t hour, uint8_t minute, uint8_t second,
                              uint8_t centisecond, uint8_t weekday, int64_t timestamp,
                              void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Year: %I16u\n", year);
    tf_hal_printf("Month: %I8u\n", month);
    tf_hal_printf("Day: %I8u\n", day);
    tf_hal_printf("Hour: %I8u\n", hour);
    tf_hal_printf("Minute: %I8u\n", minute);
    tf_hal_printf("Second: %I8u\n", second);
    tf_hal_printf("Centisecond: %I8u\n", centisecond);

    if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_MONDAY) {
        tf_hal_printf("Weekday: Monday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_TUESDAY) {
        tf_hal_printf("Weekday: Tuesday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_WEDNESDAY) {
        tf_hal_printf("Weekday: Wednesday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_THURSDAY) {
        tf_hal_printf("Weekday: Thursday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_FRIDAY) {
        tf_hal_printf("Weekday: Friday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_SATURDAY) {
        tf_hal_printf("Weekday: Saturday\n");
    } else if (weekday == TF_REAL_TIME_CLOCK_V2_WEEKDAY_SUNDAY) {
        tf_hal_printf("Weekday: Sunday\n");
    }

    tf_hal_printf("Timestamp: %I64d\n", timestamp);
    tf_hal_printf("\n");
}

static TF_RealTimeClockV2 rtc;

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

    // Register date and time callback to function date_time_handler
    tf_real_time_clock_v2_register_date_time_callback(&rtc,
                                                      date_time_handler,
                                                      NULL);

    // Set period for date and time callback to 5s (5000ms)
    tf_real_time_clock_v2_set_date_time_callback_configuration(&rtc, 5000);
}

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_real_time_clock_v2_create(TF_RealTimeClockV2 *real_time_clock_v2, const char *uid, TF_HAL *hal)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_RealTimeClockV2 real_time_clock_v2;
tf_real_time_clock_v2_create(&real_time_clock_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_real_time_clock_v2_destroy(TF_RealTimeClockV2 *real_time_clock_v2)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
Rückgabe:	e_code – Typ: int

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

int tf_real_time_clock_v2_set_date_time(TF_RealTimeClockV2 *real_time_clock_v2, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint8_t centisecond, uint8_t weekday)¶

Parameter:

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * year – Typ: uint16_t, Wertebereich: [2000 bis 2099] month – Typ: uint8_t, Wertebereich: [1 bis 12] day – Typ: uint8_t, Wertebereich: [1 bis 31] hour – Typ: uint8_t, Wertebereich: [0 bis 23] minute – Typ: uint8_t, Wertebereich: [0 bis 59] second – Typ: uint8_t, Wertebereich: [0 bis 59] centisecond – Typ: uint8_t, Wertebereich: [0 bis 99] weekday – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
year – Typ: uint16_t, Wertebereich: [2000 bis 2099]
month – Typ: uint8_t, Wertebereich: [1 bis 12]
day – Typ: uint8_t, Wertebereich: [1 bis 31]
hour – Typ: uint8_t, Wertebereich: [0 bis 23]
minute – Typ: uint8_t, Wertebereich: [0 bis 59]
second – Typ: uint8_t, Wertebereich: [0 bis 59]
centisecond – Typ: uint8_t, Wertebereich: [0 bis 99]
weekday – Typ: uint8_t, Wertebereich: Siehe Konstanten

Rückgabe:

e_code – Typ: int

Setzt das aktuelle Datum (inklusive Wochentag).

Wenn die Backup Batterie eingebaut ist, dann behält die Echtzeituhr Datum und Zeit auch dann, wenn kein Brick das Bricklet mit Strom versorgt.

Die Echtzeituhr behandelt Schaltjahre und fügt den 29. Februar entsprechend ein. Schaltsekunden, Zeitzonen und die Sommerzeit werden jedoch nicht behandelt.

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

Für weekday:

TF_REAL_TIME_CLOCK_V2_WEEKDAY_MONDAY = 1
TF_REAL_TIME_CLOCK_V2_WEEKDAY_TUESDAY = 2
TF_REAL_TIME_CLOCK_V2_WEEKDAY_WEDNESDAY = 3
TF_REAL_TIME_CLOCK_V2_WEEKDAY_THURSDAY = 4
TF_REAL_TIME_CLOCK_V2_WEEKDAY_FRIDAY = 5
TF_REAL_TIME_CLOCK_V2_WEEKDAY_SATURDAY = 6
TF_REAL_TIME_CLOCK_V2_WEEKDAY_SUNDAY = 7

int tf_real_time_clock_v2_get_date_time(TF_RealTimeClockV2 *real_time_clock_v2, uint16_t *ret_year, uint8_t *ret_month, uint8_t *ret_day, uint8_t *ret_hour, uint8_t *ret_minute, uint8_t *ret_second, uint8_t *ret_centisecond, uint8_t *ret_weekday, int64_t *ret_timestamp)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
Ausgabeparameter:	ret_year – Typ: uint16_t, Wertebereich: [2000 bis 2099] ret_month – Typ: uint8_t, Wertebereich: [1 bis 12] ret_day – Typ: uint8_t, Wertebereich: [1 bis 31] ret_hour – Typ: uint8_t, Wertebereich: [0 bis 23] ret_minute – Typ: uint8_t, Wertebereich: [0 bis 59] ret_second – Typ: uint8_t, Wertebereich: [0 bis 59] ret_centisecond – Typ: uint8_t, Wertebereich: [0 bis 99] ret_weekday – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_timestamp – Typ: int64_t, Einheit: 1 ms, Wertebereich: [-2⁶³ bis 2⁶³ - 1]
Rückgabe:	e_code – Typ: int

Gibt das aktuelle Datum (inklusive Wochentag) und die aktuelle Zeit der Echtzeituhr zurück.

Der Zeitstempel stellt das aktuelle Datum und die aktuelle Zeit der Echtzeituhr in Millisekunden umgerechnet dar und ist der Versatz zum 01.01.2000 00:00:00,0000.

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

Für ret_weekday:

TF_REAL_TIME_CLOCK_V2_WEEKDAY_MONDAY = 1
TF_REAL_TIME_CLOCK_V2_WEEKDAY_TUESDAY = 2
TF_REAL_TIME_CLOCK_V2_WEEKDAY_WEDNESDAY = 3
TF_REAL_TIME_CLOCK_V2_WEEKDAY_THURSDAY = 4
TF_REAL_TIME_CLOCK_V2_WEEKDAY_FRIDAY = 5
TF_REAL_TIME_CLOCK_V2_WEEKDAY_SATURDAY = 6
TF_REAL_TIME_CLOCK_V2_WEEKDAY_SUNDAY = 7

int tf_real_time_clock_v2_get_timestamp(TF_RealTimeClockV2 *real_time_clock_v2, int64_t *ret_timestamp)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
Ausgabeparameter:	ret_timestamp – Typ: int64_t, Einheit: 1 ms, Wertebereich: [-2⁶³ bis 2⁶³ - 1]
Rückgabe:	e_code – Typ: int

Gibt das aktuelle Datum und Zeit der Echtzeituhr in Millisekunden umgerechnet zurück. Der Zeitstempel hat eine effektive Auflösung von Hundertstelsekunden und ist der Versatz zum 01.01.2000 00:00:00,0000.

Fortgeschrittene Funktionen¶

int tf_real_time_clock_v2_set_offset(TF_RealTimeClockV2 *real_time_clock_v2, int8_t offset)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * offset – Typ: int8_t, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]
Rückgabe:	e_code – Typ: int

Setzt den Versatz ein, den die Echtzeituhr ausgleichen soll. Der Versatz kann in 2,17 ppm Schritten zwischen -277,76 ppm (-128) und +275,59 ppm (127) eingestellt werden.

Die Echtzeituhr kann von der eigentlichen Zeit abweichen, bedingt durch die Frequenzabweichung des verbauten 32,768 kHz Quarzes. Selbst ohne Ausgleich (Werkseinstellung) sollte die daraus entstehende Zeitabweichung höchstens ±20 ppm (±52,6 Sekunden pro Monat) betragen.

Diese Abweichung kann berechnet werden, durch Vergleich der gleichen Zeitdauer einmal mit der Echtzeituhr (rtc_duration) gemessen und einmal mit einer genauen Kontrolluhr (ref_duration) gemessen.

Um das beste Ergebnis zu erzielen, sollte der eingestellte Versatz zuerst auf 0 ppm gesetzt und dann eine Zeitdauer von mindestens 6 Stunden gemessen werden.

Der neue Versatz (new_offset) kann dann wie folgt aus dem aktuell eingestellten Versatz (current_offset) und den gemessenen Zeitdauern berechnet werden:

new_offset = current_offset - round(1000000 * (rtc_duration - ref_duration) / rtc_duration / 2.17)

Wenn der Versatz berechnet werden soll, dann empfehlen wir den Kalibrierungsdialog in Brick Viewer dafür zu verwenden, anstatt die Berechnung von Hand durchzuführen.

Der Versatz wird im EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

int tf_real_time_clock_v2_get_offset(TF_RealTimeClockV2 *real_time_clock_v2, int8_t *ret_offset)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
Ausgabeparameter:	ret_offset – Typ: int8_t, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]
Rückgabe:	e_code – Typ: int

Gibt den Versatz zurück, wie von tf_real_time_clock_v2_set_offset() gesetzt.

int tf_real_time_clock_v2_get_spitfp_error_count(TF_RealTimeClockV2 *real_time_clock_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:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
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_real_time_clock_v2_set_status_led_config(TF_RealTimeClockV2 *real_time_clock_v2, uint8_t config)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * 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_REAL_TIME_CLOCK_V2_STATUS_LED_CONFIG_OFF = 0
TF_REAL_TIME_CLOCK_V2_STATUS_LED_CONFIG_ON = 1
TF_REAL_TIME_CLOCK_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_REAL_TIME_CLOCK_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_real_time_clock_v2_get_status_led_config(TF_RealTimeClockV2 *real_time_clock_v2, uint8_t *ret_config)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
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_real_time_clock_v2_set_status_led_config() gesetzt.

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

Für ret_config:

TF_REAL_TIME_CLOCK_V2_STATUS_LED_CONFIG_OFF = 0
TF_REAL_TIME_CLOCK_V2_STATUS_LED_CONFIG_ON = 1
TF_REAL_TIME_CLOCK_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_REAL_TIME_CLOCK_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_real_time_clock_v2_get_chip_temperature(TF_RealTimeClockV2 *real_time_clock_v2, int16_t *ret_temperature)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
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_real_time_clock_v2_reset(TF_RealTimeClockV2 *real_time_clock_v2)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
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_real_time_clock_v2_get_identity(TF_RealTimeClockV2 *real_time_clock_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:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
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_real_time_clock_v2_set_date_time_callback_configuration(TF_RealTimeClockV2 *real_time_clock_v2, uint32_t period)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt die Periode mit welcher der Date Time Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int tf_real_time_clock_v2_get_date_time_callback_configuration(TF_RealTimeClockV2 *real_time_clock_v2, uint32_t *ret_period)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Periode zurück, wie von tf_real_time_clock_v2_set_date_time_callback_configuration() gesetzt.

int tf_real_time_clock_v2_set_alarm(TF_RealTimeClockV2 *real_time_clock_v2, int8_t month, int8_t day, int8_t hour, int8_t minute, int8_t second, int8_t weekday, int32_t interval)¶

Parameter:

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * month – Typ: int8_t, Wertebereich: [-1, 1 bis 12] mit Konstanten day – Typ: int8_t, Wertebereich: [-1, 1 bis 31] mit Konstanten hour – Typ: int8_t, Wertebereich: [-1, 0 bis 23] mit Konstanten minute – Typ: int8_t, Wertebereich: [-1, 0 bis 59] mit Konstanten second – Typ: int8_t, Wertebereich: [-1, 0 bis 59] mit Konstanten weekday – Typ: int8_t, Wertebereich: [-1, 1 bis 7] mit Konstanten interval – Typ: int32_t, Einheit: 1 s, Wertebereich: [-1, 1 bis 2³¹ - 1] mit Konstanten
Rückgabe:	e_code – Typ: int

real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
month – Typ: int8_t, Wertebereich: [-1, 1 bis 12] mit Konstanten
day – Typ: int8_t, Wertebereich: [-1, 1 bis 31] mit Konstanten
hour – Typ: int8_t, Wertebereich: [-1, 0 bis 23] mit Konstanten
minute – Typ: int8_t, Wertebereich: [-1, 0 bis 59] mit Konstanten
second – Typ: int8_t, Wertebereich: [-1, 0 bis 59] mit Konstanten
weekday – Typ: int8_t, Wertebereich: [-1, 1 bis 7] mit Konstanten
interval – Typ: int32_t, Einheit: 1 s, Wertebereich: [-1, 1 bis 2³¹ - 1] mit Konstanten

Rückgabe:

e_code – Typ: int

Konfiguriert einen wiederholbaren Alarm. Der Alarm Callback wird ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem konfigurierten Alarm übereinstimmen.

Wird ein Parameter auf -1 gesetzt, dann wird es deaktiviert und nimmt nicht am Übereinstimmungstest teil. Werden alle Parameter auf -1 gesetzt, dann ist der Alarm vollständig deaktiviert.

Um z.B. den Alarm jeden Tag um 7:30 Uhr auszulösen kann dieser auf (-1, -1, 7, 30, -1, -1, -1) konfiguriert werden. Die Stunde ist auf 7 gesetzt und die Minute auf 30. Der Alarm wird ausgelöst, wenn alle aktiven Parameter mit dem aktuellen Datum und der aktuellen Zeit übereinstimmen.

Das Intervall hat eine spezielle Rolle. Wenn es nicht auf -1 gesetzt ist, dann konfiguriert sich der Alarm nach jeder Auslösung entsprechend selbst neu. Dies kann für wiederholende Alarme genutzt werden, die nicht durch Übereinstimmung mit Datum und Uhrzeit abgebildet werden können. Um z.B. alle 23 Sekunden einen Alarm auszulösen kann dieser als (-1, -1, -1, -1, -1, -1, 23) konfiguriert werden. Intern nimmt das Bricklet das aktuelle Datum und die aktuelle Uhrzeit, addiert 23 Sekunden und setzt das Ergebnis als Alarm. Der erste Alarm wir dann 23 Sekunden nach dem Aufruf ausgelöst werden. Da das Intervall nicht -1 ist wird das Bricklet dann intern wieder das gleiche tun: 23 Sekunden auf das aktuelle Datum und die aktuelle Uhrzeit addieren und das Ergebnis als Alarm setzten. Dadurch entsteht ein sich alle 23 Sekunden wiederholender Alarm.

Das Intervall kann auch in Kombination mit den anderen Parametern verwendet werden. Wird z.B. der Alarm auf (-1, -1, 7, 30, -1, -1, 300) konfiguriert dann wird der Alarm jeden Tag um 7:30 Uhr ausgelöst und dann all 5 Minuten wiederholt.

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

Für month:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für day:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für hour:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für minute:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für second:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für weekday:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für interval:

TF_REAL_TIME_CLOCK_V2_ALARM_INTERVAL_DISABLED = -1

int tf_real_time_clock_v2_get_alarm(TF_RealTimeClockV2 *real_time_clock_v2, int8_t *ret_month, int8_t *ret_day, int8_t *ret_hour, int8_t *ret_minute, int8_t *ret_second, int8_t *ret_weekday, int32_t *ret_interval)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
Ausgabeparameter:	ret_month – Typ: int8_t, Wertebereich: [-1, 1 bis 12] mit Konstanten ret_day – Typ: int8_t, Wertebereich: [-1, 1 bis 31] mit Konstanten ret_hour – Typ: int8_t, Wertebereich: [-1, 0 bis 23] mit Konstanten ret_minute – Typ: int8_t, Wertebereich: [-1, 0 bis 59] mit Konstanten ret_second – Typ: int8_t, Wertebereich: [-1, 0 bis 59] mit Konstanten ret_weekday – Typ: int8_t, Wertebereich: [-1, 1 bis 7] mit Konstanten ret_interval – Typ: int32_t, Einheit: 1 s, Wertebereich: [-1, 1 bis 2³¹ - 1] mit Konstanten
Rückgabe:	e_code – Typ: int

Gibt die Alarmkonfiguration zurück, wie von tf_real_time_clock_v2_set_alarm() gesetzt.

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

Für ret_month:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für ret_day:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für ret_hour:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für ret_minute:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für ret_second:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für ret_weekday:

TF_REAL_TIME_CLOCK_V2_ALARM_MATCH_DISABLED = -1

Für ret_interval:

TF_REAL_TIME_CLOCK_V2_ALARM_INTERVAL_DISABLED = -1

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_real_time_clock_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_real_time_clock_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_real_time_clock_v2_register_date_time_callback(TF_RealTimeClockV2 *real_time_clock_v2, TF_RealTimeClockV2_DateTimeHandler handler, void *user_data)¶

void handler(TF_RealTimeClockV2 *real_time_clock_v2, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint8_t centisecond, uint8_t weekday, int64_t timestamp, void *user_data)

Callback-Parameter:

Callback-Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * year – Typ: uint16_t, Wertebereich: [2000 bis 2099] month – Typ: uint8_t, Wertebereich: [1 bis 12] day – Typ: uint8_t, Wertebereich: [1 bis 31] hour – Typ: uint8_t, Wertebereich: [0 bis 23] minute – Typ: uint8_t, Wertebereich: [0 bis 59] second – Typ: uint8_t, Wertebereich: [0 bis 59] centisecond – Typ: uint8_t, Wertebereich: [0 bis 99] weekday – Typ: uint8_t, Wertebereich: Siehe Konstanten timestamp – Typ: int64_t, Einheit: 1 ms, Wertebereich: [-2⁶³ bis 2⁶³ - 1] user_data – Typ: void *

real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
year – Typ: uint16_t, Wertebereich: [2000 bis 2099]
month – Typ: uint8_t, Wertebereich: [1 bis 12]
day – Typ: uint8_t, Wertebereich: [1 bis 31]
hour – Typ: uint8_t, Wertebereich: [0 bis 23]
minute – Typ: uint8_t, Wertebereich: [0 bis 59]
second – Typ: uint8_t, Wertebereich: [0 bis 59]
centisecond – Typ: uint8_t, Wertebereich: [0 bis 99]
weekday – Typ: uint8_t, Wertebereich: Siehe Konstanten
timestamp – Typ: int64_t, Einheit: 1 ms, Wertebereich: [-2⁶³ bis 2⁶³ - 1]
user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit tf_real_time_clock_v2_set_date_time_callback_configuration(), ausgelöst. Die Parameter sind die gleichen wie die von tf_real_time_clock_v2_get_date_time().

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

Für weekday:

TF_REAL_TIME_CLOCK_V2_WEEKDAY_MONDAY = 1
TF_REAL_TIME_CLOCK_V2_WEEKDAY_TUESDAY = 2
TF_REAL_TIME_CLOCK_V2_WEEKDAY_WEDNESDAY = 3
TF_REAL_TIME_CLOCK_V2_WEEKDAY_THURSDAY = 4
TF_REAL_TIME_CLOCK_V2_WEEKDAY_FRIDAY = 5
TF_REAL_TIME_CLOCK_V2_WEEKDAY_SATURDAY = 6
TF_REAL_TIME_CLOCK_V2_WEEKDAY_SUNDAY = 7

int tf_real_time_clock_v2_register_alarm_callback(TF_RealTimeClockV2 *real_time_clock_v2, TF_RealTimeClockV2_AlarmHandler handler, void *user_data)¶

void handler(TF_RealTimeClockV2 *real_time_clock_v2, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint8_t centisecond, uint8_t weekday, int64_t timestamp, void *user_data)

Callback-Parameter:

Callback-Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * year – Typ: uint16_t, Wertebereich: [2000 bis 2099] month – Typ: uint8_t, Wertebereich: [1 bis 12] day – Typ: uint8_t, Wertebereich: [1 bis 31] hour – Typ: uint8_t, Wertebereich: [0 bis 23] minute – Typ: uint8_t, Wertebereich: [0 bis 59] second – Typ: uint8_t, Wertebereich: [0 bis 59] centisecond – Typ: uint8_t, Wertebereich: [0 bis 99] weekday – Typ: uint8_t, Wertebereich: Siehe Konstanten timestamp – Typ: int64_t, Einheit: 1 ms, Wertebereich: [-2⁶³ bis 2⁶³ - 1] user_data – Typ: void *

real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
year – Typ: uint16_t, Wertebereich: [2000 bis 2099]
month – Typ: uint8_t, Wertebereich: [1 bis 12]
day – Typ: uint8_t, Wertebereich: [1 bis 31]
hour – Typ: uint8_t, Wertebereich: [0 bis 23]
minute – Typ: uint8_t, Wertebereich: [0 bis 59]
second – Typ: uint8_t, Wertebereich: [0 bis 59]
centisecond – Typ: uint8_t, Wertebereich: [0 bis 99]
weekday – Typ: uint8_t, Wertebereich: Siehe Konstanten
timestamp – Typ: int64_t, Einheit: 1 ms, Wertebereich: [-2⁶³ bis 2⁶³ - 1]
user_data – Typ: void *

Dieser Callback wird jedes mal ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe tf_real_time_clock_v2_set_alarm()). Die Parameter sind die gleichen wie die von tf_real_time_clock_v2_get_date_time().

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

Für weekday:

TF_REAL_TIME_CLOCK_V2_WEEKDAY_MONDAY = 1
TF_REAL_TIME_CLOCK_V2_WEEKDAY_TUESDAY = 2
TF_REAL_TIME_CLOCK_V2_WEEKDAY_WEDNESDAY = 3
TF_REAL_TIME_CLOCK_V2_WEEKDAY_THURSDAY = 4
TF_REAL_TIME_CLOCK_V2_WEEKDAY_FRIDAY = 5
TF_REAL_TIME_CLOCK_V2_WEEKDAY_SATURDAY = 6
TF_REAL_TIME_CLOCK_V2_WEEKDAY_SUNDAY = 7

Virtuelle Funktionen¶

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

int tf_real_time_clock_v2_get_response_expected(TF_RealTimeClockV2 *real_time_clock_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * 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_real_time_clock_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_REAL_TIME_CLOCK_V2_FUNCTION_SET_DATE_TIME = 1
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_OFFSET = 4
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_DATE_TIME_CALLBACK_CONFIGURATION = 6
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_ALARM = 8
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_REAL_TIME_CLOCK_V2_FUNCTION_RESET = 243
TF_REAL_TIME_CLOCK_V2_FUNCTION_WRITE_UID = 248

int tf_real_time_clock_v2_set_response_expected(TF_RealTimeClockV2 *real_time_clock_v2, uint8_t function_id, bool response_expected)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * 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_REAL_TIME_CLOCK_V2_FUNCTION_SET_DATE_TIME = 1
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_OFFSET = 4
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_DATE_TIME_CALLBACK_CONFIGURATION = 6
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_ALARM = 8
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_REAL_TIME_CLOCK_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_REAL_TIME_CLOCK_V2_FUNCTION_RESET = 243
TF_REAL_TIME_CLOCK_V2_FUNCTION_WRITE_UID = 248

int tf_real_time_clock_v2_set_response_expected_all(TF_RealTimeClockV2 *real_time_clock_v2, bool response_expected)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * 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_real_time_clock_v2_set_bootloader_mode(TF_RealTimeClockV2 *real_time_clock_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * 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_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_REAL_TIME_CLOCK_V2_BOOTLOADER_STATUS_OK = 0
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_real_time_clock_v2_get_bootloader_mode(TF_RealTimeClockV2 *real_time_clock_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_REAL_TIME_CLOCK_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_real_time_clock_v2_set_write_firmware_pointer(TF_RealTimeClockV2 *real_time_clock_v2, uint32_t pointer)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * 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_real_time_clock_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_real_time_clock_v2_write_firmware(TF_RealTimeClockV2 *real_time_clock_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * 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_real_time_clock_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_real_time_clock_v2_write_uid(TF_RealTimeClockV2 *real_time_clock_v2, uint32_t uid)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 * 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_real_time_clock_v2_read_uid(TF_RealTimeClockV2 *real_time_clock_v2, uint32_t *ret_uid)¶

Parameter:	real_time_clock_v2 – Typ: TF_RealTimeClockV2 *
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_REAL_TIME_CLOCK_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Real-Time Clock Bricklet 2.0 zu identifizieren.

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

TF_REAL_TIME_CLOCK_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Real-Time Clock Bricklet 2.0 dar.