MQTT - Real-Time Clock Bricklet

Dies ist die Beschreibung der MQTT 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 MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Change XYZ to the UID of your Real-Time Clock Bricklet

setup:
    # Get current date and time
    subscribe to tinkerforge/response/real_time_clock_bricklet/XYZ/get_date_time
    publish '' to tinkerforge/request/real_time_clock_bricklet/XYZ/get_date_time
    
    # Get current timestamp
    subscribe to tinkerforge/response/real_time_clock_bricklet/XYZ/get_timestamp
    publish '' to tinkerforge/request/real_time_clock_bricklet/XYZ/get_timestamp

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Real-Time Clock Bricklet

setup:
    # Handle incoming date and time callbacks
    subscribe to tinkerforge/callback/real_time_clock_bricklet/XYZ/date_time
    publish '{"register": true}' to tinkerforge/register/real_time_clock_bricklet/XYZ/date_time # Register date_time callback
    
    # 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!
    publish '{"period": 5000}' to tinkerforge/request/real_time_clock_bricklet/XYZ/set_date_time_callback_period

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/real_time_clock_bricklet/<UID>/set_date_time
Anfrage:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: int, Wertebereich: [1 bis 12]
  • day – Typ: int, Wertebereich: [1 bis 31]
  • hour – Typ: int, Wertebereich: [0 bis 23]
  • minute – Typ: int, Wertebereich: [0 bis 59]
  • second – Typ: int, Wertebereich: [0 bis 59]
  • centisecond – Typ: int, Wertebereich: [0 bis 99]
  • weekday – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für weekday:

  • "monday" = 1
  • "tuesday" = 2
  • "wednesday" = 3
  • "thursday" = 4
  • "friday" = 5
  • "saturday" = 6
  • "sunday" = 7
request/real_time_clock_bricklet/<UID>/get_date_time
Anfrage:
  • keine Nutzdaten
Antwort:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: int, Wertebereich: [1 bis 12]
  • day – Typ: int, Wertebereich: [1 bis 31]
  • hour – Typ: int, Wertebereich: [0 bis 23]
  • minute – Typ: int, Wertebereich: [0 bis 59]
  • second – Typ: int, Wertebereich: [0 bis 59]
  • centisecond – Typ: int, Wertebereich: [0 bis 99]
  • weekday – Typ: int, Wertebereich: Siehe Symbole

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

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

Für weekday:

  • "monday" = 1
  • "tuesday" = 2
  • "wednesday" = 3
  • "thursday" = 4
  • "friday" = 5
  • "saturday" = 6
  • "sunday" = 7
request/real_time_clock_bricklet/<UID>/get_timestamp
Anfrage:
  • keine Nutzdaten
Antwort:
  • timestamp – Typ: int, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

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

request/real_time_clock_bricklet/<UID>/set_offset
Anfrage:
  • offset – Typ: int, Einheit: 217/100 ppm, 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.

request/real_time_clock_bricklet/<UID>/get_offset
Anfrage:
  • keine Nutzdaten
Antwort:
  • offset – Typ: int, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]

Gibt den Versatz zurück, wie von request/real_time_clock_bricklet/<UID>/set_offset gesetzt.

request/real_time_clock_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Real-Time Clock.

Konfigurationsfunktionen für Callbacks

request/real_time_clock_bricklet/<UID>/set_date_time_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/real_time_clock_bricklet/<UID>/date_time Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/real_time_clock_bricklet/<UID>/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).

request/real_time_clock_bricklet/<UID>/get_date_time_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/real_time_clock_bricklet/<UID>/set_date_time_callback_period gesetzt.

Neu in Version 2.0.1 (Plugin).

request/real_time_clock_bricklet/<UID>/set_alarm
Anfrage:
  • month – Typ: int, Wertebereich: [-1, 2000 bis 2099] mit Symbolen
  • day – Typ: int, Wertebereich: [-1, 1 bis 12] mit Symbolen
  • hour – Typ: int, Wertebereich: [-1, 1 bis 31] mit Symbolen
  • minute – Typ: int, Wertebereich: [-1 bis 23] mit Symbolen
  • second – Typ: int, Wertebereich: [-1 bis 59] mit Symbolen
  • weekday – Typ: int, Wertebereich: [-1 bis 59] mit Symbolen
  • interval – Typ: int, Einheit: 1 s, Wertebereich: Siehe Symbole
