Ruby - Real-Time Clock Bricklet 2.0¶

Simple¶

Download (example_simple.rb)

 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
48
49
50
51

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_real_time_clock_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
rtc = BrickletRealTimeClockV2.new 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 as [year, month, day, hour, minute, second, centisecond,
#                               weekday, timestamp]
date_time = rtc.get_date_time

puts "Year: #{date_time[0]}"
puts "Month: #{date_time[1]}"
puts "Day: #{date_time[2]}"
puts "Hour: #{date_time[3]}"
puts "Minute: #{date_time[4]}"
puts "Second: #{date_time[5]}"
puts "Centisecond: #{date_time[6]}"

if date_time[7] == BrickletRealTimeClockV2::WEEKDAY_MONDAY
  puts "Weekday: Monday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_TUESDAY
  puts "Weekday: Tuesday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_WEDNESDAY
  puts "Weekday: Wednesday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_THURSDAY
  puts "Weekday: Thursday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_FRIDAY
  puts "Weekday: Friday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_SATURDAY
  puts "Weekday: Saturday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_SUNDAY
  puts "Weekday: Sunday"
end

puts "Timestamp: #{date_time[8]} ms"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback¶

Download (example_callback.rb)

 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
48
49
50
51
52
53
54
55
56
57
58

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_real_time_clock_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
rtc = BrickletRealTimeClockV2.new 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
rtc.register_callback(BrickletRealTimeClockV2::CALLBACK_DATE_TIME) do |year, month, day,
                                                                       hour, minute,
                                                                       second,
                                                                       centisecond,
                                                                       weekday, timestamp|
  puts "Year: #{year}"
  puts "Month: #{month}"
  puts "Day: #{day}"
  puts "Hour: #{hour}"
  puts "Minute: #{minute}"
  puts "Second: #{second}"
  puts "Centisecond: #{centisecond}"

  if weekday == BrickletRealTimeClockV2::WEEKDAY_MONDAY
    puts "Weekday: Monday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_TUESDAY
    puts "Weekday: Tuesday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_WEDNESDAY
    puts "Weekday: Wednesday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_THURSDAY
    puts "Weekday: Thursday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_FRIDAY
    puts "Weekday: Friday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_SATURDAY
    puts "Weekday: Saturday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_SUNDAY
    puts "Weekday: Sunday"
  end

  puts "Timestamp: #{timestamp}"
  puts ''
end

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

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Basic Functions¶

BrickletRealTimeClockV2::new(uid, ipcon) → real_time_clock_v2¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	real_time_clock_v2 – Type: BrickletRealTimeClockV2

Creates an object with the unique device ID uid:

real_time_clock_v2 = BrickletRealTimeClockV2.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickletRealTimeClockV2#set_date_time(year, month, day, hour, minute, second, centisecond, weekday) → nil¶

Parameters:	year – Type: int, Range: [2000 to 2099] month – Type: int, Range: [1 to 12] day – Type: int, Range: [1 to 31] hour – Type: int, Range: [0 to 23] minute – Type: int, Range: [0 to 59] second – Type: int, Range: [0 to 59] centisecond – Type: int, Range: [0 to 99] weekday – Type: int, Range: See constants

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.

The following constants are available for this function:

For weekday:

• 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 → [int, int, int, int, int, int, int, int, int]¶

Return Array:	0: year – Type: int, Range: [2000 to 2099] 1: month – Type: int, Range: [1 to 12] 2: day – Type: int, Range: [1 to 31] 3: hour – Type: int, Range: [0 to 23] 4: minute – Type: int, Range: [0 to 59] 5: second – Type: int, Range: [0 to 59] 6: centisecond – Type: int, Range: [0 to 99] 7: weekday – Type: int, Range: See constants 8: timestamp – Type: int, Unit: 1 ms, Range: [-263 to 263 - 1]

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.

The following constants are available for this function:

For weekday:

• 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_timestamp → int¶

Returns:	timestamp – Type: int, Unit: 1 ms, Range: [-263 to 263 - 1]

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.

Advanced Functions¶

BrickletRealTimeClockV2#set_offset(offset) → nil¶

Parameters:	offset – Type: int, Unit: 217/100 ppm, Range: [-128 to 127]

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 → int¶

Returns:	offset – Type: int, Unit: 217/100 ppm, Range: [-128 to 127]

Returns the offset as set by #set_offset.

BrickletRealTimeClockV2#get_spitfp_error_count → [int, int, int, int]¶

Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 232 - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 232 - 1] 2: error_count_frame – Type: int, Range: [0 to 232 - 1] 3: error_count_overflow – Type: int, Range: [0 to 232 - 1]

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.

