Class: Tinkerforge::BrickletRealTimeClockV2

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

Overview

Battery-backed real-time clock

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2106
DEVICE_DISPLAY_NAME =

:nodoc:

'Real-Time Clock Bricklet 2.0'
CALLBACK_DATE_TIME =

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

10
CALLBACK_ALARM =

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

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_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_DATE_TIME_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_SET_ALARM =

:nodoc:

8
FUNCTION_GET_ALARM =

:nodoc:

9
FUNCTION_GET_SPITFP_ERROR_COUNT =

:nodoc:

234
FUNCTION_SET_BOOTLOADER_MODE =

:nodoc:

235
FUNCTION_GET_BOOTLOADER_MODE =

:nodoc:

236
FUNCTION_SET_WRITE_FIRMWARE_POINTER =

:nodoc:

237
FUNCTION_WRITE_FIRMWARE =

:nodoc:

238
FUNCTION_SET_STATUS_LED_CONFIG =

:nodoc:

239
FUNCTION_GET_STATUS_LED_CONFIG =

:nodoc:

240
FUNCTION_GET_CHIP_TEMPERATURE =

:nodoc:

242
FUNCTION_RESET =

:nodoc:

243
FUNCTION_WRITE_UID =

:nodoc:

248
FUNCTION_READ_UID =

:nodoc:

249
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:
BOOTLOADER_MODE_BOOTLOADER =

:nodoc:

0
BOOTLOADER_MODE_FIRMWARE =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =

:nodoc:

2
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =

:nodoc:

3
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =

:nodoc:

4
BOOTLOADER_STATUS_OK =

:nodoc:

0
BOOTLOADER_STATUS_INVALID_MODE =

:nodoc:

1
BOOTLOADER_STATUS_NO_CHANGE =

:nodoc:

2
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =

:nodoc:

3
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =

:nodoc:

4
BOOTLOADER_STATUS_CRC_MISMATCH =

:nodoc:

5
STATUS_LED_CONFIG_OFF =

:nodoc:

0
STATUS_LED_CONFIG_ON =

:nodoc:

1
STATUS_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
STATUS_LED_CONFIG_SHOW_STATUS =

:nodoc:

3

Constants inherited from Device

Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, 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, #high_level_callbacks, #registered_callbacks, #replaced, #uid

Instance Method Summary collapse

Methods inherited from Device

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

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletRealTimeClockV2

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 79

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @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_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DATE_TIME_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ALARM] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ALARM] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_DATE_TIME] = [25, 'S C C C C C C C q']
  @callback_formats[CALLBACK_ALARM] = [25, 'S C C C C C C C q']

  @ipcon.add_device self
end

Instance Method Details

#get_alarm ⇒ Object

Returns the alarm configuration as set by BrickletRealTimeClockV2#set_alarm.



230
231
232
233
234
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 230

def get_alarm
  check_validity

  send_request FUNCTION_GET_ALARM, [], '', 18, 'c c c c c c l'
end

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletRealTimeClockV2#set_bootloader_mode.



269
270
271
272
273
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 269

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_chip_temperature ⇒ Object

Returns the temperature 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.



327
328
329
330
331
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 327

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_date_time ⇒ Object

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

The timestamp represents the current date and the the current time of the real-time clock converted to milliseconds and is an offset to 2000-01-01 00:00:00.0000.



131
132
133
134
135
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 131

def get_date_time
  check_validity

  send_request FUNCTION_GET_DATE_TIME, [], '', 25, 'S C C C C C C C q'
end

#get_date_time_callback_configuration ⇒ Object

Returns the period as set by BrickletRealTimeClockV2#set_date_time_callback_configuration.



193
194
195
196
197
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 193

def get_date_time_callback_configuration
  check_validity

  send_request FUNCTION_GET_DATE_TIME_CALLBACK_CONFIGURATION, [], '', 12, '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’, ‘d’, ‘e’, ‘f’, ‘g’ or ‘h’ (Bricklet Port). A Bricklet connected to an :ref:‘Isolator Bricklet <isolator_bricklet>` is always at position ’z’.

The device identifier numbers can be found :ref:‘here <device_identifier>`. |device_identifier_constant|



374
375
376
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 374

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_offset ⇒ Object

Returns the offset as set by BrickletRealTimeClockV2#set_offset.



178
179
180
181
182
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 178

def get_offset
  check_validity

  send_request FUNCTION_GET_OFFSET, [], '', 9, 'c'
end

#get_spitfp_error_count ⇒ Object

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.



247
248
249
250
251
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 247

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletRealTimeClockV2#set_status_led_config



315
316
317
318
319
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 315

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, '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 and is an offset to 2000-01-01 00:00:00.0000.



140
141
142
143
144
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 140

def get_timestamp
  check_validity

  send_request FUNCTION_GET_TIMESTAMP, [], '', 16, 'q'
end

#read_uid ⇒ Object

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



358
359
360
361
362
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 358

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



379
380
381
382
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 379

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

#reset ⇒ Object

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!



339
340
341
342
343
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 339

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
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.



223
224
225
226
227
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 223

def set_alarm(month, day, hour, minute, second, weekday, interval)
  check_validity

  send_request FUNCTION_SET_ALARM, [month, day, hour, minute, second, weekday, interval], 'c c c c c c l', 8, ''
end

#set_bootloader_mode(mode) ⇒ Object

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.



262
263
264
265
266
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 262

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

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

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.



120
121
122
123
124
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 120

def set_date_time(year, month, day, hour, minute, second, centisecond, weekday)
  check_validity

  send_request FUNCTION_SET_DATE_TIME, [year, month, day, hour, minute, second, centisecond, weekday], 'S C C C C C C C', 8, ''
end

#set_date_time_callback_configuration(period) ⇒ Object

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



186
187
188
189
190
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 186

def set_date_time_callback_configuration(period)
  check_validity

  send_request FUNCTION_SET_DATE_TIME_CALLBACK_CONFIGURATION, [period], 'L', 8, ''
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.



171
172
173
174
175
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 171

def set_offset(offset)
  check_validity

  send_request FUNCTION_SET_OFFSET, [offset], 'c', 8, ''
end

#set_status_led_config(config) ⇒ Object

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.



308
309
310
311
312
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 308

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

Sets the firmware pointer for BrickletRealTimeClockV2#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.



281
282
283
284
285
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 281

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#write_firmware(data) ⇒ Object

Writes 64 Bytes of firmware at the position as written by BrickletRealTimeClockV2#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.



295
296
297
298
299
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 295

def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end

#write_uid(uid) ⇒ Object

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.



350
351
352
353
354
 
# File 'lib/tinkerforge/bricklet_real_time_clock_v2.rb', line 350

def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end