Dies ist die Beschreibung der MQTT 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 MQTT API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 | # Change XYZ to the UID of your Real-Time Clock Bricklet 2.0
setup:
# Get current date and time
subscribe to tinkerforge/response/real_time_clock_v2_bricklet/XYZ/get_date_time
publish '' to tinkerforge/request/real_time_clock_v2_bricklet/XYZ/get_date_time
|
Download (example-callback.txt)
1 2 3 4 5 6 7 8 9 | # Change XYZ to the UID of your Real-Time Clock Bricklet 2.0
setup:
# Handle incoming date and time callbacks
subscribe to tinkerforge/callback/real_time_clock_v2_bricklet/XYZ/date_time
publish '{"register": true}' to tinkerforge/register/real_time_clock_v2_bricklet/XYZ/date_time # Register date_time callback
# Set period for date and time callback to 5s (5000ms)
publish '{"period": 5000, "value_has_to_change": }' to tinkerforge/request/real_time_clock_v2_bricklet/XYZ/set_date_time_callback_configuration
|
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/...
.
request/
real_time_clock_v2_bricklet/
<UID>/
set_date_time
¶Anfrage: |
|
---|---|
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:
request/
real_time_clock_v2_bricklet/
<UID>/
get_date_time
¶Anfrage: |
|
---|---|
Antwort: |
|
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 Symbole sind für diese Funktion verfügbar:
Für weekday:
request/
real_time_clock_v2_bricklet/
<UID>/
get_timestamp
¶Anfrage: |
|
---|---|
Antwort: |
|
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.
request/
real_time_clock_v2_bricklet/
<UID>/
set_offset
¶Anfrage: |
|
---|---|
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_v2_bricklet/
<UID>/
get_offset
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den Versatz zurück, wie von request/real_time_clock_v2_bricklet/<UID>/set_offset
gesetzt.
request/
real_time_clock_v2_bricklet/
<UID>/
get_spitfp_error_count
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
request/
real_time_clock_v2_bricklet/
<UID>/
set_status_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
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 Symbole sind für diese Funktion verfügbar:
Für config:
request/
real_time_clock_v2_bricklet/
<UID>/
get_status_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/real_time_clock_v2_bricklet/<UID>/set_status_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
real_time_clock_v2_bricklet/
<UID>/
get_chip_temperature
¶Anfrage: |
|
---|---|
Antwort: |
|
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.
request/
real_time_clock_v2_bricklet/
<UID>/
reset
¶Anfrage: |
|
---|---|
Antwort: |
|
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.
request/
real_time_clock_v2_bricklet/
<UID>/
get_identity
¶Anfrage: |
|
---|---|
Antwort: |
|
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. 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 2.0.
request/
real_time_clock_v2_bricklet/
<UID>/
set_date_time_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Periode mit welcher der register/real_time_clock_v2_bricklet/<UID>/date_time
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
request/
real_time_clock_v2_bricklet/
<UID>/
get_date_time_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Periode zurück, wie von request/real_time_clock_v2_bricklet/<UID>/set_date_time_callback_configuration
gesetzt.
request/
real_time_clock_v2_bricklet/
<UID>/
set_alarm
¶Anfrage: |
|
---|---|
Antwort: |
|
Konfiguriert einen wiederholbaren Alarm. Der register/real_time_clock_v2_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:
Für day:
Für hour:
Für minute:
Für second:
Für weekday:
Für interval:
request/
real_time_clock_v2_bricklet/
<UID>/
get_alarm
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Alarmkonfiguration zurück, wie von request/real_time_clock_v2_bricklet/<UID>/set_alarm
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für month:
Für day:
Für hour:
Für minute:
Für second:
Für weekday:
Für interval:
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_v2_bricklet/
<UID>/
date_time
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/real_time_clock_v2_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_v2_bricklet/<UID>/date_time[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/real_time_clock_v2_bricklet/<UID>/set_date_time_callback_configuration
, ausgelöst. Die Payload-Member des Callbacks sind
die gleichen wie die von request/real_time_clock_v2_bricklet/<UID>/get_date_time
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für weekday:
register/
real_time_clock_v2_bricklet/
<UID>/
alarm
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/real_time_clock_v2_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_v2_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_v2_bricklet/<UID>/set_alarm
). Die Payload-Member des Callbacks sind die gleichen wie die von
request/real_time_clock_v2_bricklet/<UID>/get_date_time
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für weekday:
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.
request/
real_time_clock_v2_bricklet/
<UID>/
set_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
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 Symbole sind für diese Funktion verfügbar:
Für mode:
Für status:
request/
real_time_clock_v2_bricklet/
<UID>/
get_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe request/real_time_clock_v2_bricklet/<UID>/set_bootloader_mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
request/
real_time_clock_v2_bricklet/
<UID>/
set_write_firmware_pointer
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Firmware-Pointer für request/real_time_clock_v2_bricklet/<UID>/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.
request/
real_time_clock_v2_bricklet/
<UID>/
write_firmware
¶Anfrage: |
|
---|---|
Antwort: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
request/real_time_clock_v2_bricklet/<UID>/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.
request/
real_time_clock_v2_bricklet/
<UID>/
write_uid
¶Anfrage: |
|
---|---|
Antwort: |
|
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.
request/
real_time_clock_v2_bricklet/
<UID>/
read_uid
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.