Rust - Real-Time Clock Bricklet

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

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

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

Simple

Download (example_simple.rs)

 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
use std::{error::Error, io};

use tinkerforge::{ip_connection::IpConnection, real_time_clock_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Real-Time Clock Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let rtc = RealTimeClockBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Get current date and time.
    let date_time = rtc.get_date_time().recv()?;

    println!("Year: {}", date_time.year);
    println!("Month: {}", date_time.month);
    println!("Day: {}", date_time.day);
    println!("Hour: {}", date_time.hour);
    println!("Minute: {}", date_time.minute);
    println!("Second: {}", date_time.second);
    println!("Centisecond: {}", date_time.centisecond);

    if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_MONDAY {
        println!("Weekday: Monday");
    } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_TUESDAY {
        println!("Weekday: Tuesday");
    } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_WEDNESDAY {
        println!("Weekday: Wednesday");
    } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_THURSDAY {
        println!("Weekday: Thursday");
    } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_FRIDAY {
        println!("Weekday: Friday");
    } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SATURDAY {
        println!("Weekday: Saturday");
    } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SUNDAY {
        println!("Weekday: Sunday");
    }

    // Get current timestamp.
    let timestamp = rtc.get_timestamp().recv()?;
    println!("Timestamp: {} ms", timestamp);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Callback

Download (example_callback.rs)

 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
59
60
61
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, real_time_clock_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Real-Time Clock Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let rtc = RealTimeClockBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let date_time_receiver = rtc.get_date_time_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `rtc` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for date_time in date_time_receiver {
            println!("Year: {}", date_time.year);
            println!("Month: {}", date_time.month);
            println!("Day: {}", date_time.day);
            println!("Hour: {}", date_time.hour);
            println!("Minute: {}", date_time.minute);
            println!("Second: {}", date_time.second);
            println!("Centisecond: {}", date_time.centisecond);

            if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_MONDAY {
                println!("Weekday: Monday");
            } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_TUESDAY {
                println!("Weekday: Tuesday");
            } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_WEDNESDAY {
                println!("Weekday: Wednesday");
            } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_THURSDAY {
                println!("Weekday: Thursday");
            } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_FRIDAY {
                println!("Weekday: Friday");
            } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SATURDAY {
                println!("Weekday: Saturday");
            } else if date_time.weekday == REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SUNDAY {
                println!("Weekday: Sunday");
            }

            println!("Timestamp: {}", date_time.timestamp);
            println!();
        }
    });

    // Set period for date and time receiver to 5s (5000ms).
    // Note: The date and time callback is only called every 5 seconds
    //       if the date and time has changed since the last call!
    rtc.set_date_time_callback_period(5000);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occured.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

pub fn RealTimeClockBricklet::new(uid: &str, ip_connection: &IpConnection) → RealTimeClockBricklet

Creates a new RealTimeClockBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IP connection has been connected (see examples above).

pub fn RealTimeClockBricklet::set_date_time(&self, year: u16, month: u8, day: u8, hour: u8, minute: u8, second: u8, centisecond: u8, weekday: u8) → ConvertingReceiver<()>

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:

  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_MONDAY = 1
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_TUESDAY = 2
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_WEDNESDAY = 3
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_THURSDAY = 4
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_FRIDAY = 5
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SATURDAY = 6
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SUNDAY = 7
pub fn RealTimeClockBricklet::get_date_time(&self) → ConvertingReceiver<DateTime>

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

The following constants are available for this function:

  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_MONDAY = 1
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_TUESDAY = 2
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_WEDNESDAY = 3
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_THURSDAY = 4
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_FRIDAY = 5
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SATURDAY = 6
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SUNDAY = 7
pub fn RealTimeClockBricklet::get_timestamp(&self) → ConvertingReceiver<i64>

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

pub fn RealTimeClockBricklet::set_offset(&self, offset: i8) → ConvertingReceiver<()>

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.

pub fn RealTimeClockBricklet::get_offset(&self) → ConvertingReceiver<i8>

