JavaScript - Real-Time Clock Bricklet 2.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

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rtc = new Tinkerforge.BrickletRealTimeClockV2(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, 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.BrickletRealTimeClockV2.WEEKDAY_MONDAY) {
                    console.log('Weekday: Monday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_TUESDAY) {
                    console.log('Weekday: Tuesday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_WEDNESDAY) {
                    console.log('Weekday: Wednesday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_THURSDAY) {
                    console.log('Weekday: Thursday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_FRIDAY) {
                    console.log('Weekday: Friday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_SATURDAY) {
                    console.log('Weekday: Saturday');
                }
                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_SUNDAY) {
                    console.log('Weekday: Sunday');
                }

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

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rtc = new Tinkerforge.BrickletRealTimeClockV2(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)
        rtc.setDateTimeCallbackConfiguration(5000);
    }
);

// Register date and time callback
rtc.on(Tinkerforge.BrickletRealTimeClockV2.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.BrickletRealTimeClockV2.WEEKDAY_MONDAY) {
            console.log('Weekday: Monday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_TUESDAY) {
            console.log('Weekday: Tuesday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_WEDNESDAY) {
            console.log('Weekday: Wednesday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_THURSDAY) {
            console.log('Weekday: Thursday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_FRIDAY) {
            console.log('Weekday: Friday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_SATURDAY) {
            console.log('Weekday: Saturday');
        }
        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.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 (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

<!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 2.0 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.BrickletRealTimeClockV2(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, 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.BrickletRealTimeClockV2.WEEKDAY_MONDAY) {
                                    textArea.value += 'Weekday: Monday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_TUESDAY) {
                                    textArea.value += 'Weekday: Tuesday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_WEDNESDAY) {
                                    textArea.value += 'Weekday: Wednesday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_THURSDAY) {
                                    textArea.value += 'Weekday: Thursday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_FRIDAY) {
                                    textArea.value += 'Weekday: Friday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_SATURDAY) {
                                    textArea.value += 'Weekday: Saturday\n';
                                }
                                else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_SUNDAY) {
                                    textArea.value += 'Weekday: Sunday\n';
                                }

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

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

<!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 2.0 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.BrickletRealTimeClockV2(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)
                        rtc.setDateTimeCallbackConfiguration(5000);
                    }
                );

                // Register date and time callback
                rtc.on(Tinkerforge.BrickletRealTimeClockV2.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.BrickletRealTimeClockV2.WEEKDAY_MONDAY) {
                            textArea.value += 'Weekday: Monday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_TUESDAY) {
                            textArea.value += 'Weekday: Tuesday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_WEDNESDAY) {
                            textArea.value += 'Weekday: Wednesday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_THURSDAY) {
                            textArea.value += 'Weekday: Thursday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_FRIDAY) {
                            textArea.value += 'Weekday: Friday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_SATURDAY) {
                            textArea.value += 'Weekday: Saturday\n';
                        }
                        else if(weekday === Tinkerforge.BrickletRealTimeClockV2.WEEKDAY_SUNDAY) {
                            textArea.value += 'Weekday: Sunday\n';
                        }

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

Basic Functions¶

new BrickletRealTimeClockV2(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	realTimeClockV2 – Type: BrickletRealTimeClockV2

Creates an object with the unique device ID uid:

var realTimeClockV2 = new BrickletRealTimeClockV2("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

BrickletRealTimeClockV2.setDateTime(year, month, day, hour, minute, second, centisecond, weekday[, returnCallback][, errorCallback])¶

Parameters:	year – Type: int, Range: [2000 to 2099] month – Type: int, Range: [1 to 12] day – Type: int, Range: [1 to 31] hour – Type: int, Range: [0 to 23] minute – Type: int, Range: [0 to 59] second – Type: int, Range: [0 to 59] centisecond – Type: int, Range: [0 to 99] weekday – Type: int, Range: See constants
Callback Parameters:	undefined
Returns:	undefined

Sets the current date (including weekday) and the current time.

If the backup battery is installed then the real-time clock keeps date and time even if the Bricklet is not powered by a Brick.

The real-time clock handles leap year and inserts the 29th of February accordingly. But leap seconds, time zones and daylight saving time are not handled.

The following constants are available for this function:

For weekday:

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

BrickletRealTimeClockV2.getDateTime([returnCallback][, errorCallback])¶

Callback Parameters:	year – Type: int, Range: [2000 to 2099] month – Type: int, Range: [1 to 12] day – Type: int, Range: [1 to 31] hour – Type: int, Range: [0 to 23] minute – Type: int, Range: [0 to 59] second – Type: int, Range: [0 to 59] centisecond – Type: int, Range: [0 to 99] weekday – Type: int, Range: See constants timestamp – Type: int, Unit: 1 ms, Range: [-263 to 263 - 1]
Returns:	undefined

Returns the current date (including weekday) and the current time of the real-time.

The timestamp represents the current date and the the current time of the real-time clock converted to milliseconds and is an offset to 2000-01-01 00:00:00.0000.

The following constants are available for this function:

For weekday:

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

BrickletRealTimeClockV2.getTimestamp([returnCallback][, errorCallback])¶

Callback Parameters:	timestamp – Type: int, Unit: 1 ms, Range: [-263 to 263 - 1]
Returns:	undefined

Returns the current date and the time of the real-time clock converted to milliseconds. The timestamp has an effective resolution of hundredths of a second and is an offset to 2000-01-01 00:00:00.0000.

Advanced Functions¶

BrickletRealTimeClockV2.setOffset(offset[, returnCallback][, errorCallback])¶

Parameters:	offset – Type: int, Unit: 217/100 ppm, Range: [-128 to 127]
Callback Parameters:	undefined
Returns:	undefined

Sets the offset the real-time clock should compensate for in 2.17 ppm steps between -277.76 ppm (-128) and +275.59 ppm (127).

The real-time clock time can deviate from the actual time due to the frequency deviation of its 32.768 kHz crystal. Even without compensation (factory default) the resulting time deviation should be at most ±20 ppm (±52.6 seconds per month).

This deviation can be calculated by comparing the same duration measured by the real-time clock (rtc_duration) an accurate reference clock (ref_duration).

For best results the configured offset should be set to 0 ppm first and then a duration of at least 6 hours should be measured.

The new offset (new_offset) can be calculated from the currently configured offset (current_offset) and the measured durations as follow:

new_offset = current_offset - round(1000000 * (rtc_duration - ref_duration) / rtc_duration / 2.17)

If you want to calculate the offset, then we recommend using the calibration dialog in Brick Viewer, instead of doing it manually.

The offset is saved in the EEPROM of the Bricklet and only needs to be configured once.

BrickletRealTimeClockV2.getOffset([returnCallback][, errorCallback])¶

Callback Parameters:	offset – Type: int, Unit: 217/100 ppm, Range: [-128 to 127]
Returns:	undefined

Returns the offset as set by setOffset().

BrickletRealTimeClockV2.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback Parameters:	errorCountAckChecksum – Type: int, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: int, Range: [0 to 232 - 1] errorCountFrame – Type: int, Range: [0 to 232 - 1] errorCountOverflow – Type: int, Range: [0 to 232 - 1]
Returns:	undefined

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletRealTimeClockV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

Parameters:	config – Type: int, Range: See constants, Default: 3
Callback Parameters:	undefined
Returns:	undefined

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

• BrickletRealTimeClockV2.STATUS_LED_CONFIG_OFF = 0
• BrickletRealTimeClockV2.STATUS_LED_CONFIG_ON = 1
• BrickletRealTimeClockV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletRealTimeClockV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletRealTimeClockV2.getStatusLEDConfig([returnCallback][, errorCallback])¶

Callback Parameters:	config – Type: int, Range: See constants, Default: 3
Returns:	undefined

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

• BrickletRealTimeClockV2.STATUS_LED_CONFIG_OFF = 0
• BrickletRealTimeClockV2.STATUS_LED_CONFIG_ON = 1
• BrickletRealTimeClockV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletRealTimeClockV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletRealTimeClockV2.getChipTemperature([returnCallback][, errorCallback])¶

Callback Parameters:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:	undefined

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletRealTimeClockV2.reset([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletRealTimeClockV2.getIdentity([returnCallback][, errorCallback])¶

Callback Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

Returns:

undefined

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

BrickletRealTimeClockV2.on(callback_id, function[, errorCallback])¶

Parameters:	callback_id – Type: int function – Type: function
Returns:	undefined

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletRealTimeClockV2.setDateTimeCallbackConfiguration(period[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the period with which the CALLBACK_DATE_TIME callback is triggered periodically. A value of 0 turns the callback off.

BrickletRealTimeClockV2.getDateTimeCallbackConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:	undefined

Returns the period as set by setDateTimeCallbackConfiguration().

BrickletRealTimeClockV2.setAlarm(month, day, hour, minute, second, weekday, interval[, returnCallback][, errorCallback])¶

Parameters:	month – Type: int, Range: [-1, 1 to 12] with constants day – Type: int, Range: [-1, 1 to 31] with constants hour – Type: int, Range: [-1, 0 to 23] with constants minute – Type: int, Range: [-1, 0 to 59] with constants second – Type: int, Range: [-1, 0 to 59] with constants weekday – Type: int, Range: [-1, 1 to 7] with constants interval – Type: int, Unit: 1 s, Range: [-1, 1 to 231 - 1] with constants
Callback Parameters:	undefined
Returns:	undefined

Configures a repeatable alarm. The CALLBACK_ALARM callback is triggered if the current date and time matches the configured alarm.

Setting a parameter to -1 means that it should be disabled and doesn't take part in the match. Setting all parameters to -1 disables the alarm completely.

For example, to make the alarm trigger every day at 7:30 AM it can be configured as (-1, -1, 7, 30, -1, -1, -1). The hour is set to match 7 and the minute is set to match 30. The alarm is triggered if all enabled parameters match.

The interval has a special role. It allows to make the alarm reconfigure itself. This is useful if you need a repeated alarm that cannot be expressed by matching the current date and time. For example, to make the alarm trigger every 23 seconds it can be configured as (-1, -1, -1, -1, -1, -1, 23). Internally the Bricklet will take the current date and time, add 23 seconds to it and set the result as its alarm. The first alarm will be triggered 23 seconds after the call. Because the interval is not -1, the Bricklet will do the same again internally, take the current date and time, add 23 seconds to it and set that as its alarm. This results in a repeated alarm that triggers every 23 seconds.

The interval can also be used in combination with the other parameters. For example, configuring the alarm as (-1, -1, 7, 30, -1, -1, 300) results in an alarm that triggers every day at 7:30 AM and is then repeated every 5 minutes.

The following constants are available for this function:

For month:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For day:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For hour:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For minute:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For second:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For weekday:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For interval:

• BrickletRealTimeClockV2.ALARM_INTERVAL_DISABLED = -1

BrickletRealTimeClockV2.getAlarm([returnCallback][, errorCallback])¶

Callback Parameters:

month – Type: int, Range: [-1, 1 to 12] with constants day – Type: int, Range: [-1, 1 to 31] with constants hour – Type: int, Range: [-1, 0 to 23] with constants minute – Type: int, Range: [-1, 0 to 59] with constants second – Type: int, Range: [-1, 0 to 59] with constants weekday – Type: int, Range: [-1, 1 to 7] with constants interval – Type: int, Unit: 1 s, Range: [-1, 1 to 231 - 1] with constants

Returns:

undefined

Returns the alarm configuration as set by setAlarm().

The following constants are available for this function:

For month:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For day:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For hour:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For minute:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For second:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For weekday:

• BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1

For interval:

• BrickletRealTimeClockV2.ALARM_INTERVAL_DISABLED = -1

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

realTimeClockV2.on(BrickletRealTimeClockV2.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and type of parameters are described below.

BrickletRealTimeClockV2.CALLBACK_DATE_TIME¶

Callback Parameters:	year – Type: int, Range: [2000 to 2099] month – Type: int, Range: [1 to 12] day – Type: int, Range: [1 to 31] hour – Type: int, Range: [0 to 23] minute – Type: int, Range: [0 to 59] second – Type: int, Range: [0 to 59] centisecond – Type: int, Range: [0 to 99] weekday – Type: int, Range: See constants timestamp – Type: int, Unit: 1 ms, Range: [-263 to 263 - 1]

This callback is triggered periodically with the period that is set by setDateTimeCallbackConfiguration(). The parameters are the same as for getDateTime().

The following constants are available for this function:

For weekday:

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

BrickletRealTimeClockV2.CALLBACK_ALARM¶

Callback Parameters:	year – Type: int, Range: [2000 to 2099] month – Type: int, Range: [1 to 12] day – Type: int, Range: [1 to 31] hour – Type: int, Range: [0 to 23] minute – Type: int, Range: [0 to 59] second – Type: int, Range: [0 to 59] centisecond – Type: int, Range: [0 to 99] weekday – Type: int, Range: See constants timestamp – Type: int, Unit: 1 ms, Range: [-263 to 263 - 1]

This callback is triggered every time the current date and time matches the configured alarm (see setAlarm()). The parameters are the same as for getDateTime().

The following constants are available for this function:

For weekday:

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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletRealTimeClockV2.getAPIVersion()¶

Returns:	apiVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletRealTimeClockV2.getResponseExpected(functionId[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickletRealTimeClockV2.FUNCTION_SET_DATE_TIME = 1
• BrickletRealTimeClockV2.FUNCTION_SET_OFFSET = 4
• BrickletRealTimeClockV2.FUNCTION_SET_DATE_TIME_CALLBACK_CONFIGURATION = 6
• BrickletRealTimeClockV2.FUNCTION_SET_ALARM = 8
• BrickletRealTimeClockV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletRealTimeClockV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletRealTimeClockV2.FUNCTION_RESET = 243
• BrickletRealTimeClockV2.FUNCTION_WRITE_UID = 248

BrickletRealTimeClockV2.setResponseExpected(functionId, responseExpected[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants responseExpected – Type: boolean
Returns:	undefined

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickletRealTimeClockV2.FUNCTION_SET_DATE_TIME = 1
• BrickletRealTimeClockV2.FUNCTION_SET_OFFSET = 4
• BrickletRealTimeClockV2.FUNCTION_SET_DATE_TIME_CALLBACK_CONFIGURATION = 6
• BrickletRealTimeClockV2.FUNCTION_SET_ALARM = 8
• BrickletRealTimeClockV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletRealTimeClockV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletRealTimeClockV2.FUNCTION_RESET = 243
• BrickletRealTimeClockV2.FUNCTION_WRITE_UID = 248

BrickletRealTimeClockV2.setResponseExpectedAll(responseExpected)¶

Parameters:	responseExpected – Type: boolean
Returns:	undefined

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletRealTimeClockV2.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

Parameters:	mode – Type: int, Range: See constants
Callback Parameters:	status – Type: int, Range: See constants
Returns:	undefined

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

• BrickletRealTimeClockV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletRealTimeClockV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletRealTimeClockV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletRealTimeClockV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletRealTimeClockV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletRealTimeClockV2.BOOTLOADER_STATUS_OK = 0
• BrickletRealTimeClockV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletRealTimeClockV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletRealTimeClockV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletRealTimeClockV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletRealTimeClockV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletRealTimeClockV2.getBootloaderMode([returnCallback][, errorCallback])¶

Callback Parameters:	mode – Type: int, Range: See constants
Returns:	undefined

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

• BrickletRealTimeClockV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletRealTimeClockV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletRealTimeClockV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletRealTimeClockV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletRealTimeClockV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletRealTimeClockV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Callback Parameters:	undefined
Returns:	undefined

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletRealTimeClockV2.writeFirmware(data[, returnCallback][, errorCallback])¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Callback Parameters:	status – Type: int, Range: [0 to 255]
Returns:	undefined

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletRealTimeClockV2.writeUID(uid[, returnCallback][, errorCallback])¶

Parameters:	uid – Type: int, Range: [0 to 232 - 1]
Callback Parameters:	undefined
Returns:	undefined

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletRealTimeClockV2.readUID([returnCallback][, errorCallback])¶

Callback Parameters:	uid – Type: int, Range: [0 to 232 - 1]
Returns:	undefined

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

BrickletRealTimeClockV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Real-Time Clock Bricklet 2.0.

The getIdentity() function and the IPConnection.CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletRealTimeClockV2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Real-Time Clock Bricklet 2.0.