C# - Real-Time Clock Bricklet

This is the description of the C# API bindings for the Real-Time Clock Bricklet. General information and technical specifications for the Real-Time Clock Bricklet are summarized in its hardware description.

An installation guide for the C# API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

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
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);
        Console.WriteLine("Weekday: " + weekday);

        // 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
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);
        Console.WriteLine("Weekday: " + weekday);
        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();
    }
}

API

Generally, every method of the C# bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

All methods listed below are thread-safe.

Basic Functions

public class BrickletRealTimeClock(String uid, IPConnection ipcon)

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 (see examples above).

public void SetDateTime(int year, byte month, byte day, byte hour, byte minute, byte second, byte centisecond, byte weekday)

Sets the current date (including weekday) and the current time with hundredths of a second resolution.

Possible value ranges:

  • Year: 2000 to 2099
  • Month: 1 to 12 (January to December)
  • Day: 1 to 31
  • Hour: 0 to 23
  • Minute: 0 to 59
  • Second: 0 to 59
  • Centisecond: 0 to 99
  • Weekday: 1 to 7 (Monday to Sunday)

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:

  • 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
public void 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)

Returns the current date (including weekday) and the current time of the real-time clock with hundredths of a second resolution.

The following constants are available for this function:

  • 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
public long GetTimestamp()

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.

Advanced Functions

public void SetOffset(short offset)

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.

public short GetOffset()

Returns the offset as set by SetOffset().

public byte[] GetAPIVersion()

Returns the version of the API definition (major, minor, revision) 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.

public bool GetResponseExpected(byte functionId)

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 send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected() for the list of function ID constants available for this function.

public void SetResponseExpected(byte functionId, bool responseExpected)

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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME = 1
  • BrickletRealTimeClock.FUNCTION_SET_OFFSET = 4
  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • BrickletRealTimeClock.FUNCTION_SET_ALARM = 8
public void SetResponseExpectedAll(bool responseExpected)

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

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

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' or 'd'.

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

Callback Configuration Functions

public void SetDateTimeCallbackPeriod(long period)

Sets the period in ms 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.

The default value is 0.

New in version 2.0.1 (Plugin).

public long GetDateTimeCallbackPeriod()

Returns the period as set by SetDateTimeCallbackPeriod().

New in version 2.0.1 (Plugin).

public void SetAlarm(short month, short day, short hour, short minute, short second, short weekday, int interval)

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:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1
  • BrickletRealTimeClock.ALARM_INTERVAL_DISABLED = -1

New in version 2.0.1 (Plugin).

public void GetAlarm(out short month, out short day, out short hour, out short minute, out short second, out short weekday, out int interval)

Returns the alarm configuration as set by SetAlarm().

The following constants are available for this function:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1
  • 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.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

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

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:

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

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

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:

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

Constants

public int DEVICE_IDENTIFIER

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

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

public string DEVICE_DISPLAY_NAME

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