Java - Real-Time Clock Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRealTimeClock;
import com.tinkerforge.BrickletRealTimeClock.DateTime;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Real-Time Clock Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRealTimeClock rtc = new BrickletRealTimeClock(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Get current date and time
        DateTime dateTime = rtc.getDateTime(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("Year: " + dateTime.year);
        System.out.println("Month: " + dateTime.month);
        System.out.println("Day: " + dateTime.day);
        System.out.println("Hour: " + dateTime.hour);
        System.out.println("Minute: " + dateTime.minute);
        System.out.println("Second: " + dateTime.second);
        System.out.println("Centisecond: " + dateTime.centisecond);

        if(dateTime.weekday == BrickletRealTimeClock.WEEKDAY_MONDAY) {
            System.out.println("Weekday: Monday");
        } else if(dateTime.weekday == BrickletRealTimeClock.WEEKDAY_TUESDAY) {
            System.out.println("Weekday: Tuesday");
        } else if(dateTime.weekday == BrickletRealTimeClock.WEEKDAY_WEDNESDAY) {
            System.out.println("Weekday: Wednesday");
        } else if(dateTime.weekday == BrickletRealTimeClock.WEEKDAY_THURSDAY) {
            System.out.println("Weekday: Thursday");
        } else if(dateTime.weekday == BrickletRealTimeClock.WEEKDAY_FRIDAY) {
            System.out.println("Weekday: Friday");
        } else if(dateTime.weekday == BrickletRealTimeClock.WEEKDAY_SATURDAY) {
            System.out.println("Weekday: Saturday");
        } else if(dateTime.weekday == BrickletRealTimeClock.WEEKDAY_SUNDAY) {
            System.out.println("Weekday: Sunday");
        }

        // Get current timestamp
        long timestamp = rtc.getTimestamp(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Timestamp: " + timestamp + " ms");

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback

Download (ExampleCallback.java)

 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
58
59
60
61
62
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRealTimeClock;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Real-Time Clock Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRealTimeClock rtc = new BrickletRealTimeClock(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Add date and time listener
        rtc.addDateTimeListener(new BrickletRealTimeClock.DateTimeListener() {
            public void dateTime(int year, short month, short day, short hour,
                                 short minute, short second, short centisecond,
                                 short weekday, long timestamp) {
                System.out.println("Year: " + year);
                System.out.println("Month: " + month);
                System.out.println("Day: " + day);
                System.out.println("Hour: " + hour);
                System.out.println("Minute: " + minute);
                System.out.println("Second: " + second);
                System.out.println("Centisecond: " + centisecond);

                if(weekday == BrickletRealTimeClock.WEEKDAY_MONDAY) {
                    System.out.println("Weekday: Monday");
                } else if(weekday == BrickletRealTimeClock.WEEKDAY_TUESDAY) {
                    System.out.println("Weekday: Tuesday");
                } else if(weekday == BrickletRealTimeClock.WEEKDAY_WEDNESDAY) {
                    System.out.println("Weekday: Wednesday");
                } else if(weekday == BrickletRealTimeClock.WEEKDAY_THURSDAY) {
                    System.out.println("Weekday: Thursday");
                } else if(weekday == BrickletRealTimeClock.WEEKDAY_FRIDAY) {
                    System.out.println("Weekday: Friday");
                } else if(weekday == BrickletRealTimeClock.WEEKDAY_SATURDAY) {
                    System.out.println("Weekday: Saturday");
                } else if(weekday == BrickletRealTimeClock.WEEKDAY_SUNDAY) {
                    System.out.println("Weekday: Sunday");
                }

                System.out.println("Timestamp: " + timestamp);
                System.out.println("");
            }
        });

        // Set period for date and time callback 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);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API

Prinzipiell kann jede Methode der Java Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletRealTimeClock(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • realTimeClock – Typ: BrickletRealTimeClock

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

BrickletRealTimeClock realTimeClock = new BrickletRealTimeClock("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

void BrickletRealTimeClock.setDateTime(int year, short month, short day, short hour, short minute, short second, short centisecond, short weekday)
Parameter:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: short, Wertebereich: [1 bis 12]
  • day – Typ: short, Wertebereich: [1 bis 31]
  • hour – Typ: short, Wertebereich: [0 bis 23]
  • minute – Typ: short, Wertebereich: [0 bis 59]
  • second – Typ: short, Wertebereich: [0 bis 59]
  • centisecond – Typ: short, Wertebereich: [0 bis 99]
  • weekday – Typ: short, Wertebereich: Siehe Konstanten

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:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7
BrickletRealTimeClock.DateTime BrickletRealTimeClock.getDateTime()
Rückgabeobjekt:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: short, Wertebereich: [1 bis 12]
  • day – Typ: short, Wertebereich: [1 bis 31]
  • hour – Typ: short, Wertebereich: [0 bis 23]
  • minute – Typ: short, Wertebereich: [0 bis 59]
  • second – Typ: short, Wertebereich: [0 bis 59]
  • centisecond – Typ: short, Wertebereich: [0 bis 99]
  • weekday – Typ: short, Wertebereich: Siehe Konstanten

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:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7
long BrickletRealTimeClock.getTimestamp()
Rückgabe:
  • timestamp – Typ: long, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

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.

Fortgeschrittene Funktionen

void BrickletRealTimeClock.setOffset(byte offset)
Parameter:
  • offset – Typ: byte, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]

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.

byte BrickletRealTimeClock.getOffset()
Rückgabe:
  • offset – Typ: byte, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]

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

BrickletRealTimeClock.Identity BrickletRealTimeClock.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'i', 'z']
  • hardwareVersion – Typ: short[], Länge: 3
    • 0: major – Typ: short, Wertebereich: [0 bis 255]
    • 1: minor – Typ: short, Wertebereich: [0 bis 255]
    • 2: revision – Typ: short, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3
    • 0: major – Typ: short, Wertebereich: [0 bis 255]
    • 1: minor – Typ: short, Wertebereich: [0 bis 255]
    • 2: revision – Typ: short, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Listener

void BrickletRealTimeClock.setDateTimeCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Der DateTimeListener Listener 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).

long BrickletRealTimeClock.getDateTimeCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Neu in Version 2.0.1 (Plugin).

void BrickletRealTimeClock.setAlarm(byte month, byte day, byte hour, byte minute, byte second, byte weekday, int interval)
Parameter:
  • month – Typ: byte, Wertebereich: [-1, 2000 bis 2099] mit Konstanten
  • day – Typ: byte, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • hour – Typ: byte, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • minute – Typ: byte, Wertebereich: [-1 bis 23] mit Konstanten
  • second – Typ: byte, Wertebereich: [-1 bis 59] mit Konstanten
  • weekday – Typ: byte, Wertebereich: [-1 bis 59] mit Konstanten
  • interval – Typ: int, Einheit: 1 s, Wertebereich: Siehe Konstanten

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

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für day:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für hour:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für minute:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für second:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für weekday:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für interval:

  • BrickletRealTimeClock.ALARM_INTERVAL_DISABLED = -1

Neu in Version 2.0.1 (Plugin).

BrickletRealTimeClock.Alarm BrickletRealTimeClock.getAlarm()
Rückgabeobjekt:
  • month – Typ: byte, Wertebereich: [-1, 2000 bis 2099] mit Konstanten
  • day – Typ: byte, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • hour – Typ: byte, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • minute – Typ: byte, Wertebereich: [-1 bis 23] mit Konstanten
  • second – Typ: byte, Wertebereich: [-1 bis 59] mit Konstanten
  • weekday – Typ: byte, Wertebereich: [-1 bis 59] mit Konstanten
  • interval – Typ: int, Einheit: 1 s, Wertebereich: Siehe Konstanten

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

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

Für month:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für day:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für hour:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für minute:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für second:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für weekday:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

Für interval:

  • BrickletRealTimeClock.ALARM_INTERVAL_DISABLED = -1

Neu in Version 2.0.1 (Plugin).

Listener

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

device.addExampleListener(new BrickletRealTimeClock.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden remove*Listener() wieder zu entfernen.

Bemerkung

Listener 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.

class BrickletRealTimeClock.DateTimeListener()

Dieser Listener kann mit der Funktion addDateTimeListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeDateTimeListener() wieder entfernt werden.

void dateTime(int year, short month, short day, short hour, short minute, short second, short centisecond, short weekday, long timestamp)
Parameter:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: short, Wertebereich: [1 bis 12]
  • day – Typ: short, Wertebereich: [1 bis 31]
  • hour – Typ: short, Wertebereich: [0 bis 23]
  • minute – Typ: short, Wertebereich: [0 bis 59]
  • second – Typ: short, Wertebereich: [0 bis 59]
  • centisecond – Typ: short, Wertebereich: [0 bis 99]
  • weekday – Typ: short, Wertebereich: Siehe Konstanten
  • timestamp – Typ: long, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

Dieser Listener wird mit der Periode, wie gesetzt mit setDateTimeCallbackPeriod(), ausgelöst. Die Parameter sind die gleichen wie die von getDateTime() und getTimestamp() kombiniert.

Der DateTimeListener Listener 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:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7

Neu in Version 2.0.1 (Plugin).

class BrickletRealTimeClock.AlarmListener()

Dieser Listener kann mit der Funktion addAlarmListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeAlarmListener() wieder entfernt werden.

void alarm(int year, short month, short day, short hour, short minute, short second, short centisecond, short weekday, long timestamp)
Parameter:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: short, Wertebereich: [1 bis 12]
  • day – Typ: short, Wertebereich: [1 bis 31]
  • hour – Typ: short, Wertebereich: [0 bis 23]
  • minute – Typ: short, Wertebereich: [0 bis 59]
  • second – Typ: short, Wertebereich: [0 bis 59]
  • centisecond – Typ: short, Wertebereich: [0 bis 99]
  • weekday – Typ: short, Wertebereich: Siehe Konstanten
  • timestamp – Typ: long, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

Dieser Listener wird jedes mal ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe setAlarm()). Die Parameter sind die gleichen wie die von getDateTime() und getTimestamp() kombiniert.

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

Für weekday:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7

Neu in Version 2.0.1 (Plugin).

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.

short[] BrickletRealTimeClock.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: short[], Länge: 3
    • 0: major – Typ: short, Wertebereich: [0 bis 255]
    • 1: minor – Typ: short, Wertebereich: [0 bis 255]
    • 2: revision – Typ: short, Wertebereich: [0 bis 255]

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.

boolean BrickletRealTimeClock.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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

  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME = 1
  • BrickletRealTimeClock.FUNCTION_SET_OFFSET = 4
  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • BrickletRealTimeClock.FUNCTION_SET_ALARM = 8
void BrickletRealTimeClock.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

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

  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME = 1
  • BrickletRealTimeClock.FUNCTION_SET_OFFSET = 4
  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • BrickletRealTimeClock.FUNCTION_SET_ALARM = 8
void BrickletRealTimeClock.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

Konstanten

int BrickletRealTimeClock.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Real-Time Clock Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateListener Listener der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletRealTimeClock.DEVICE_DISPLAY_NAME

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