Shell - Real-Time Clock Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.sh)

1
2
3
4
5
6
7
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Real-Time Clock Bricklet 2.0

# Get current date and time
tinkerforge call real-time-clock-v2-bricklet $uid get-date-time

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Real-Time Clock Bricklet 2.0

# Handle incoming date and time callbacks
tinkerforge dispatch real-time-clock-v2-bricklet $uid date-time &

# Set period for date and time callback to 5s (5000ms)
tinkerforge call real-time-clock-v2-bricklet $uid set-date-time-callback-configuration 5000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call real-time-clock-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des Real-Time Clock Bricklet 2.0 aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des Real-Time Clock Bricklet 2.0 an und endet dann
tinkerforge dispatch real-time-clock-v2-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des Real-Time Clock Bricklet 2.0 abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des Real-Time Clock Bricklet 2.0 an und endet dann
tinkerforge call real-time-clock-v2-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch real-time-clock-v2-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> -- string
  • <callback> -- string

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call real-time-clock-v2-bricklet <uid> set-date-time <year> <month> <day> <hour> <minute> <second> <centisecond> <weekday>
Parameter:
  • <year> -- int
  • <month> -- int
  • <day> -- int
  • <hour> -- int
  • <minute> -- int
  • <second> -- int
  • <centisecond> -- int
  • <weekday> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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

  • weekday-monday = 1, für <weekday>
  • weekday-tuesday = 2, für <weekday>
  • weekday-wednesday = 3, für <weekday>
  • weekday-thursday = 4, für <weekday>
  • weekday-friday = 5, für <weekday>
  • weekday-saturday = 6, für <weekday>
  • weekday-sunday = 7, für <weekday>
tinkerforge call real-time-clock-v2-bricklet <uid> get-date-time
Ausgabe:
  • year -- int
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • centisecond -- int
  • weekday -- int (hat Symbole)
  • timestamp -- int

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

Der Zeitstempel stellt das aktuelle Datum und die aktuelle Zeit der Echtzeituhr in Millisekunden umgerechnet dar.

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

  • weekday-monday = 1, für weekday
  • weekday-tuesday = 2, für weekday
  • weekday-wednesday = 3, für weekday
  • weekday-thursday = 4, für weekday
  • weekday-friday = 5, für weekday
  • weekday-saturday = 6, für weekday
  • weekday-sunday = 7, für weekday
tinkerforge call real-time-clock-v2-bricklet <uid> get-timestamp
Ausgabe:
  • timestamp -- int

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

Fortgeschrittene Funktionen

tinkerforge call real-time-clock-v2-bricklet <uid> set-offset <offset>
Parameter:
  • <offset> -- int
Ausgabe:

keine Ausgabe

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.

tinkerforge call real-time-clock-v2-bricklet <uid> get-offset
Ausgabe:
  • offset -- int

Gibt den Versatz zurück, wie von set-offset gesetzt.

tinkerforge call real-time-clock-v2-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

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.

tinkerforge call real-time-clock-v2-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> -- int (hat Symbole)
Ausgabe:
  • status -- int (hat Symbole)

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 Bootlodaer- 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:

  • bootloader-mode-bootloader = 0, für <mode>
  • bootloader-mode-firmware = 1, für <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, für <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, für <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für <mode>
  • bootloader-status-ok = 0, für status
  • bootloader-status-invalid-mode = 1, für status
  • bootloader-status-no-change = 2, für status
  • bootloader-status-entry-function-not-present = 3, für status
  • bootloader-status-device-identifier-incorrect = 4, für status
  • bootloader-status-crc-mismatch = 5, für status
tinkerforge call real-time-clock-v2-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode -- int (hat Symbole)

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

  • bootloader-mode-bootloader = 0, für mode
  • bootloader-mode-firmware = 1, für mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, für mode
  • bootloader-mode-firmware-wait-for-reboot = 3, für mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für mode
tinkerforge call real-time-clock-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> -- int
Ausgabe:

keine Ausgabe

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.

tinkerforge call real-time-clock-v2-bricklet <uid> write-firmware <data>
Parameter:
  • <data> -- int,int,..61x..,int
