C/C++ - Real-Time Clock Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das Real-Time Clock Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Real-Time Clock Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
#define __STDC_FORMAT_MACROS // for PRId64/PRIu64 in C++

#include <stdio.h>
#include <inttypes.h>

#include "ip_connection.h"
#include "bricklet_real_time_clock.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Real-Time Clock Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    RealTimeClock rtc;
    real_time_clock_create(&rtc, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current date and time
    uint16_t year; uint8_t month, day, hour, minute, second, centisecond, weekday;
    if(real_time_clock_get_date_time(&rtc, &year, &month, &day, &hour, &minute, &second,
                                     &centisecond, &weekday) < 0) {
        fprintf(stderr, "Could not get date and time, probably timeout\n");
        return 1;
    }

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

    if(weekday == REAL_TIME_CLOCK_WEEKDAY_MONDAY) {
        printf("Weekday: Monday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_TUESDAY) {
        printf("Weekday: Tuesday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_WEDNESDAY) {
        printf("Weekday: Wednesday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_THURSDAY) {
        printf("Weekday: Thursday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_FRIDAY) {
        printf("Weekday: Friday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_SATURDAY) {
        printf("Weekday: Saturday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_SUNDAY) {
        printf("Weekday: Sunday\n");
    }

    // Get current timestamp
    int64_t timestamp;
    if(real_time_clock_get_timestamp(&rtc, &timestamp) < 0) {
        fprintf(stderr, "Could not get timestamp, probably timeout\n");
        return 1;
    }

    printf("Timestamp: %" PRId64 " ms\n", timestamp);

    printf("Press key to exit\n");
    getchar();
    real_time_clock_destroy(&rtc);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
#define __STDC_FORMAT_MACROS // for PRId64/PRIu64 in C++

#include <stdio.h>
#include <inttypes.h>

#include "ip_connection.h"
#include "bricklet_real_time_clock.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Real-Time Clock Bricklet

// Callback function for date and time callback
void cb_date_time(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)user_data; // avoid unused parameter warning

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

    if(weekday == REAL_TIME_CLOCK_WEEKDAY_MONDAY) {
        printf("Weekday: Monday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_TUESDAY) {
        printf("Weekday: Tuesday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_WEDNESDAY) {
        printf("Weekday: Wednesday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_THURSDAY) {
        printf("Weekday: Thursday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_FRIDAY) {
        printf("Weekday: Friday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_SATURDAY) {
        printf("Weekday: Saturday\n");
    } else if(weekday == REAL_TIME_CLOCK_WEEKDAY_SUNDAY) {
        printf("Weekday: Sunday\n");
    }

    printf("Timestamp: %" PRId64 "\n", timestamp);
    printf("\n");
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    RealTimeClock rtc;
    real_time_clock_create(&rtc, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register date and time callback to function cb_date_time
    real_time_clock_register_callback(&rtc,
                                      REAL_TIME_CLOCK_CALLBACK_DATE_TIME,
                                      (void (*)(void))cb_date_time,
                                      NULL);

    // Set period for date and time callback to 5s (5000ms)
    // Note: The date and time callback is only called every 5 seconds
    //       if the date and time has changed since the last call!
    real_time_clock_set_date_time_callback_period(&rtc, 5000);

    printf("Press key to exit\n");
    getchar();
    real_time_clock_destroy(&rtc);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void real_time_clock_create(RealTimeClock *real_time_clock, const char *uid, IPConnection *ipcon)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt real_time_clock mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

RealTimeClock real_time_clock;
real_time_clock_create(&real_time_clock, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void real_time_clock_destroy(RealTimeClock *real_time_clock)
Parameter:
  • real_time_clock – Typ: RealTimeClock *

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

int real_time_clock_set_date_time(RealTimeClock *real_time_clock, 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:
  • real_time_clock – Typ: RealTimeClock *
  • 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:
  • error_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:

  • REAL_TIME_CLOCK_WEEKDAY_MONDAY = 1
  • REAL_TIME_CLOCK_WEEKDAY_TUESDAY = 2
  • REAL_TIME_CLOCK_WEEKDAY_WEDNESDAY = 3
  • REAL_TIME_CLOCK_WEEKDAY_THURSDAY = 4
  • REAL_TIME_CLOCK_WEEKDAY_FRIDAY = 5
  • REAL_TIME_CLOCK_WEEKDAY_SATURDAY = 6
  • REAL_TIME_CLOCK_WEEKDAY_SUNDAY = 7
int real_time_clock_get_date_time(RealTimeClock *real_time_clock, 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)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
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
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_weekday:

  • REAL_TIME_CLOCK_WEEKDAY_MONDAY = 1
  • REAL_TIME_CLOCK_WEEKDAY_TUESDAY = 2
  • REAL_TIME_CLOCK_WEEKDAY_WEDNESDAY = 3
  • REAL_TIME_CLOCK_WEEKDAY_THURSDAY = 4
  • REAL_TIME_CLOCK_WEEKDAY_FRIDAY = 5
  • REAL_TIME_CLOCK_WEEKDAY_SATURDAY = 6
  • REAL_TIME_CLOCK_WEEKDAY_SUNDAY = 7
int real_time_clock_get_timestamp(RealTimeClock *real_time_clock, int64_t *ret_timestamp)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
Ausgabeparameter:
  • ret_timestamp – Typ: int64_t, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt das aktuelle Datum und Zeit der Echtzeituhr. Der Zeitstempel hat eine effektive Auflösung von Hundertstelsekunden und ist der Versatz zum 01.01.2000 00:00:00,000.

Fortgeschrittene Funktionen

int real_time_clock_set_offset(RealTimeClock *real_time_clock, int8_t offset)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
  • offset – Typ: int8_t, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]
Rückgabe:
  • error_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 real_time_clock_get_offset(RealTimeClock *real_time_clock, int8_t *ret_offset)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
Ausgabeparameter:
  • ret_offset – Typ: int8_t, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]
Rückgabe:
  • error_code – Typ: int

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

int real_time_clock_get_identity(RealTimeClock *real_time_clock, 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 – Typ: RealTimeClock *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', '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 216 - 1]
Rückgabe:
  • error_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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

void real_time_clock_register_callback(RealTimeClock *real_time_clock, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int real_time_clock_set_date_time_callback_period(RealTimeClock *real_time_clock, uint32_t period)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

Der REAL_TIME_CLOCK_CALLBACK_DATE_TIME Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

Neu in Version 2.0.1 (Plugin).

int real_time_clock_get_date_time_callback_period(RealTimeClock *real_time_clock, uint32_t *ret_period)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

Neu in Version 2.0.1 (Plugin).

int real_time_clock_set_alarm(RealTimeClock *real_time_clock, int8_t month, int8_t day, int8_t hour, int8_t minute, int8_t second, int8_t weekday, int32_t interval)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
  • month – Typ: int8_t, Wertebereich: [-1, 2000 bis 2099] mit Konstanten
  • day – Typ: int8_t, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • hour – Typ: int8_t, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • minute – Typ: int8_t, Wertebereich: [-1 bis 23] mit Konstanten
  • second – Typ: int8_t, Wertebereich: [-1 bis 59] mit Konstanten
  • weekday – Typ: int8_t, Wertebereich: [-1 bis 59] mit Konstanten
  • interval – Typ: int32_t, Einheit: 1 s, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Konfiguriert einen wiederholbaren Alarm. Der REAL_TIME_CLOCK_CALLBACK_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:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für day:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für hour:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für minute:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für second:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für weekday:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für interval:

  • REAL_TIME_CLOCK_ALARM_INTERVAL_DISABLED = -1

Neu in Version 2.0.1 (Plugin).

int real_time_clock_get_alarm(RealTimeClock *real_time_clock, 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 – Typ: RealTimeClock *
Ausgabeparameter:
  • ret_month – Typ: int8_t, Wertebereich: [-1, 2000 bis 2099] mit Konstanten
  • ret_day – Typ: int8_t, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • ret_hour – Typ: int8_t, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • ret_minute – Typ: int8_t, Wertebereich: [-1 bis 23] mit Konstanten
  • ret_second – Typ: int8_t, Wertebereich: [-1 bis 59] mit Konstanten
  • ret_weekday – Typ: int8_t, Wertebereich: [-1 bis 59] mit Konstanten
  • ret_interval – Typ: int32_t, Einheit: 1 s, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_month:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für ret_day:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für ret_hour:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für ret_minute:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für ret_second:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für ret_weekday:

  • REAL_TIME_CLOCK_ALARM_MATCH_DISABLED = -1

Für ret_interval:

  • REAL_TIME_CLOCK_ALARM_INTERVAL_DISABLED = -1

Neu in Version 2.0.1 (Plugin).

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der real_time_clock_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

real_time_clock_register_callback(&real_time_clock,
                                  REAL_TIME_CLOCK_CALLBACK_EXAMPLE,
                                  (void (*)(void))my_callback,
                                  NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

REAL_TIME_CLOCK_CALLBACK_DATE_TIME
void callback(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:
  • 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: [-263 bis 263 - 1]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit real_time_clock_set_date_time_callback_period(), ausgelöst. Die Parameter sind die gleichen wie die von real_time_clock_get_date_time() und real_time_clock_get_timestamp() kombiniert.

Der REAL_TIME_CLOCK_CALLBACK_DATE_TIME Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

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

Für weekday:

  • REAL_TIME_CLOCK_WEEKDAY_MONDAY = 1
  • REAL_TIME_CLOCK_WEEKDAY_TUESDAY = 2
  • REAL_TIME_CLOCK_WEEKDAY_WEDNESDAY = 3
  • REAL_TIME_CLOCK_WEEKDAY_THURSDAY = 4
  • REAL_TIME_CLOCK_WEEKDAY_FRIDAY = 5
  • REAL_TIME_CLOCK_WEEKDAY_SATURDAY = 6
  • REAL_TIME_CLOCK_WEEKDAY_SUNDAY = 7

Neu in Version 2.0.1 (Plugin).

REAL_TIME_CLOCK_CALLBACK_ALARM
void callback(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:
  • 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: [-263 bis 263 - 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 real_time_clock_set_alarm()). Die Parameter sind die gleichen wie die von real_time_clock_get_date_time() und real_time_clock_get_timestamp() kombiniert.

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

Für weekday:

  • REAL_TIME_CLOCK_WEEKDAY_MONDAY = 1
  • REAL_TIME_CLOCK_WEEKDAY_TUESDAY = 2
  • REAL_TIME_CLOCK_WEEKDAY_WEDNESDAY = 3
  • REAL_TIME_CLOCK_WEEKDAY_THURSDAY = 4
  • REAL_TIME_CLOCK_WEEKDAY_FRIDAY = 5
  • REAL_TIME_CLOCK_WEEKDAY_SATURDAY = 6
  • REAL_TIME_CLOCK_WEEKDAY_SUNDAY = 7

Neu in Version 2.0.1 (Plugin).

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int real_time_clock_get_api_version(RealTimeClock *real_time_clock, uint8_t ret_api_version[3])
Parameter:
  • real_time_clock – Typ: RealTimeClock *
Ausgabeparameter:
  • ret_api_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]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int real_time_clock_get_response_expected(RealTimeClock *real_time_clock, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_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 real_time_clock_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:

  • REAL_TIME_CLOCK_FUNCTION_SET_DATE_TIME = 1
  • REAL_TIME_CLOCK_FUNCTION_SET_OFFSET = 4
  • REAL_TIME_CLOCK_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • REAL_TIME_CLOCK_FUNCTION_SET_ALARM = 8
int real_time_clock_set_response_expected(RealTimeClock *real_time_clock, uint8_t function_id, bool response_expected)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_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.

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:

  • REAL_TIME_CLOCK_FUNCTION_SET_DATE_TIME = 1
  • REAL_TIME_CLOCK_FUNCTION_SET_OFFSET = 4
  • REAL_TIME_CLOCK_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • REAL_TIME_CLOCK_FUNCTION_SET_ALARM = 8
int real_time_clock_set_response_expected_all(RealTimeClock *real_time_clock, bool response_expected)
Parameter:
  • real_time_clock – Typ: RealTimeClock *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

REAL_TIME_CLOCK_DEVICE_IDENTIFIER

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

Die real_time_clock_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

REAL_TIME_CLOCK_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Real-Time Clock Bricklet dar.