Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/real_time_clock_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Real-Time Clock Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
rtc, _ := real_time_clock_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
// Get current date and time.
year, month, day, hour, minute, second, centisecond, weekday, _ := rtc.GetDateTime()
fmt.Printf("Year: %d\n", year)
fmt.Printf("Month: %d\n", month)
fmt.Printf("Day: %d\n", day)
fmt.Printf("Hour: %d\n", hour)
fmt.Printf("Minute: %d\n", minute)
fmt.Printf("Second: %d\n", second)
fmt.Printf("Centisecond: %d\n", centisecond)
if weekday == real_time_clock_bricklet.WeekdayMonday {
fmt.Println("Weekday: Monday")
} else if weekday == real_time_clock_bricklet.WeekdayTuesday {
fmt.Println("Weekday: Tuesday")
} else if weekday == real_time_clock_bricklet.WeekdayWednesday {
fmt.Println("Weekday: Wednesday")
} else if weekday == real_time_clock_bricklet.WeekdayThursday {
fmt.Println("Weekday: Thursday")
} else if weekday == real_time_clock_bricklet.WeekdayFriday {
fmt.Println("Weekday: Friday")
} else if weekday == real_time_clock_bricklet.WeekdaySaturday {
fmt.Println("Weekday: Saturday")
} else if weekday == real_time_clock_bricklet.WeekdaySunday {
fmt.Println("Weekday: Sunday")
}
// Get current timestamp.
timestamp, _ := rtc.GetTimestamp()
fmt.Printf("Timestamp: %d ms\n", timestamp)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Download (example_callback.go)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/real_time_clock_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Real-Time Clock Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
rtc, _ := real_time_clock_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
rtc.RegisterDateTimeCallback(func(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday real_time_clock_bricklet.Weekday, timestamp int64) {
fmt.Printf("Year: %d\n", year)
fmt.Printf("Month: %d\n", month)
fmt.Printf("Day: %d\n", day)
fmt.Printf("Hour: %d\n", hour)
fmt.Printf("Minute: %d\n", minute)
fmt.Printf("Second: %d\n", second)
fmt.Printf("Centisecond: %d\n", centisecond)
if weekday == real_time_clock_bricklet.WeekdayMonday {
fmt.Println("Weekday: Monday")
} else if weekday == real_time_clock_bricklet.WeekdayTuesday {
fmt.Println("Weekday: Tuesday")
} else if weekday == real_time_clock_bricklet.WeekdayWednesday {
fmt.Println("Weekday: Wednesday")
} else if weekday == real_time_clock_bricklet.WeekdayThursday {
fmt.Println("Weekday: Thursday")
} else if weekday == real_time_clock_bricklet.WeekdayFriday {
fmt.Println("Weekday: Friday")
} else if weekday == real_time_clock_bricklet.WeekdaySaturday {
fmt.Println("Weekday: Saturday")
} else if weekday == real_time_clock_bricklet.WeekdaySunday {
fmt.Println("Weekday: Sunday")
}
fmt.Printf("Timestamp: %d\n", timestamp)
fmt.Println()
})
// Set period for date and time receiver 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!
rtc.SetDateTimeCallbackPeriod(5000)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des Real-Time Clock Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/real_time_clock_bricklet
definiert.
Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError
, der das error-Interface implementiert,
zurückgeben. Dieser kann folgende Werte annehmen:
welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
real_time_clock_bricklet.
New
(uid string, ipcon *IPConnection) (device RealTimeClockBricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues RealTimeClockBricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := real_time_clock_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*RealTimeClockBricklet)
SetDateTime
(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für weekday:
(*RealTimeClockBricklet)
GetDateTime
() (year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8, err error)¶Rückgabe: |
|
---|
Gibt das aktuelle Datum (inklusive Wochentag) und die aktuelle Zeit der Echtzeituhr zurück.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für weekday:
(*RealTimeClockBricklet)
GetTimestamp
() (timestamp int64, err error)¶Rückgabe: |
|
---|
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.
(*RealTimeClockBricklet)
SetOffset
(offset int8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*RealTimeClockBricklet)
GetOffset
() (offset int8, err error)¶Rückgabe: |
|
---|
Gibt den Versatz zurück, wie von SetOffset()
gesetzt.
(*RealTimeClockBricklet)
GetIdentity
() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶Rückgabe: |
|
---|
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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
(*RealTimeClockBricklet)
SetDateTimeCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der DateTimeCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der DateTimeCallback
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).
(*RealTimeClockBricklet)
GetDateTimeCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetDateTimeCallbackPeriod()
gesetzt.
Neu in Version 2.0.1 (Plugin).
(*RealTimeClockBricklet)
SetAlarm
(month int8, day int8, hour int8, minute int8, second int8, weekday int8, interval int32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Konfiguriert einen wiederholbaren Alarm. Der AlarmCallback
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 Konstanten 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:
Neu in Version 2.0.1 (Plugin).
(*RealTimeClockBricklet)
GetAlarm
() (month int8, day int8, hour int8, minute int8, second int8, weekday int8, interval int32, err error)¶Rückgabe: |
|
---|
Gibt die Alarmkonfiguration zurück, wie von SetAlarm()
gesetzt.
Die folgenden Konstanten 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:
Neu in Version 2.0.1 (Plugin).
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der entsprechenden Register*Callback
-Function durchgeführt werden,
welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID 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.
(*RealTimeClockBricklet)
RegisterDateTimeCallback
(func(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8, timestamp int64)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetDateTimeCallbackPeriod()
, ausgelöst. Die Parameter des Callbacks sind
die gleichen wie die von GetDateTime()
und GetTimestamp()
kombiniert.
Der DateTimeCallback
Callback wird nur ausgelöst, wenn sich das Datum oder die
Zeit seit der letzten Auslösung geändert haben.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für weekday:
Neu in Version 2.0.1 (Plugin).
(*RealTimeClockBricklet)
RegisterAlarmCallback
(func(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8, timestamp int64)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird jedes mal ausgelöst, wenn das aktuelle Datum und die
aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe
SetAlarm()
). Die Parameter des Callbacks sind die gleichen wie die von
GetDateTime()
und GetTimestamp()
kombiniert.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für weekday:
Neu in Version 2.0.1 (Plugin).
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
(*RealTimeClockBricklet)
GetAPIVersion
() (apiVersion [3]uint8, err error)¶Rückgabe: |
|
---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
(*RealTimeClockBricklet)
GetResponseExpected
(functionId uint8) (responseExpected bool, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels SetResponseExpected()
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
(*RealTimeClockBricklet)
SetResponseExpected
(functionId uint8, responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
(*RealTimeClockBricklet)
SetResponseExpectedAll
(responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
real_time_clock_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein Real-Time Clock Bricklet zu identifizieren.
Die GetIdentity()
Funktion und
der (*IPConnection) RegisterEnumerateCallback
Callback der IPConnection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
real_time_clock_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines Real-Time Clock Bricklet dar.