C# - Real-Time Clock Bricklet¶

Simple¶

Download (ExampleSimple.cs)

 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

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Real-Time Clock Bricklet

    static void Main()
    {
        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
        int year; byte month, day, hour, minute, second, centisecond, weekday;
        rtc.GetDateTime(out year, out month, out day, out hour, out minute, out second,
                        out centisecond, out weekday);

        Console.WriteLine("Year: " + year);
        Console.WriteLine("Month: " + month);
        Console.WriteLine("Day: " + day);
        Console.WriteLine("Hour: " + hour);
        Console.WriteLine("Minute: " + minute);
        Console.WriteLine("Second: " + second);
        Console.WriteLine("Centisecond: " + centisecond);

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

        // Get current timestamp
        long timestamp = rtc.GetTimestamp();
        Console.WriteLine("Timestamp: " + timestamp + " ms");

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback¶

Download (ExampleCallback.cs)

 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

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Real-Time Clock Bricklet

    // Callback function for date and time callback
    static void DateTimeCB(BrickletRealTimeClock sender, int year, byte month, byte day,
                           byte hour, byte minute, byte second, byte centisecond,
                           byte weekday, long timestamp)
    {
        Console.WriteLine("Year: " + year);
        Console.WriteLine("Month: " + month);
        Console.WriteLine("Day: " + day);
        Console.WriteLine("Hour: " + hour);
        Console.WriteLine("Minute: " + minute);
        Console.WriteLine("Second: " + second);
        Console.WriteLine("Centisecond: " + centisecond);

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

        Console.WriteLine("Timestamp: " + timestamp);
        Console.WriteLine("");
    }

    static void Main()
    {
        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

        // Register date and time callback to function DateTimeCB
        rtc.DateTimeCallback += DateTimeCB;

        // 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);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Basic Functions¶

class BrickletRealTimeClock(string uid, IPConnection ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	realTimeClock – Type: BrickletRealTimeClock

Creates an object with the unique device ID uid:

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

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

void BrickletRealTimeClock.SetDateTime(int year, byte month, byte day, byte hour, byte minute, byte second, byte centisecond, byte weekday)¶

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

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:

• 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

void BrickletRealTimeClock.GetDateTime(out int year, out byte month, out byte day, out byte hour, out byte minute, out byte second, out byte centisecond, out byte weekday)¶

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

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

The following constants are available for this function:

For 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()¶

Returns:	timestamp – Type: long, Unit: 1 ms, Range: [-263 to 263 - 1]

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

Advanced Functions¶

void BrickletRealTimeClock.SetOffset(short offset)¶

Parameters:	offset – Type: short, Unit: 217/100 ppm, Range: [-128 to 127]

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.

short BrickletRealTimeClock.GetOffset()¶

Returns:	offset – Type: short, Unit: 217/100 ppm, Range: [-128 to 127]

Returns the offset as set by SetOffset().

void BrickletRealTimeClock.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Output 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: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] firmwareVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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¶

void BrickletRealTimeClock.SetDateTimeCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The DateTimeCallback Callback is only triggered if the date or time changed since the last triggering.

New in version 2.0.1 (Plugin).

long BrickletRealTimeClock.GetDateTimeCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetDateTimeCallbackPeriod().

New in version 2.0.1 (Plugin).

void BrickletRealTimeClock.SetAlarm(short month, short day, short hour, short minute, short second, short weekday, int interval)¶

Parameters:

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

Configures a repeatable alarm. The AlarmCallback 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:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For day:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For hour:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For minute:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For second:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For weekday:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For interval:

• BrickletRealTimeClock.ALARM_INTERVAL_DISABLED = -1

New in version 2.0.1 (Plugin).

void BrickletRealTimeClock.GetAlarm(out short month, out short day, out short hour, out short minute, out short second, out short weekday, out int interval)¶

Output Parameters:

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

Returns the alarm configuration as set by SetAlarm().

The following constants are available for this function:

For month:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For day:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For hour:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For minute:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For second:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For weekday:

• BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For interval:

• BrickletRealTimeClock.ALARM_INTERVAL_DISABLED = -1

New in version 2.0.1 (Plugin).

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by appending your callback handler to the corresponding event:

void MyCallback(BrickletRealTimeClock sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

realTimeClock.ExampleCallback += MyCallback;

The available events are described below.

event BrickletRealTimeClock.DateTimeCallback(BrickletRealTimeClock sender, int year, byte month, byte day, byte hour, byte minute, byte second, byte centisecond, byte weekday, long timestamp)¶

Callback Parameters:

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

This callback is triggered periodically with the period that is set by SetDateTimeCallbackPeriod(). The parameters are the same as for GetDateTime() and GetTimestamp() combined.

The DateTimeCallback callback is only triggered if the date or time changed since the last triggering.

The following constants are available for this function:

For 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

New in version 2.0.1 (Plugin).

event BrickletRealTimeClock.AlarmCallback(BrickletRealTimeClock sender, int year, byte month, byte day, byte hour, byte minute, byte second, byte centisecond, byte weekday, long timestamp)¶

Callback Parameters:

sender – Type: BrickletRealTimeClock year – Type: int, Range: [2000 to 2099] month – Type: byte, Range: [1 to 12] day – Type: byte, Range: [1 to 31] hour – Type: byte, Range: [0 to 23] minute – Type: byte, Range: [0 to 59] second – Type: byte, Range: [0 to 59] centisecond – Type: byte, Range: [0 to 99] weekday – Type: byte, Range: See constants timestamp – Type: long, 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() and GetTimestamp() combined.

The following constants are available for this function:

For 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

New in version 2.0.1 (Plugin).

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.

byte[] BrickletRealTimeClock.GetAPIVersion()¶

Output Parameters:	apiVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, 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.

bool BrickletRealTimeClock.GetResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: bool

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 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(byte functionId, bool responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: bool

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 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(bool responseExpected)¶

Parameters:	responseExpected – Type: bool

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

Constants¶

int BrickletRealTimeClock.DEVICE_IDENTIFIER¶

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

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletRealTimeClock.DEVICE_DISPLAY_NAME¶

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