TCP/IP - Real-Time Clock Bricklet

This is the description of the TCP/IP protocol for the Real-Time Clock Bricklet. General information and technical specifications for the Real-Time Clock Bricklet are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletRealTimeClock.set_date_time
Function ID:

1

Request:
  • year -- uint16
  • month -- uint8
  • day -- uint8
  • hour -- uint8
  • minute -- uint8
  • second -- uint8
  • centisecond -- uint8
  • weekday -- uint8
Response:

no response

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 meanings are defined for the parameters of this function:

  • 1: monday, for weekday
  • 2: tuesday, for weekday
  • 3: wednesday, for weekday
  • 4: thursday, for weekday
  • 5: friday, for weekday
  • 6: saturday, for weekday
  • 7: sunday, for weekday
BrickletRealTimeClock.get_date_time
Function ID:

2

Request:

empty payload

Response:
  • year -- uint16
  • month -- uint8
  • day -- uint8
  • hour -- uint8
  • minute -- uint8
  • second -- uint8
  • centisecond -- uint8
  • weekday -- uint8

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

The following meanings are defined for the parameters of this function:

  • 1: monday, for weekday
  • 2: tuesday, for weekday
  • 3: wednesday, for weekday
  • 4: thursday, for weekday
  • 5: friday, for weekday
  • 6: saturday, for weekday
  • 7: sunday, for weekday
BrickletRealTimeClock.get_timestamp
Function ID:

3

Request:

empty payload

Response:
  • timestamp -- int64

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

BrickletRealTimeClock.set_offset
Function ID:

4

Request:
  • offset -- int8
Response:

no response

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.

BrickletRealTimeClock.get_offset
Function ID:

5

Request:

empty payload

Response:
  • offset -- int8

Returns the offset as set by set_offset.

BrickletRealTimeClock.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

Callback Configuration Functions

BrickletRealTimeClock.set_date_time_callback_period
Function ID:

6

Request:
  • period -- uint32
Response:

no response

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

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

BrickletRealTimeClock.get_date_time_callback_period
Function ID:

7

Request:

empty payload

Response:
  • period -- uint32

Returns the period as set by set_date_time_callback_period.

New in version 2.0.1 (Plugin).

BrickletRealTimeClock.set_alarm
Function ID:

8

Request:
  • month -- int8
  • day -- int8
  • hour -- int8
  • minute -- int8
  • second -- int8
  • weekday -- int8
  • interval -- int32
Response:

no response

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 meanings are defined for the parameters of this function:

  • -1: disabled, for month, day, hour, minute, second and weekday
  • -1: disabled, for interval

New in version 2.0.1 (Plugin).

BrickletRealTimeClock.get_alarm
Function ID:

9

Request:

empty payload

Response:
  • month -- int8
  • day -- int8
  • hour -- int8
  • minute -- int8
  • second -- int8
  • weekday -- int8
  • interval -- int32

Returns the alarm configuration as set by set_alarm.

The following meanings are defined for the parameters of this function:

  • -1: disabled, for month, day, hour, minute, second and weekday
  • -1: disabled, for interval

New in version 2.0.1 (Plugin).

Callbacks

BrickletRealTimeClock.CALLBACK_DATE_TIME
Function ID:

10

Response:
  • year -- uint16
  • month -- uint8
  • day -- uint8
  • hour -- uint8
  • minute -- uint8
  • second -- uint8
  • centisecond -- uint8
  • weekday -- uint8
  • timestamp -- int64

This callback is triggered periodically with the period that is set by set_date_time_callback_period. The response values are the same as for get_date_time and get_timestamp combined.

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

The following meanings are defined for the parameters of this function:

  • 1: monday, for weekday
  • 2: tuesday, for weekday
  • 3: wednesday, for weekday
  • 4: thursday, for weekday
  • 5: friday, for weekday
  • 6: saturday, for weekday
  • 7: sunday, for weekday

New in version 2.0.1 (Plugin).

BrickletRealTimeClock.CALLBACK_ALARM
Function ID:

11

Response:
  • year -- uint16
  • month -- uint8
  • day -- uint8
  • hour -- uint8
  • minute -- uint8
  • second -- uint8
  • centisecond -- uint8
  • weekday -- uint8
  • timestamp -- int64

This callback is triggered every time the current date and time matches the configured alarm (see set_alarm). The response values are the same as for get_date_time and get_timestamp combined.

The following meanings are defined for the parameters of this function:

  • 1: monday, for weekday
  • 2: tuesday, for weekday
  • 3: wednesday, for weekday
  • 4: thursday, for weekday
  • 5: friday, for weekday
  • 6: saturday, for weekday
  • 7: sunday, for weekday

New in version 2.0.1 (Plugin).