TCP/IP - Real-Time Clock Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls 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.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletRealTimeClock.set_date_time
Funktions-ID:
  • 1
Anfrage:
  • year – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • month – Typ: uint8, Wertebereich: [0 bis 255]
  • day – Typ: uint8, Wertebereich: [0 bis 255]
  • hour – Typ: uint8, Wertebereich: [0 bis 255]
  • minute – Typ: uint8, Wertebereich: [0 bis 255]
  • second – Typ: uint8, Wertebereich: [0 bis 255]
  • centisecond – Typ: uint8, Wertebereich: [0 bis 255]
  • weekday – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

Setzt das aktuelle Datum (inklusive Wochentag) und die aktuelle Zeit mit Hundertstelsekunden Auflösung.

Mögliche Wertebereiche:

  • Year: 2000 bis 2099
  • Month: 1 bis 12 (Januar bis Dezember)
  • Day: 1 bis 31
  • Hour: 0 bis 23
  • Minute: 0 bis 59
  • Second: 0 bis 59
  • Centisecond: 0 bis 99
  • Weekday: 1 bis 7 (Montag bis Sonntag)

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für weekday:

  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday
BrickletRealTimeClock.get_date_time
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • year – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • month – Typ: uint8, Wertebereich: [0 bis 255]
  • day – Typ: uint8, Wertebereich: [0 bis 255]
  • hour – Typ: uint8, Wertebereich: [0 bis 255]
  • minute – Typ: uint8, Wertebereich: [0 bis 255]
  • second – Typ: uint8, Wertebereich: [0 bis 255]
  • centisecond – Typ: uint8, Wertebereich: [0 bis 255]
  • weekday – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt das aktuelle Datum (inklusive Wochentag) und die aktuelle Zeit der Echtzeituhr mit Hundertstelsekunden Auflösung zurück.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für weekday:

  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday
BrickletRealTimeClock.get_timestamp
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • timestamp – Typ: int64, Wertebereich: [-263 bis 263 - 1]

Gibt das aktuelle Datum und Zeit der Echtzeituhr in Millisekunden umgerechnet zurück. Der Zeitstempel hat eine effektive Auflösung von Hundertstelsekunden.

Fortgeschrittene Funktionen

BrickletRealTimeClock.set_offset
Funktions-ID:
  • 4
Anfrage:
  • offset – Typ: int8, Wertebereich: [-128 bis 127]
Antwort:
  • keine Antwort

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.

BrickletRealTimeClock.get_offset
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • offset – Typ: int8, Wertebereich: [-128 bis 127]

Gibt den Versatz zurück, wie von set_offset gesetzt.

BrickletRealTimeClock.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char
  • hardware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletRealTimeClock.set_date_time_callback_period
Funktions-ID:
  • 6
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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

Der 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).

BrickletRealTimeClock.get_date_time_callback_period
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_date_time_callback_period gesetzt.

Neu in Version 2.0.1 (Plugin).

BrickletRealTimeClock.set_alarm
Funktions-ID:
  • 8
Anfrage:
  • month – Typ: int8, Wertebereich: Siehe Bedeutungen
  • day – Typ: int8, Wertebereich: Siehe Bedeutungen
  • hour – Typ: int8, Wertebereich: Siehe Bedeutungen
  • minute – Typ: int8, Wertebereich: Siehe Bedeutungen
  • second – Typ: int8, Wertebereich: Siehe Bedeutungen
  • weekday – Typ: int8, Wertebereich: Siehe Bedeutungen
  • interval – Typ: int32, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

Konfiguriert einen wiederholbaren Alarm. Der 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für month:

  • -1 = Disabled

Für day:

  • -1 = Disabled

Für hour:

  • -1 = Disabled

Für minute:

  • -1 = Disabled

Für second:

  • -1 = Disabled

Für weekday:

  • -1 = Disabled

Für interval:

  • -1 = Disabled

Neu in Version 2.0.1 (Plugin).

BrickletRealTimeClock.get_alarm
Funktions-ID:
  • 9
Anfrage:
  • keine Nutzdaten
Antwort:
  • month – Typ: int8, Wertebereich: Siehe Bedeutungen
  • day – Typ: int8, Wertebereich: Siehe Bedeutungen
  • hour – Typ: int8, Wertebereich: Siehe Bedeutungen
  • minute – Typ: int8, Wertebereich: Siehe Bedeutungen
  • second – Typ: int8, Wertebereich: Siehe Bedeutungen
  • weekday – Typ: int8, Wertebereich: Siehe Bedeutungen
  • interval – Typ: int32, Wertebereich: Siehe Bedeutungen

Gibt die Alarmkonfiguration zurück, wie von set_alarm gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für month:

  • -1 = Disabled

Für day:

  • -1 = Disabled

Für hour:

  • -1 = Disabled

Für minute:

  • -1 = Disabled

Für second:

  • -1 = Disabled

Für weekday:

  • -1 = Disabled

Für interval:

  • -1 = Disabled

Neu in Version 2.0.1 (Plugin).

Callbacks

BrickletRealTimeClock.CALLBACK_DATE_TIME
Funktions-ID:
  • 10
Antwort:
  • year – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • month – Typ: uint8, Wertebereich: [0 bis 255]
  • day – Typ: uint8, Wertebereich: [0 bis 255]
  • hour – Typ: uint8, Wertebereich: [0 bis 255]
  • minute – Typ: uint8, Wertebereich: [0 bis 255]
  • second – Typ: uint8, Wertebereich: [0 bis 255]
  • centisecond – Typ: uint8, Wertebereich: [0 bis 255]
  • weekday – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • timestamp – Typ: int64, Wertebereich: [-263 bis 263 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_date_time_callback_period, ausgelöst. Die Rückgabewerte sind die gleichen wie die von get_date_time und get_timestamp kombiniert.

Der 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für weekday:

  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday

Neu in Version 2.0.1 (Plugin).

BrickletRealTimeClock.CALLBACK_ALARM
Funktions-ID:
  • 11
Antwort:
  • year – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • month – Typ: uint8, Wertebereich: [0 bis 255]
  • day – Typ: uint8, Wertebereich: [0 bis 255]
  • hour – Typ: uint8, Wertebereich: [0 bis 255]
  • minute – Typ: uint8, Wertebereich: [0 bis 255]
  • second – Typ: uint8, Wertebereich: [0 bis 255]
  • centisecond – Typ: uint8, Wertebereich: [0 bis 255]
  • weekday – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • timestamp – Typ: int64, Wertebereich: [-263 bis 263 - 1]

Dieser Callback wird jedes mal ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe set_alarm). Die Rückgabewerte sind die gleichen wie die von get_date_time und get_timestamp kombiniert.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für weekday:

  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday

Neu in Version 2.0.1 (Plugin).