TCP/IP - Real-Time Clock Bricklet 2.0

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

API

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

Grundfunktionen

BrickletRealTimeClockV2.set_date_time
Funktions-ID:
  • 1
Anfrage:
  • year – Typ: uint16, Wertebereich: [2000 bis 2099]
  • month – Typ: uint8, Wertebereich: [1 bis 12]
  • day – Typ: uint8, Wertebereich: [1 bis 31]
  • hour – Typ: uint8, Wertebereich: [0 bis 23]
  • minute – Typ: uint8, Wertebereich: [0 bis 59]
  • second – Typ: uint8, Wertebereich: [0 bis 59]
  • centisecond – Typ: uint8, Wertebereich: [0 bis 99]
  • weekday – Typ: uint8, Wertebereich: Siehe Bedeutungen
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 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
BrickletRealTimeClockV2.get_date_time
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • year – Typ: uint16, Wertebereich: [2000 bis 2099]
  • month – Typ: uint8, Wertebereich: [1 bis 12]
  • day – Typ: uint8, Wertebereich: [1 bis 31]
  • hour – Typ: uint8, Wertebereich: [0 bis 23]
  • minute – Typ: uint8, Wertebereich: [0 bis 59]
  • second – Typ: uint8, Wertebereich: [0 bis 59]
  • centisecond – Typ: uint8, Wertebereich: [0 bis 99]
  • weekday – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • timestamp – Typ: int64, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

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 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
BrickletRealTimeClockV2.get_timestamp
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • timestamp – Typ: int64, Einheit: 1 ms, 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 und ist der Versatz zum 01.01.2000 00:00:00,0000.

Fortgeschrittene Funktionen

BrickletRealTimeClockV2.set_offset
Funktions-ID:
  • 4
Anfrage:
  • offset – Typ: int8, 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.

BrickletRealTimeClockV2.get_offset
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • offset – Typ: int8, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]

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

BrickletRealTimeClockV2.get_spitfp_error_count
Funktions-ID:
  • 234
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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.

BrickletRealTimeClockV2.set_bootloader_mode
Funktions-ID:
  • 235
Anfrage:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

Für status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletRealTimeClockV2.get_bootloader_mode
Funktions-ID:
  • 236
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletRealTimeClockV2.set_write_firmware_pointer
Funktions-ID:
  • 237
Anfrage:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für 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.

BrickletRealTimeClockV2.write_firmware
Funktions-ID:
  • 238
Anfrage:
  • data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: uint8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von 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.

BrickletRealTimeClockV2.set_status_led_config
Funktions-ID:
  • 239
Anfrage:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:
  • keine 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletRealTimeClockV2.get_status_led_config
Funktions-ID:
  • 240
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

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

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletRealTimeClockV2.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

BrickletRealTimeClockV2.reset
Funktions-ID:
  • 243
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine 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.

BrickletRealTimeClockV2.write_uid
Funktions-ID:
  • 248
Anfrage:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine 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.

BrickletRealTimeClockV2.read_uid
Funktions-ID:
  • 249
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletRealTimeClockV2.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, 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 '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. 

Konfigurationsfunktionen für Callbacks

BrickletRealTimeClockV2.set_date_time_callback_configuration
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.

BrickletRealTimeClockV2.get_date_time_callback_configuration
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_configuration gesetzt.

BrickletRealTimeClockV2.set_alarm
Funktions-ID:
  • 8
Anfrage:
  • month – Typ: int8, Wertebereich: [-1, 2000 bis 2099] mit Bedeutungen
  • day – Typ: int8, Wertebereich: [-1, 1 bis 12] mit Bedeutungen
  • hour – Typ: int8, Wertebereich: [-1, 1 bis 31] mit Bedeutungen
  • minute – Typ: int8, Wertebereich: [-1 bis 23] mit Bedeutungen
  • second – Typ: int8, Wertebereich: [-1 bis 59] mit Bedeutungen
  • weekday – Typ: int8, Wertebereich: [-1 bis 59] mit Bedeutungen
  • interval – Typ: int32, Einheit: 1 s, 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
BrickletRealTimeClockV2.get_alarm
Funktions-ID:
  • 9
Anfrage:
  • keine Nutzdaten
Antwort:
  • month – Typ: int8, Wertebereich: [-1, 2000 bis 2099] mit Bedeutungen
  • day – Typ: int8, Wertebereich: [-1, 1 bis 12] mit Bedeutungen
  • hour – Typ: int8, Wertebereich: [-1, 1 bis 31] mit Bedeutungen
  • minute – Typ: int8, Wertebereich: [-1 bis 23] mit Bedeutungen
  • second – Typ: int8, Wertebereich: [-1 bis 59] mit Bedeutungen
  • weekday – Typ: int8, Wertebereich: [-1 bis 59] mit Bedeutungen
  • interval – Typ: int32, Einheit: 1 s, 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

Callbacks

BrickletRealTimeClockV2.CALLBACK_DATE_TIME
Funktions-ID:
  • 10
Antwort:
  • year – Typ: uint16, Wertebereich: [2000 bis 2099]
  • month – Typ: uint8, Wertebereich: [1 bis 12]
  • day – Typ: uint8, Wertebereich: [1 bis 31]
  • hour – Typ: uint8, Wertebereich: [0 bis 23]
  • minute – Typ: uint8, Wertebereich: [0 bis 59]
  • second – Typ: uint8, Wertebereich: [0 bis 59]
  • centisecond – Typ: uint8, Wertebereich: [0 bis 99]
  • weekday – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • timestamp – Typ: int64, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

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

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
BrickletRealTimeClockV2.CALLBACK_ALARM
Funktions-ID:
  • 11
Antwort:
  • year – Typ: uint16, Wertebereich: [2000 bis 2099]
  • month – Typ: uint8, Wertebereich: [1 bis 12]
  • day – Typ: uint8, Wertebereich: [1 bis 31]
  • hour – Typ: uint8, Wertebereich: [0 bis 23]
  • minute – Typ: uint8, Wertebereich: [0 bis 59]
  • second – Typ: uint8, Wertebereich: [0 bis 59]
  • centisecond – Typ: uint8, Wertebereich: [0 bis 99]
  • weekday – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • timestamp – Typ: int64, Einheit: 1 ms, 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.

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