Python - Real-Time Clock Bricklet 2.0

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

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

Examples

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

Simple

Download (example_simple.py)

 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
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Real-Time Clock Bricklet 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_real_time_clock_v2 import BrickletRealTimeClockV2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    rtc = BrickletRealTimeClockV2(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
    year, month, day, hour, minute, second, centisecond, weekday, \
      timestamp = rtc.get_date_time()

    print("Year: " + str(year))
    print("Month: " + str(month))
    print("Day: " + str(day))
    print("Hour: " + str(hour))
    print("Minute: " + str(minute))
    print("Second: " + str(second))
    print("Centisecond: " + str(centisecond))
    print("Weekday: " + str(weekday))
    print("Timestamp: " + str(timestamp) + " ms")

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

Callback

Download (example_callback.py)

 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
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Real-Time Clock Bricklet 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_real_time_clock_v2 import BrickletRealTimeClockV2

# Callback function for date and time callback
def cb_date_time(year, month, day, hour, minute, second, centisecond, weekday, timestamp):
    print("Year: " + str(year))
    print("Month: " + str(month))
    print("Day: " + str(day))
    print("Hour: " + str(hour))
    print("Minute: " + str(minute))
    print("Second: " + str(second))
    print("Centisecond: " + str(centisecond))
    print("Weekday: " + str(weekday))
    print("Timestamp: " + str(timestamp))
    print("")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    rtc = BrickletRealTimeClockV2(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 cb_date_time
    rtc.register_callback(rtc.CALLBACK_DATE_TIME, cb_date_time)

    # Set period for date and time callback to 5s (5000ms)
    rtc.set_date_time_callback_configuration(5000)

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

API

Generally, every method of the Python bindings can throw an tinkerforge.ip_connection.Error exception that has a value and a description property. value can have different values:

  • Error.TIMEOUT = -1
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12

All methods listed below are thread-safe.

Basic Functions

BrickletRealTimeClockV2(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

real_time_clock_v2 = BrickletRealTimeClockV2("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected (see examples above).

BrickletRealTimeClockV2.set_date_time(year, month, day, hour, minute, second, centisecond, weekday)
Parameters:
  • year -- int
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • centisecond -- int
  • weekday -- int
Return type:

None

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:

  • 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.get_date_time()
Return type:(int, int, int, int, int, int, int, int, int)

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

The timestamp represents the current date and the the current time of the real-time clock converted to milliseconds.

The following constants are available for this function:

  • 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

The returned namedtuple has the variables year, month, day, hour, minute, second, centisecond, weekday and timestamp.

BrickletRealTimeClockV2.get_timestamp()
Return type:int

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

BrickletRealTimeClockV2.set_offset(offset)
Parameters:offset -- int
Return type:None

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.get_offset()
Return type:int

Returns the offset as set by set_offset().

BrickletRealTimeClockV2.get_api_version()
Return type:[int, int, int]

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.

BrickletRealTimeClockV2.get_response_expected(function_id)
Parameters:function_id -- int
Return 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 set_response_expected(). 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 set_response_expected() for the list of function ID constants available for this function.

BrickletRealTimeClockV2.set_response_expected(function_id, response_expected)
Parameters:
  • function_id -- int
  • response_expected -- bool
Return type:

None

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:

  • 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.set_response_expected_all(response_expected)
Parameters:response_expected -- bool
Return type:None

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

BrickletRealTimeClockV2.get_spitfp_error_count()
Return type:(int, int, int, int)

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.

The returned namedtuple has the variables error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

BrickletRealTimeClockV2.set_bootloader_mode(mode)
Parameters:mode -- int
Return type:int

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:

  • 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.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.get_bootloader_mode()
Return type:int

Returns the current bootloader mode, see set_bootloader_mode().

The following constants are available for this function:

  • 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.set_write_firmware_pointer(pointer)
Parameters:pointer -- int
Return type:None

Sets the firmware pointer for write_firmware(). 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.write_firmware(data)
Parameters:data -- [int, int, ..61x.., int]
Return type:int

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer() 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.set_status_led_config(config)
Parameters:config -- int
Return type:None

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:

  • 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.get_status_led_config()
Return type:int

Returns the configuration as set by set_status_led_config()

The following constants are available for this function:

  • 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.get_chip_temperature()
Return type:int

Returns the temperature in °C 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()
Return type:None

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.write_uid(uid)
Parameters:uid -- int
Return type:None

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.read_uid()
Return type:int

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

BrickletRealTimeClockV2.get_identity()
Return type:(str, str, chr, [int, int, int], [int, int, int], int)

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.

The returned namedtuple has the variables uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletRealTimeClockV2.register_callback(callback_id, function)
Parameters:
  • callback_id -- int
  • function -- callable
Return type:

None

Registers the given function with the given callback_id.

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

BrickletRealTimeClockV2.set_date_time_callback_configuration(period)
Parameters:period -- int
Return type:None

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

The default value is 0.

BrickletRealTimeClockV2.get_date_time_callback_configuration()
Return type:int

Returns the period as set by set_date_time_callback_configuration().

BrickletRealTimeClockV2.set_alarm(month, day, hour, minute, second, weekday, interval)
Parameters:
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • weekday -- int
  • interval -- int
Return type:

None

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:

  • BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1
  • BrickletRealTimeClockV2.ALARM_INTERVAL_DISABLED = -1
BrickletRealTimeClockV2.get_alarm()
Return type:(int, int, int, int, int, int, int)

Returns the alarm configuration as set by set_alarm().

The following constants are available for this function:

  • BrickletRealTimeClockV2.ALARM_MATCH_DISABLED = -1
  • BrickletRealTimeClockV2.ALARM_INTERVAL_DISABLED = -1

The returned namedtuple has the variables month, day, hour, minute, second, weekday and interval.

Callbacks

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

def my_callback(param):
    print(param)

real_time_clock_v2.register_callback(BrickletRealTimeClockV2.CALLBACK_EXAMPLE, my_callback)

The available constants with inherent number and type of parameters 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.

BrickletRealTimeClockV2.CALLBACK_DATE_TIME
Parameters:
  • year -- int
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • centisecond -- int
  • weekday -- int
  • timestamp -- int

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

The following constants are available for this function:

  • 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
Parameters:
  • year -- int
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • centisecond -- int
  • weekday -- int
  • timestamp -- int

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

The following constants are available for this function:

  • 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

Constants

BrickletRealTimeClockV2.DEVICE_IDENTIFIER

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

The get_identity() function and the 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.