Antwort:
  • keine Antwort

Konfiguriert einen wiederholbaren Alarm. Der register/real_time_clock_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für month:

  • "disabled" = -1

Für day:

  • "disabled" = -1

Für hour:

  • "disabled" = -1

Für minute:

  • "disabled" = -1

Für second:

  • "disabled" = -1

Für weekday:

  • "disabled" = -1

Für interval:

  • "disabled" = -1

Neu in Version 2.0.1 (Plugin).

request/real_time_clock_bricklet/<UID>/get_alarm
Anfrage:
  • keine Nutzdaten
Antwort:
  • month – Typ: int, Wertebereich: [-1, 2000 bis 2099] mit Symbolen
  • day – Typ: int, Wertebereich: [-1, 1 bis 12] mit Symbolen
  • hour – Typ: int, Wertebereich: [-1, 1 bis 31] mit Symbolen
  • minute – Typ: int, Wertebereich: [-1 bis 23] mit Symbolen
  • second – Typ: int, Wertebereich: [-1 bis 59] mit Symbolen
  • weekday – Typ: int, Wertebereich: [-1 bis 59] mit Symbolen
  • interval – Typ: int, Einheit: 1 s, Wertebereich: Siehe Symbole

Gibt die Alarmkonfiguration zurück, wie von request/real_time_clock_bricklet/<UID>/set_alarm gesetzt.

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

Für month:

  • "disabled" = -1

Für day:

  • "disabled" = -1

Für hour:

  • "disabled" = -1

Für minute:

  • "disabled" = -1

Für second:

  • "disabled" = -1

Für weekday:

  • "disabled" = -1

Für 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 dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/real_time_clock_bricklet/<UID>/date_time
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: int, Wertebereich: [1 bis 12]
  • day – Typ: int, Wertebereich: [1 bis 31]
  • hour – Typ: int, Wertebereich: [0 bis 23]
  • minute – Typ: int, Wertebereich: [0 bis 59]
  • second – Typ: int, Wertebereich: [0 bis 59]
  • centisecond – Typ: int, Wertebereich: [0 bis 99]
  • weekday – Typ: int, Wertebereich: Siehe Symbole
  • timestamp – Typ: int, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/real_time_clock_bricklet/<UID>/date_time[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/real_time_clock_bricklet/<UID>/date_time[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/real_time_clock_bricklet/<UID>/set_date_time_callback_period, ausgelöst. Die Payload-Member des Callbacks sind die gleichen wie die von request/real_time_clock_bricklet/<UID>/get_date_time und request/real_time_clock_bricklet/<UID>/get_timestamp kombiniert.

Der register/real_time_clock_bricklet/<UID>/date_time Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

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

Für weekday:

  • "monday" = 1
  • "tuesday" = 2
  • "wednesday" = 3
  • "thursday" = 4
  • "friday" = 5
  • "saturday" = 6
  • "sunday" = 7

Neu in Version 2.0.1 (Plugin).

register/real_time_clock_bricklet/<UID>/alarm
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: int, Wertebereich: [1 bis 12]
  • day – Typ: int, Wertebereich: [1 bis 31]
  • hour – Typ: int, Wertebereich: [0 bis 23]
  • minute – Typ: int, Wertebereich: [0 bis 59]
  • second – Typ: int, Wertebereich: [0 bis 59]
  • centisecond – Typ: int, Wertebereich: [0 bis 99]
  • weekday – Typ: int, Wertebereich: Siehe Symbole
  • timestamp – Typ: int, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/real_time_clock_bricklet/<UID>/alarm[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/real_time_clock_bricklet/<UID>/alarm[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird jedes mal ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe request/real_time_clock_bricklet/<UID>/set_alarm). Die Payload-Member des Callbacks sind die gleichen wie die von request/real_time_clock_bricklet/<UID>/get_date_time und request/real_time_clock_bricklet/<UID>/get_timestamp kombiniert.

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

Für weekday:

  • "monday" = 1
  • "tuesday" = 2
  • "wednesday" = 3
  • "thursday" = 4
  • "friday" = 5
  • "saturday" = 6
  • "sunday" = 7

Neu in Version 2.0.1 (Plugin).