Shell - Real-Time Clock Bricklet 2.0¶

Simple¶

Download (example-simple.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Real-Time Clock Bricklet 2.0

# Get current date and time
tinkerforge call real-time-clock-v2-bricklet $uid get-date-time

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Real-Time Clock Bricklet 2.0

# Handle incoming date and time callbacks
tinkerforge dispatch real-time-clock-v2-bricklet $uid date-time &

# Set period for date and time callback to 5s (5000ms)
tinkerforge call real-time-clock-v2-bricklet $uid set-date-time-callback-configuration 5000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call real-time-clock-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the Real-Time Clock Bricklet 2.0. It can take several options:

• --help shows help for the specific call command and exits
• --list-functions shows a list of known functions of the Real-Time Clock Bricklet 2.0 and exits

tinkerforge dispatch real-time-clock-v2-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the Real-Time Clock Bricklet 2.0. It can take several options:

• --help shows help for the specific dispatch command and exits
• --list-callbacks shows a list of known callbacks of the Real-Time Clock Bricklet 2.0 and exits

tinkerforge call real-time-clock-v2-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch real-time-clock-v2-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits
• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call real-time-clock-v2-bricklet <uid> set-date-time <year> <month> <day> <hour> <minute> <second> <centisecond> <weekday>¶

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 symbols
Output:	no output

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 symbols are available for this function:

For <weekday>:

• weekday-monday = 1
• weekday-tuesday = 2
• weekday-wednesday = 3
• weekday-thursday = 4
• weekday-friday = 5
• weekday-saturday = 6
• weekday-sunday = 7

tinkerforge call real-time-clock-v2-bricklet <uid> get-date-time¶

Output:	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 symbols 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 symbols are available for this function:

For weekday:

• weekday-monday = 1
• weekday-tuesday = 2
• weekday-wednesday = 3
• weekday-thursday = 4
• weekday-friday = 5
• weekday-saturday = 6
• weekday-sunday = 7

tinkerforge call real-time-clock-v2-bricklet <uid> get-timestamp¶

Output:	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¶

tinkerforge call real-time-clock-v2-bricklet <uid> set-offset <offset>¶

Parameters:	<offset> – Type: Int, Unit: 217/100 ppm, Range: [-128 to 127]
Output:	no output

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.

tinkerforge call real-time-clock-v2-bricklet <uid> get-offset¶

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

Returns the offset as set by set-offset.

tinkerforge call real-time-clock-v2-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] 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.

tinkerforge call real-time-clock-v2-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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 symbols are available for this function:

For <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call real-time-clock-v2-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call real-time-clock-v2-bricklet <uid> get-chip-temperature¶

Output:	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.

tinkerforge call real-time-clock-v2-bricklet <uid> reset¶

Output:	no output

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!

tinkerforge call real-time-clock-v2-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, 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] firmware-version – Type: Int Array, 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] 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. 

Callback Configuration Functions¶

tinkerforge call real-time-clock-v2-bricklet <uid> set-date-time-callback-configuration <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call real-time-clock-v2-bricklet <uid> get-date-time-callback-configuration¶

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

Returns the period as set by set-date-time-callback-configuration.

tinkerforge call real-time-clock-v2-bricklet <uid> set-alarm <month> <day> <hour> <minute> <second> <weekday> <interval>¶

Parameters:

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

Output:

no output

Configures a repeatable alarm. The 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 symbols are available for this function:

For <month>:

• alarm-match-disabled = -1

For <day>:

• alarm-match-disabled = -1

For <hour>:

• alarm-match-disabled = -1

For <minute>:

• alarm-match-disabled = -1

For <second>:

• alarm-match-disabled = -1

For <weekday>:

• alarm-match-disabled = -1

For <interval>:

• alarm-interval-disabled = -1

tinkerforge call real-time-clock-v2-bricklet <uid> get-alarm¶

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

Returns the alarm configuration as set by set-alarm.

The following symbols are available for this function:

For month:

• alarm-match-disabled = -1

For day:

• alarm-match-disabled = -1

For hour:

• alarm-match-disabled = -1

For minute:

• alarm-match-disabled = -1

For second:

• alarm-match-disabled = -1

For weekday:

• alarm-match-disabled = -1

For interval:

• alarm-interval-disabled = -1

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch real-time-clock-v2-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch real-time-clock-v2-bricklet <uid> date-time¶

Output:	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 symbols 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 symbols are available for this function:

For weekday:

• weekday-monday = 1
• weekday-tuesday = 2
• weekday-wednesday = 3
• weekday-thursday = 4
• weekday-friday = 5
• weekday-saturday = 6
• weekday-sunday = 7

tinkerforge dispatch real-time-clock-v2-bricklet <uid> alarm¶

Output:	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 symbols 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 symbols are available for this function:

For weekday:

• weekday-monday = 1
• weekday-tuesday = 2
• weekday-wednesday = 3
• weekday-thursday = 4
• weekday-friday = 5
• weekday-saturday = 6
• weekday-sunday = 7

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.

tinkerforge call real-time-clock-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See symbols

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 symbols are available for this function:

For <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call real-time-clock-v2-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call real-time-clock-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:	no output

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.

tinkerforge call real-time-clock-v2-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	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.

tinkerforge call real-time-clock-v2-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

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.

tinkerforge call real-time-clock-v2-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

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