Go - Real-Time Clock Bricklet 2.0

Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/real_time_clock_v2_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Real-Time Clock Bricklet 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rtc, _ := real_time_clock_v2_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, timestamp, _ := rtc.GetDateTime()

    fmt.Printf("Year: \n", year)
    fmt.Printf("Month: \n", month)
    fmt.Printf("Day: \n", day)
    fmt.Printf("Hour: \n", hour)
    fmt.Printf("Minute: \n", minute)
    fmt.Printf("Second: \n", second)
    fmt.Printf("Centisecond: \n", centisecond)

    if weekday == real_time_clock_v2_bricklet.WeekdayMonday {
        fmt.Println("Weekday: Monday")
    } else if weekday == real_time_clock_v2_bricklet.WeekdayTuesday {
        fmt.Println("Weekday: Tuesday")
    } else if weekday == real_time_clock_v2_bricklet.WeekdayWednesday {
        fmt.Println("Weekday: Wednesday")
    } else if weekday == real_time_clock_v2_bricklet.WeekdayThursday {
        fmt.Println("Weekday: Thursday")
    } else if weekday == real_time_clock_v2_bricklet.WeekdayFriday {
        fmt.Println("Weekday: Friday")
    } else if weekday == real_time_clock_v2_bricklet.WeekdaySaturday {
        fmt.Println("Weekday: Saturday")
    } else if weekday == real_time_clock_v2_bricklet.WeekdaySunday {
        fmt.Println("Weekday: Sunday")
    }

    fmt.Printf("Timestamp:  ms\n", timestamp)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Callback

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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/real_time_clock_v2_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Real-Time Clock Bricklet 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rtc, _ := real_time_clock_v2_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_v2_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_v2_bricklet.WeekdayMonday {
            fmt.Println("Weekday: Monday")
        } else if weekday == real_time_clock_v2_bricklet.WeekdayTuesday {
            fmt.Println("Weekday: Tuesday")
        } else if weekday == real_time_clock_v2_bricklet.WeekdayWednesday {
            fmt.Println("Weekday: Wednesday")
        } else if weekday == real_time_clock_v2_bricklet.WeekdayThursday {
            fmt.Println("Weekday: Thursday")
        } else if weekday == real_time_clock_v2_bricklet.WeekdayFriday {
            fmt.Println("Weekday: Friday")
        } else if weekday == real_time_clock_v2_bricklet.WeekdaySaturday {
            fmt.Println("Weekday: Saturday")
        } else if weekday == real_time_clock_v2_bricklet.WeekdaySunday {
            fmt.Println("Weekday: Sunday")
        }

        fmt.Printf("Timestamp: %d\n", timestamp)
        fmt.Println()
    })

    // Set period for date and time callback to 5s (5000ms).
    rtc.SetDateTimeCallbackConfiguration(5000)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des Real-Time Clock Bricklet 2.0 ist im Package github.com/Tinkerforge/go-api-bindings/real_time_clock_v2_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:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func real_time_clock_v2_bricklet.New(uid string, ipcon *IPConnection) (device RealTimeClockV2Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: RealTimeClockV2Bricklet
  • err – Typ: error

Erzeugt ein neues RealTimeClockV2Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := real_time_clock_v2_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*RealTimeClockV2Bricklet) SetDateTime(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8) (err error)
Parameter:
  • 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 Konstanten
Rückgabe:
  • err – Typ: error

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:

  • real_time_clock_v2_bricklet.WeekdayMonday = 1
  • real_time_clock_v2_bricklet.WeekdayTuesday = 2
  • real_time_clock_v2_bricklet.WeekdayWednesday = 3
  • real_time_clock_v2_bricklet.WeekdayThursday = 4
  • real_time_clock_v2_bricklet.WeekdayFriday = 5
  • real_time_clock_v2_bricklet.WeekdaySaturday = 6
  • real_time_clock_v2_bricklet.WeekdaySunday = 7
func (*RealTimeClockV2Bricklet) GetDateTime() (year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8, timestamp int64, err error)
Rückgabe:
  • 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 Konstanten
  • timestamp – Typ: int64, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]
  • err – Typ: error

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

