Class: Tinkerforge::BrickletRealTimeClock

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_real_time_clock.rb

Overview

Battery-backed real-time clock

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

268
DEVICE_DISPLAY_NAME =

:nodoc:

'Real-Time Clock Bricklet'
CALLBACK_DATE_TIME =

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

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

.. versionadded

2.0.1$nbsp;(Plugin)

10
CALLBACK_ALARM =

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

.. versionadded

2.0.1$nbsp;(Plugin)

11
FUNCTION_SET_DATE_TIME =

:nodoc:

1
FUNCTION_GET_DATE_TIME =

:nodoc:

2
FUNCTION_GET_TIMESTAMP =

:nodoc:

3
FUNCTION_SET_OFFSET =

:nodoc:

4
FUNCTION_GET_OFFSET =

:nodoc:

5
FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD =

:nodoc:

6
FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD =

:nodoc:

7
FUNCTION_SET_ALARM =

:nodoc:

8
FUNCTION_GET_ALARM =

:nodoc:

9
FUNCTION_GET_IDENTITY =

:nodoc:

255
WEEKDAY_MONDAY =

:nodoc:

1
WEEKDAY_TUESDAY =

:nodoc:

2
WEEKDAY_WEDNESDAY =

:nodoc:

3
WEEKDAY_THURSDAY =

:nodoc:

4
WEEKDAY_FRIDAY =

:nodoc:

5
WEEKDAY_SATURDAY =

:nodoc:

6
WEEKDAY_SUNDAY =

:nodoc:

7
ALARM_MATCH_DISABLED =

:nodoc:

-1 # :nodoc:
ALARM_INTERVAL_DISABLED =

:nodoc:

-1 # :nodoc:

Constants inherited from Device

Device::RESPONSE_EXPECTED_ALWAYS_FALSE, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #registered_callbacks, #uid

Instance Method Summary collapse

Methods inherited from Device

#dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletRealTimeClock

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 58

def initialize(uid, ipcon)
  super uid, ipcon

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_SET_DATE_TIME] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_DATE_TIME] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_TIMESTAMP] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_OFFSET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_OFFSET] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ALARM] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ALARM] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[CALLBACK_DATE_TIME] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_ALARM] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_DATE_TIME] = 'S C C C C C C C q'
  @callback_formats[CALLBACK_ALARM] = 'S C C C C C C C q'
end

Instance Method Details

#get_alarm ⇒ Object

Returns the alarm configuration as set by BrickletRealTimeClock#set_alarm.

.. versionadded

2.0.1$nbsp;(Plugin)



204
205
206
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 204

def get_alarm
  send_request(FUNCTION_GET_ALARM, [], '', 10, 'c c c c c c l')
end

#get_date_time ⇒ Object

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



106
107
108
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 106

def get_date_time
  send_request(FUNCTION_GET_DATE_TIME, [], '', 9, 'S C C C C C C C')
end

#get_date_time_callback_period ⇒ Object

Returns the period as set by BrickletRealTimeClock#set_date_time_callback_period.

.. versionadded

2.0.1$nbsp;(Plugin)



167
168
169
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 167

def get_date_time_callback_period
  send_request(FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD, [], '', 4, 'L')
end

#get_identity ⇒ Object

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 :ref:‘here <device_identifier>`. |device_identifier_constant|



216
217
218
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 216

def get_identity
  send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
end

#get_offset ⇒ Object

Returns the offset as set by BrickletRealTimeClock#set_offset.



147
148
149
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 147

def get_offset
  send_request(FUNCTION_GET_OFFSET, [], '', 1, 'c')
end

#get_timestamp ⇒ Object

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.



113
114
115
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 113

def get_timestamp
  send_request(FUNCTION_GET_TIMESTAMP, [], '', 8, 'q')
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



221
222
223
224
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 221

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#set_alarm(month, day, hour, minute, second, weekday, interval) ⇒ Object

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.

.. versionadded

2.0.1$nbsp;(Plugin)



197
198
199
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 197

def set_alarm(month, day, hour, minute, second, weekday, interval)
  send_request(FUNCTION_SET_ALARM, [month, day, hour, minute, second, weekday, interval], 'c c c c c c l', 0, '')
end

#set_date_time(year, month, day, hour, minute, second, centisecond, weekday) ⇒ Object

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.



100
101
102
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 100

def set_date_time(year, month, day, hour, minute, second, centisecond, weekday)
  send_request(FUNCTION_SET_DATE_TIME, [year, month, day, hour, minute, second, centisecond, weekday], 'S C C C C C C C', 0, '')
end

#set_date_time_callback_period(period) ⇒ Object

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

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

The default value is 0.

.. versionadded

2.0.1$nbsp;(Plugin)



160
161
162
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 160

def set_date_time_callback_period(period)
  send_request(FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD, [period], 'L', 0, '')
end

#set_offset(offset) ⇒ Object

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.



142
143
144
 
# File 'lib/tinkerforge/bricklet_real_time_clock.rb', line 142

def set_offset(offset)
  send_request(FUNCTION_SET_OFFSET, [offset], 'c', 0, '')
end