BrickletRealTimeClockV2#set_status_led_config(config) → nil¶

Parameters:	config – Type: int, Range: See constants, Default: 3

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:

For config:

• 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 → int¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

For config:

• 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 → int¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

BrickletRealTimeClockV2#reset → nil¶

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#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

0: uid – Type: str, Length: up to 8 1: connected_uid – Type: str, Length: up to 8 2: position – Type: chr, Range: ['a' to 'h', 'z'] 3: hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 4: firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 5: device_identifier – Type: int, Range: [0 to 216 - 1]

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 Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions¶

BrickletRealTimeClockV2#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameters:	callback_id – Type: int

Registers the given block with the given callback_id.

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

BrickletRealTimeClockV2#set_date_time_callback_configuration(period) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

BrickletRealTimeClockV2#get_date_time_callback_configuration → int¶

Returns:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by #set_date_time_callback_configuration.

BrickletRealTimeClockV2#set_alarm(month, day, hour, minute, second, weekday, interval) → nil¶

Parameters:

month – Type: int, Range: [-1, 1 to 12] with constants day – Type: int, Range: [-1, 1 to 31] with constants hour – Type: int, Range: [-1, 0 to 23] with constants minute – Type: int, Range: [-1, 0 to 59] with constants second – Type: int, Range: [-1, 0 to 59] with constants weekday – Type: int, Range: [-1, 1 to 7] with constants interval – Type: int, Unit: 1 s, Range: [-1, 1 to 231 - 1] with constants

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:

For month:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For day:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For hour:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For minute:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For second:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For weekday:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For interval:

• BrickletRealTimeClockV2::ALARM_INTERVAL_DISABLED = -1

BrickletRealTimeClockV2#get_alarm → [int, int, int, int, int, int, int]¶

Return Array:

0: month – Type: int, Range: [-1, 1 to 12] with constants 1: day – Type: int, Range: [-1, 1 to 31] with constants 2: hour – Type: int, Range: [-1, 0 to 23] with constants 3: minute – Type: int, Range: [-1, 0 to 59] with constants 4: second – Type: int, Range: [-1, 0 to 59] with constants 5: weekday – Type: int, Range: [-1, 1 to 7] with constants 6: interval – Type: int, Unit: 1 s, Range: [-1, 1 to 231 - 1] with constants

Returns the alarm configuration as set by #set_alarm.

The following constants are available for this function:

For month:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For day:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For hour:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For minute:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For second:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For weekday:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

For interval:

• BrickletRealTimeClockV2::ALARM_INTERVAL_DISABLED = -1

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 is a block:

real_time_clock_v2.register_callback BrickletRealTimeClockV2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters are described below.

BrickletRealTimeClockV2::CALLBACK_DATE_TIME¶

Callback Parameters:	year – Type: int, Range: [2000 to 2099] month – Type: int, Range: [1 to 12] day – Type: int, Range: [1 to 31] hour – Type: int, Range: [0 to 23] minute – Type: int, Range: [0 to 59] second – Type: int, Range: [0 to 59] centisecond – Type: int, Range: [0 to 99] weekday – Type: int, Range: See constants timestamp – Type: int, Unit: 1 ms, Range: [-263 to 263 - 1]

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:

For weekday:

• 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¶

Callback Parameters:	year – Type: int, Range: [2000 to 2099] month – Type: int, Range: [1 to 12] day – Type: int, Range: [1 to 31] hour – Type: int, Range: [0 to 23] minute – Type: int, Range: [0 to 59] second – Type: int, Range: [0 to 59] centisecond – Type: int, Range: [0 to 99] weekday – Type: int, Range: See constants timestamp – Type: int, Unit: 1 ms, Range: [-263 to 263 - 1]

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:

For weekday:

• 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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletRealTimeClockV2#get_api_version → [int, ...]¶

Return Array:	0: api_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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) → bool¶

Parameters:	function_id – Type: int, Range: See constants
Returns:	response_expected – 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• 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(function_id, response_expected) → nil¶

Parameters:	function_id – Type: int, Range: See constants response_expected – Type: bool

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

The following constants are available for this function:

For function_id:

• 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) → nil¶

Parameters:	response_expected – Type: bool

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletRealTimeClockV2#set_bootloader_mode(mode) → int¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

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:

For mode:

• 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

For status:

• 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 → int¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

For mode:

• 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) → nil¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]

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) → int¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

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#write_uid(uid) → nil¶

Parameters:	uid – Type: int, Range: [0 to 232 - 1]

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 → int¶

Returns:	uid – Type: int, Range: [0 to 232 - 1]

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

Constants¶

BrickletRealTimeClockV2::DEVICE_IDENTIFIER¶

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

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