Returns the offset as set by RealTimeClockBricklet::set_offset.

pub fn RealTimeClockBricklet::get_api_version(&self) → [u8; 3]

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.

pub fn RealTimeClockBricklet::get_response_expected(&mut self, function_id: u8) → 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 RealTimeClockBricklet::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 RealTimeClockBricklet::set_response_expected for the list of function ID constants available for this function.

pub fn RealTimeClockBricklet::set_response_expected(&mut self, function_id: u8, response_expected: 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • REAL_TIME_CLOCK_BRICKLET_FUNCTION_SET_DATE_TIME = 1
  • REAL_TIME_CLOCK_BRICKLET_FUNCTION_SET_OFFSET = 4
  • REAL_TIME_CLOCK_BRICKLET_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • REAL_TIME_CLOCK_BRICKLET_FUNCTION_SET_ALARM = 8
pub fn RealTimeClockBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

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

pub fn RealTimeClockBricklet::get_identity(&self) → ConvertingReceiver<Identity>

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.

Callback Configuration Functions

pub fn RealTimeClockBricklet::set_date_time_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

The RealTimeClockBricklet::get_date_time_callback_receiver Callback is only triggered if the date or time changed since the last triggering.

The default value is 0.

New in version 2.0.1 (Plugin).

pub fn RealTimeClockBricklet::get_date_time_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by RealTimeClockBricklet::set_date_time_callback_period.

New in version 2.0.1 (Plugin).

pub fn RealTimeClockBricklet::set_alarm(&self, month: i8, day: i8, hour: i8, minute: i8, second: i8, weekday: i8, interval: i32) → ConvertingReceiver<()>

Configures a repeatable alarm. The RealTimeClockBricklet::get_alarm_callback_receiver 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:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1
  • REAL_TIME_CLOCK_BRICKLET_ALARM_INTERVAL_DISABLED = -1

New in version 2.0.1 (Plugin).

pub fn RealTimeClockBricklet::get_alarm(&self) → ConvertingReceiver<Alarm>

Returns the alarm configuration as set by RealTimeClockBricklet::set_alarm.

The following constants are available for this function:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1
  • REAL_TIME_CLOCK_BRICKLET_ALARM_INTERVAL_DISABLED = -1

New in version 2.0.1 (Plugin).

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

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.

pub fn RealTimeClockBricklet::get_date_time_callback_receiver(&self) → ConvertingCallbackReceiver<DateTimeEvent>

Receivers created with this function receive Date Time events.

This callback is triggered periodically with the period that is set by RealTimeClockBricklet::set_date_time_callback_period. The members of the received struct are the same as for RealTimeClockBricklet::get_date_time and RealTimeClockBricklet::get_timestamp combined.

The RealTimeClockBricklet::get_date_time_callback_receiver callback is only triggered if the date or time changed since the last triggering.

The following constants are available for this function:

  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_MONDAY = 1
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_TUESDAY = 2
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_WEDNESDAY = 3
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_THURSDAY = 4
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_FRIDAY = 5
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SATURDAY = 6
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SUNDAY = 7

New in version 2.0.1 (Plugin).

pub fn RealTimeClockBricklet::get_alarm_callback_receiver(&self) → ConvertingCallbackReceiver<AlarmEvent>

Receivers created with this function receive Alarm events.

This callback is triggered every time the current date and time matches the configured alarm (see RealTimeClockBricklet::set_alarm). The members of the received struct are the same as for RealTimeClockBricklet::get_date_time and RealTimeClockBricklet::get_timestamp combined.

The following constants are available for this function:

  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_MONDAY = 1
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_TUESDAY = 2
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_WEDNESDAY = 3
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_THURSDAY = 4
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_FRIDAY = 5
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SATURDAY = 6
  • REAL_TIME_CLOCK_BRICKLET_WEEKDAY_SUNDAY = 7

New in version 2.0.1 (Plugin).

Constants

RealTimeClockBricklet::DEVICE_IDENTIFIER

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

The RealTimeClockBricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

RealTimeClockBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Real-Time Clock Bricklet.