Ausgabe:
  • status -- int

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.

tinkerforge call real-time-clock-v2-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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:

  • status-led-config-off = 0, für <config>
  • status-led-config-on = 1, für <config>
  • status-led-config-show-heartbeat = 2, für <config>
  • status-led-config-show-status = 3, für <config>
tinkerforge call real-time-clock-v2-bricklet <uid> get-status-led-config
Ausgabe:
  • config -- int (hat Symbole)

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

  • status-led-config-off = 0, für config
  • status-led-config-on = 1, für config
  • status-led-config-show-heartbeat = 2, für config
  • status-led-config-show-status = 3, für config
tinkerforge call real-time-clock-v2-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature -- int

Gibt die Temperatur in °C, 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.

tinkerforge call real-time-clock-v2-bricklet <uid> reset
Ausgabe:keine Ausgabe

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.

tinkerforge call real-time-clock-v2-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> -- int
Ausgabe:

keine Ausgabe

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.

tinkerforge call real-time-clock-v2-bricklet <uid> read-uid
Ausgabe:
  • uid -- int

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

tinkerforge call real-time-clock-v2-bricklet <uid> get-identity
Ausgabe:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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

tinkerforge call real-time-clock-v2-bricklet <uid> set-date-time-callback-configuration <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher der date-time Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der Standardwert ist 0.

tinkerforge call real-time-clock-v2-bricklet <uid> get-date-time-callback-configuration
Ausgabe:
  • period -- int

Gibt die Periode zurück, wie von set-date-time-callback-configuration gesetzt.

tinkerforge call real-time-clock-v2-bricklet <uid> set-alarm <month> <day> <hour> <minute> <second> <weekday> <interval>
Parameter:
  • <month> -- int (hat Symbole)
  • <day> -- int (hat Symbole)
  • <hour> -- int (hat Symbole)
  • <minute> -- int (hat Symbole)
  • <second> -- int (hat Symbole)
  • <weekday> -- int (hat Symbole)
  • <interval> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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

  • alarm-match-disabled = -1, für <month>, <day>, <hour>, <minute>, <second> und <weekday>
  • alarm-interval-disabled = -1, für <interval>
tinkerforge call real-time-clock-v2-bricklet <uid> get-alarm
Ausgabe:
  • month -- int (hat Symbole)
  • day -- int (hat Symbole)
  • hour -- int (hat Symbole)
  • minute -- int (hat Symbole)
  • second -- int (hat Symbole)
  • weekday -- int (hat Symbole)
  • interval -- int (hat Symbole)

Gibt die Alarmkonfiguration zurück, wie von set-alarm gesetzt.

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

  • alarm-match-disabled = -1, für month, day, hour, minute, second und weekday
  • alarm-interval-disabled = -1, für interval

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch real-time-clock-v2-bricklet <uid> example

Die verfügbaren Callbacks 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.

tinkerforge dispatch real-time-clock-v2-bricklet <uid> date-time
Ausgabe:
  • year -- int
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • centisecond -- int
  • weekday -- int (hat Symbole)
  • timestamp -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set-date-time-callback-configuration, ausgelöst. Die Parameter sind die gleichen wie die von get-date-time.

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

  • weekday-monday = 1, für weekday
  • weekday-tuesday = 2, für weekday
  • weekday-wednesday = 3, für weekday
  • weekday-thursday = 4, für weekday
  • weekday-friday = 5, für weekday
  • weekday-saturday = 6, für weekday
  • weekday-sunday = 7, für weekday
tinkerforge dispatch real-time-clock-v2-bricklet <uid> alarm
Ausgabe:
  • year -- int
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • centisecond -- int
  • weekday -- int (hat Symbole)
  • timestamp -- int

Dieser Callback wird jedes mal ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe set-alarm). Die Parameter sind die gleichen wie die von get-date-time.

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

  • weekday-monday = 1, für weekday
  • weekday-tuesday = 2, für weekday
  • weekday-wednesday = 3, für weekday
  • weekday-thursday = 4, für weekday
  • weekday-friday = 5, für weekday
  • weekday-saturday = 6, für weekday
  • weekday-sunday = 7, für weekday