Für weekday:

  • real_time_clock_v2_bricklet.WeekdayMonday = 1
  • real_time_clock_v2_bricklet.WeekdayTuesday = 2
  • real_time_clock_v2_bricklet.WeekdayWednesday = 3
  • real_time_clock_v2_bricklet.WeekdayThursday = 4
  • real_time_clock_v2_bricklet.WeekdayFriday = 5
  • real_time_clock_v2_bricklet.WeekdaySaturday = 6
  • real_time_clock_v2_bricklet.WeekdaySunday = 7
func (*RealTimeClockV2Bricklet) GetTimestamp() (timestamp int64, err error)
Rückgabe:
  • timestamp – Typ: int64, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]
  • err – Typ: error

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

func (*RealTimeClockV2Bricklet) SetOffset(offset int8) (err error)
Parameter:
  • offset – Typ: int8, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]
Rückgabe:
  • err – Typ: error

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.

func (*RealTimeClockV2Bricklet) GetOffset() (offset int8, err error)
Rückgabe:
  • offset – Typ: int8, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]
  • err – Typ: error

Gibt den Versatz zurück, wie von SetOffset() gesetzt.

func (*RealTimeClockV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Rückgabe:
  • errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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.

func (*RealTimeClockV2Bricklet) SetBootloaderMode(mode uint8) (status uint8, err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für mode:

  • real_time_clock_v2_bricklet.BootloaderModeBootloader = 0
  • real_time_clock_v2_bricklet.BootloaderModeFirmware = 1
  • real_time_clock_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • real_time_clock_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • real_time_clock_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

  • real_time_clock_v2_bricklet.BootloaderStatusOK = 0
  • real_time_clock_v2_bricklet.BootloaderStatusInvalidMode = 1
  • real_time_clock_v2_bricklet.BootloaderStatusNoChange = 2
  • real_time_clock_v2_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • real_time_clock_v2_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • real_time_clock_v2_bricklet.BootloaderStatusCRCMismatch = 5
func (*RealTimeClockV2Bricklet) GetBootloaderMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

Für mode:

  • real_time_clock_v2_bricklet.BootloaderModeBootloader = 0
  • real_time_clock_v2_bricklet.BootloaderModeFirmware = 1
  • real_time_clock_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • real_time_clock_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • real_time_clock_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*RealTimeClockV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Parameter:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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

func (*RealTimeClockV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Parameter:
  • data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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

func (*RealTimeClockV2Bricklet) SetStatusLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

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

Für config:

  • real_time_clock_v2_bricklet.StatusLEDConfigOff = 0
  • real_time_clock_v2_bricklet.StatusLEDConfigOn = 1
  • real_time_clock_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • real_time_clock_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*RealTimeClockV2Bricklet) GetStatusLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

Für config:

  • real_time_clock_v2_bricklet.StatusLEDConfigOff = 0
  • real_time_clock_v2_bricklet.StatusLEDConfigOn = 1
  • real_time_clock_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • real_time_clock_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*RealTimeClockV2Bricklet) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
  • err – Typ: error

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.

func (*RealTimeClockV2Bricklet) Reset() (err error)
Rückgabe:
  • err – Typ: error

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.

func (*RealTimeClockV2Bricklet) WriteUID(uid uint32) (err error)
Parameter:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

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.

func (*RealTimeClockV2Bricklet) ReadUID() (uid uint32, err error)
Rückgabe:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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

func (*RealTimeClockV2Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

func (*RealTimeClockV2Bricklet) SetDateTimeCallbackConfiguration(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt die Periode mit welcher der RegisterDateTimeCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

func (*RealTimeClockV2Bricklet) GetDateTimeCallbackConfiguration() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

Gibt die Periode zurück, wie von SetDateTimeCallbackConfiguration() gesetzt.

func (*RealTimeClockV2Bricklet) SetAlarm(month int8, day int8, hour int8, minute int8, second int8, weekday int8, interval int32) (err error)
Parameter:
  • month – Typ: int8, Wertebereich: [-1, 2000 bis 2099] mit Konstanten
  • day – Typ: int8, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • hour – Typ: int8, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • minute – Typ: int8, Wertebereich: [-1 bis 23] mit Konstanten
  • second – Typ: int8, Wertebereich: [-1 bis 59] mit Konstanten
  • weekday – Typ: int8, Wertebereich: [-1 bis 59] mit Konstanten
  • interval – Typ: int32, Einheit: 1 s, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

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

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für day:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für hour:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für minute:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für second:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für weekday:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für interval:

  • real_time_clock_v2_bricklet.AlarmIntervalDisabled = -1
func (*RealTimeClockV2Bricklet) GetAlarm() (month int8, day int8, hour int8, minute int8, second int8, weekday int8, interval int32, err error)
Rückgabe:
  • month – Typ: int8, Wertebereich: [-1, 2000 bis 2099] mit Konstanten
  • day – Typ: int8, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • hour – Typ: int8, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • minute – Typ: int8, Wertebereich: [-1 bis 23] mit Konstanten
  • second – Typ: int8, Wertebereich: [-1 bis 59] mit Konstanten
  • weekday – Typ: int8, Wertebereich: [-1 bis 59] mit Konstanten
  • interval – Typ: int32, Einheit: 1 s, Wertebereich: Siehe Konstanten
  • err – Typ: error

Gibt die Alarmkonfiguration zurück, wie von SetAlarm() gesetzt.

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

Für month:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für day:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für hour:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für minute:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für second:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für weekday:

  • real_time_clock_v2_bricklet.AlarmMatchDisabled = -1

Für interval:

  • real_time_clock_v2_bricklet.AlarmIntervalDisabled = -1

Callbacks

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.

func (*RealTimeClockV2Bricklet) RegisterDateTimeCallback(func(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8, timestamp int64)) (registrationId uint64)
Callback-Parameter:
  • 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 Konstanten
  • timestamp – Typ: int64, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetDateTimeCallbackConfiguration(), ausgelöst. Die Parameter des Callbacks sind die gleichen wie die von GetDateTime().

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

Für weekday:

  • real_time_clock_v2_bricklet.WeekdayMonday = 1
  • real_time_clock_v2_bricklet.WeekdayTuesday = 2
  • real_time_clock_v2_bricklet.WeekdayWednesday = 3
  • real_time_clock_v2_bricklet.WeekdayThursday = 4
  • real_time_clock_v2_bricklet.WeekdayFriday = 5
  • real_time_clock_v2_bricklet.WeekdaySaturday = 6
  • real_time_clock_v2_bricklet.WeekdaySunday = 7
func (*RealTimeClockV2Bricklet) RegisterAlarmCallback(func(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8, timestamp int64)) (registrationId uint64)
Callback-Parameter:
  • 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 Konstanten
  • timestamp – Typ: int64, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]
Rückgabe:
  • registrationId – Typ: uint64

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().

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

Für weekday:

  • real_time_clock_v2_bricklet.WeekdayMonday = 1
  • real_time_clock_v2_bricklet.WeekdayTuesday = 2
  • real_time_clock_v2_bricklet.WeekdayWednesday = 3
  • real_time_clock_v2_bricklet.WeekdayThursday = 4
  • real_time_clock_v2_bricklet.WeekdayFriday = 5
  • real_time_clock_v2_bricklet.WeekdaySaturday = 6
  • real_time_clock_v2_bricklet.WeekdaySunday = 7

Virtuelle Funktionen

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.

func (*RealTimeClockV2Bricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*RealTimeClockV2Bricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: error

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:

  • real_time_clock_v2_bricklet.FunctionSetDateTime = 1
  • real_time_clock_v2_bricklet.FunctionSetOffset = 4
  • real_time_clock_v2_bricklet.FunctionSetDateTimeCallbackConfiguration = 6
  • real_time_clock_v2_bricklet.FunctionSetAlarm = 8
  • real_time_clock_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • real_time_clock_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • real_time_clock_v2_bricklet.FunctionReset = 243
  • real_time_clock_v2_bricklet.FunctionWriteUID = 248
func (*RealTimeClockV2Bricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

  • real_time_clock_v2_bricklet.FunctionSetDateTime = 1
  • real_time_clock_v2_bricklet.FunctionSetOffset = 4
  • real_time_clock_v2_bricklet.FunctionSetDateTimeCallbackConfiguration = 6
  • real_time_clock_v2_bricklet.FunctionSetAlarm = 8
  • real_time_clock_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • real_time_clock_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • real_time_clock_v2_bricklet.FunctionReset = 243
  • real_time_clock_v2_bricklet.FunctionWriteUID = 248
func (*RealTimeClockV2Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

real_time_clock_v2_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Real-Time Clock Bricklet 2.0 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_v2_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Real-Time Clock Bricklet 2.0 dar.