JavaScript - Real-Time Clock Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback (Node.js)

Download (ExampleCallback.js)

 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
63
64
65
66
67
68
69
70
71
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Real-Time Clock Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rtc = new Tinkerforge.BrickletRealTimeClock(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // 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);
    }
);

// Register date and time callback
rtc.on(Tinkerforge.BrickletRealTimeClock.CALLBACK_DATE_TIME,
    // Callback function for date and time callback
    function (year, month, day, hour, minute, second, centisecond, weekday, timestamp) {
        console.log('Year: ' + year);
        console.log('Month: ' + month);
        console.log('Day: ' + day);
        console.log('Hour: ' + hour);
        console.log('Minute: ' + minute);
        console.log('Second: ' + second);
        console.log('Centisecond: ' + centisecond);

        if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_MONDAY) {
            console.log('Weekday: Monday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_TUESDAY) {
            console.log('Weekday: Tuesday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_WEDNESDAY) {
            console.log('Weekday: Wednesday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_THURSDAY) {
            console.log('Weekday: Thursday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_FRIDAY) {
            console.log('Weekday: Friday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_SATURDAY) {
            console.log('Weekday: Saturday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_SUNDAY) {
            console.log('Weekday: Sunday');
        }

        console.log('Timestamp: ' + timestamp);
        console.log();
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Simple (Node.js)

Download (ExampleSimple.js)

 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
63
64
65
66
67
68
69
70
71
72
73
74
75
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Real-Time Clock Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rtc = new Tinkerforge.BrickletRealTimeClock(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Get current date and time
        rtc.getDateTime(
            function (year, month, day, hour, minute, second, centisecond, weekday) {
                console.log('Year: ' + year);
                console.log('Month: ' + month);
                console.log('Day: ' + day);
                console.log('Hour: ' + hour);
                console.log('Minute: ' + minute);
                console.log('Second: ' + second);
                console.log('Centisecond: ' + centisecond);

                if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_MONDAY) {
                    console.log('Weekday: Monday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_TUESDAY) {
                    console.log('Weekday: Tuesday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_WEDNESDAY) {
                    console.log('Weekday: Wednesday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_THURSDAY) {
                    console.log('Weekday: Thursday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_FRIDAY) {
                    console.log('Weekday: Friday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_SATURDAY) {
                    console.log('Weekday: Saturday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_SUNDAY) {
                    console.log('Weekday: Sunday');
                }
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );

        // Get current timestamp
        rtc.getTimestamp(
            function (timestamp) {
                console.log('Timestamp: ' + timestamp + ' ms');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Callback (HTML)

Download (ExampleCallback.html), Test (ExampleCallback.html)

 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Real-Time Clock Bricklet Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var rtc = new Tinkerforge.BrickletRealTimeClock(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // 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);
                    }
                );

                // Register date and time callback
                rtc.on(Tinkerforge.BrickletRealTimeClock.CALLBACK_DATE_TIME,
                    // Callback function for date and time callback
                    function (year, month, day, hour, minute, second, centisecond, weekday, timestamp) {
                        textArea.value += 'Year: ' + year + '\n';
                        textArea.value += 'Month: ' + month + '\n';
                        textArea.value += 'Day: ' + day + '\n';
                        textArea.value += 'Hour: ' + hour + '\n';
                        textArea.value += 'Minute: ' + minute + '\n';
                        textArea.value += 'Second: ' + second + '\n';
                        textArea.value += 'Centisecond: ' + centisecond + '\n';

                        if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_MONDAY) {
                            textArea.value += 'Weekday: Monday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_TUESDAY) {
                            textArea.value += 'Weekday: Tuesday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_WEDNESDAY) {
                            textArea.value += 'Weekday: Wednesday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_THURSDAY) {
                            textArea.value += 'Weekday: Thursday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_FRIDAY) {
                            textArea.value += 'Weekday: Friday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_SATURDAY) {
                            textArea.value += 'Weekday: Saturday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_SUNDAY) {
                            textArea.value += 'Weekday: Sunday\n';
                        }

                        textArea.value += 'Timestamp: ' + timestamp + '\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Simple (HTML)

Download (ExampleSimple.html), Test (ExampleSimple.html)

 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Real-Time Clock Bricklet Simple Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var rtc = new Tinkerforge.BrickletRealTimeClock(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Get current date and time
                        rtc.getDateTime(
                            function (year, month, day, hour, minute, second, centisecond, weekday) {
                                textArea.value += 'Year: ' + year + '\n';
                                textArea.value += 'Month: ' + month + '\n';
                                textArea.value += 'Day: ' + day + '\n';
                                textArea.value += 'Hour: ' + hour + '\n';
                                textArea.value += 'Minute: ' + minute + '\n';
                                textArea.value += 'Second: ' + second + '\n';
                                textArea.value += 'Centisecond: ' + centisecond + '\n';

                                if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_MONDAY) {
                                    textArea.value += 'Weekday: Monday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_TUESDAY) {
                                    textArea.value += 'Weekday: Tuesday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_WEDNESDAY) {
                                    textArea.value += 'Weekday: Wednesday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_THURSDAY) {
                                    textArea.value += 'Weekday: Thursday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_FRIDAY) {
                                    textArea.value += 'Weekday: Friday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_SATURDAY) {
                                    textArea.value += 'Weekday: Saturday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClock.WEEKDAY_SUNDAY) {
                                    textArea.value += 'Weekday: Sunday\n';
                                }
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );

                        // Get current timestamp
                        rtc.getTimestamp(
                            function (timestamp) {
                                textArea.value += 'Timestamp: ' + timestamp + ' ms\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

API

Allgemein kann jede Funktion der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Funktion als Argumente aufgerufen, falls die Funktion ihre Ergebnisse asynchron zurückgibt. Die errorCallback-Funktion wird im Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der folgenden Werte sein:

  • IPConnection.ERROR_ALREADY_CONNECTED = 11
  • IPConnection.ERROR_NOT_CONNECTED = 12
  • IPConnection.ERROR_CONNECT_FAILED = 13
  • IPConnection.ERROR_INVALID_FUNCTION_ID = 21
  • IPConnection.ERROR_TIMEOUT = 31
  • IPConnection.ERROR_INVALID_PARAMETER = 41
  • IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
  • IPConnection.ERROR_UNKNOWN_ERROR = 43
  • IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
  • IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
  • IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
  • IPConnection.ERROR_DEVICE_REPLACED = 82
  • IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen

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

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

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletRealTimeClock.setDateTime(year, month, day, hour, minute, second, centisecond, weekday[, returnCallback][, errorCallback])
Parameter:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: int, Wertebereich: [1 bis 12]
  • day – Typ: int, Wertebereich: [1 bis 31]
  • hour – Typ: int, Wertebereich: [0 bis 23]
  • minute – Typ: int, Wertebereich: [0 bis 59]
  • second – Typ: int, Wertebereich: [0 bis 59]
  • centisecond – Typ: int, Wertebereich: [0 bis 99]
  • weekday – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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.getDateTime([returnCallback][, errorCallback])
Callback-Parameter:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: int, Wertebereich: [1 bis 12]
  • day – Typ: int, Wertebereich: [1 bis 31]
  • hour – Typ: int, Wertebereich: [0 bis 23]
  • minute – Typ: int, Wertebereich: [0 bis 59]
  • second – Typ: int, Wertebereich: [0 bis 59]
  • centisecond – Typ: int, Wertebereich: [0 bis 99]
  • weekday – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undefined

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
BrickletRealTimeClock.getTimestamp([returnCallback][, errorCallback])
Callback-Parameter:
  • timestamp – Typ: int, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]
Rückgabe:
  • undefined

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

BrickletRealTimeClock.setOffset(offset[, returnCallback][, errorCallback])
Parameter:
  • offset – Typ: int, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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.

BrickletRealTimeClock.getOffset([returnCallback][, errorCallback])
Callback-Parameter:
  • offset – Typ: int, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]
Rückgabe:
  • undefined

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

BrickletRealTimeClock.getIdentity([returnCallback][, errorCallback])
Callback-Parameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

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

BrickletRealTimeClock.on(callback_id, function)
Parameter:
  • callback_id – Typ: int
  • function – Typ: function
Rückgabe:
  • undefined

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletRealTimeClock.setDateTimeCallbackPeriod(period[, returnCallback][, errorCallback])
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

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

Der CALLBACK_DATE_TIME 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).

BrickletRealTimeClock.getDateTimeCallbackPeriod([returnCallback][, errorCallback])
Callback-Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • undefined

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

Neu in Version 2.0.1 (Plugin).

BrickletRealTimeClock.setAlarm(month, day, hour, minute, second, weekday, interval[, returnCallback][, errorCallback])
Parameter:
  • month – Typ: int, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • day – Typ: int, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • hour – Typ: int, Wertebereich: [-1, 0 bis 23] mit Konstanten
  • minute – Typ: int, Wertebereich: [-1, 0 bis 59] mit Konstanten
  • second – Typ: int, Wertebereich: [-1, 0 bis 59] mit Konstanten
  • weekday – Typ: int, Wertebereich: [-1, 1 bis 7] mit Konstanten
  • interval – Typ: int, Einheit: 1 s, Wertebereich: [-1, 1 bis 231 - 1] mit Konstanten
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Konfiguriert einen wiederholbaren Alarm. Der CALLBACK_ALARM Callback wird ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem konfigurierten Alarm übereinstimmen.

Wird ein Parameter auf -1 gesetzt, dann wird es deaktiviert und nimmt nicht am Übereinstimmungstest teil. Werden alle Parameter auf -1 gesetzt, dann ist der Alarm vollständig deaktiviert.

Um z.B. den Alarm jeden Tag um 7:30 Uhr auszulösen kann dieser auf (-1, -1, 7, 30, -1, -1, -1) konfiguriert werden. Die Stunde ist auf 7 gesetzt und die Minute auf 30. Der Alarm wird ausgelöst, wenn alle aktiven Parameter mit dem aktuellen Datum und der aktuellen Zeit übereinstimmen.

Das Intervall hat eine spezielle Rolle. Wenn es nicht auf -1 gesetzt ist, dann konfiguriert sich der Alarm nach jeder Auslösung entsprechend selbst neu. Dies kann für wiederholende Alarme genutzt werden, die nicht durch Übereinstimmung mit Datum und Uhrzeit abgebildet werden können. Um z.B. alle 23 Sekunden einen Alarm auszulösen kann dieser als (-1, -1, -1, -1, -1, -1, 23) konfiguriert werden. Intern nimmt das Bricklet das aktuelle Datum und die aktuelle Uhrzeit, addiert 23 Sekunden und setzt das Ergebnis als Alarm. Der erste Alarm wir dann 23 Sekunden nach dem Aufruf ausgelöst werden. Da das Intervall nicht -1 ist wird das Bricklet dann intern wieder das gleiche tun: 23 Sekunden auf das aktuelle Datum und die aktuelle Uhrzeit addieren und das Ergebnis als Alarm setzten. Dadurch entsteht ein sich alle 23 Sekunden wiederholender Alarm.

Das Intervall kann auch in Kombination mit den anderen Parametern verwendet werden. Wird z.B. der Alarm auf (-1, -1, 7, 30, -1, -1, 300) konfiguriert dann wird der Alarm jeden Tag um 7:30 Uhr ausgelöst und dann all 5 Minuten wiederholt.

Die folgenden 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.getAlarm([returnCallback][, errorCallback])
Callback-Parameter:
  • month – Typ: int, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • day – Typ: int, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • hour – Typ: int, Wertebereich: [-1, 0 bis 23] mit Konstanten
  • minute – Typ: int, Wertebereich: [-1, 0 bis 59] mit Konstanten
  • second – Typ: int, Wertebereich: [-1, 0 bis 59] mit Konstanten
  • weekday – Typ: int, Wertebereich: [-1, 1 bis 7] mit Konstanten
  • interval – Typ: int, Einheit: 1 s, Wertebereich: [-1, 1 bis 231 - 1] mit Konstanten
Rückgabe:
  • undefined

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion on() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

realTimeClock.on(BrickletRealTimeClock.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletRealTimeClock.CALLBACK_DATE_TIME
Callback-Parameter:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: int, Wertebereich: [1 bis 12]
  • day – Typ: int, Wertebereich: [1 bis 31]
  • hour – Typ: int, Wertebereich: [0 bis 23]
  • minute – Typ: int, Wertebereich: [0 bis 59]
  • second – Typ: int, Wertebereich: [0 bis 59]
  • centisecond – Typ: int, Wertebereich: [0 bis 99]
  • weekday – Typ: int, Wertebereich: Siehe Konstanten
  • timestamp – Typ: int, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

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

Der CALLBACK_DATE_TIME 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:

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

BrickletRealTimeClock.CALLBACK_ALARM
Callback-Parameter:
  • year – Typ: int, Wertebereich: [2000 bis 2099]
  • month – Typ: int, Wertebereich: [1 bis 12]
  • day – Typ: int, Wertebereich: [1 bis 31]
  • hour – Typ: int, Wertebereich: [0 bis 23]
  • minute – Typ: int, Wertebereich: [0 bis 59]
  • second – Typ: int, Wertebereich: [0 bis 59]
  • centisecond – Typ: int, Wertebereich: [0 bis 99]
  • weekday – Typ: int, Wertebereich: Siehe Konstanten
  • timestamp – Typ: int, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

Dieser Callback wird jedes mal ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe 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.

BrickletRealTimeClock.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, 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.

BrickletRealTimeClock.getResponseExpected(functionId[, errorCallback])
Parameter:
  • functionId – Typ: int, 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 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 function_id:

  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME = 1
  • BrickletRealTimeClock.FUNCTION_SET_OFFSET = 4
  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • BrickletRealTimeClock.FUNCTION_SET_ALARM = 8
BrickletRealTimeClock.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean
Rückgabe:
  • undefined

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

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

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

Konstanten

BrickletRealTimeClock.DEVICE_IDENTIFIER

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

Die getIdentity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletRealTimeClock.DEVICE_DISPLAY_NAME

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