Struct RealTimeClockV2Bricklet

pub struct RealTimeClockV2Bricklet { /* private fields */ }

Battery-backed real-time clock

Implementations

impl RealTimeClockV2Bricklet

pub const DEVICE_IDENTIFIER: u16 = 2_106u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Real-Time Clock Bricklet 2.0"

pub fn new(uid: Uid, connection: AsyncIpConnection) -> RealTimeClockV2Bricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected( &mut self, fun: RealTimeClockV2BrickletFunction, ) -> Result<bool, GetResponseExpectedError>

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.

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected( &mut self, fun: RealTimeClockV2BrickletFunction, response_expected: bool, ) -> Result<(), SetResponseExpectedError>

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.

pub fn 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 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 async fn get_date_time_callback_receiver( &mut self, ) -> impl Stream<Item = DateTimeEvent>

This receiver 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.

pub async fn get_alarm_callback_receiver( &mut self, ) -> impl Stream<Item = AlarmEvent>

This receiver 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].

pub async fn set_date_time( &mut self, year: u16, month: u8, day: u8, hour: u8, minute: u8, second: u8, centisecond: u8, weekday: u8, ) -> Result<(), TinkerforgeError>

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.

Associated constants:

• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_MONDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_TUESDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_WEDNESDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_THURSDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_FRIDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_SATURDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_SUNDAY

pub async fn get_date_time(&mut self) -> Result<DateTime, TinkerforgeError>

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.

Associated constants:

• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_MONDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_TUESDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_WEDNESDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_THURSDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_FRIDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_SATURDAY
• REAL_TIME_CLOCK_V2_BRICKLET_WEEKDAY_SUNDAY

pub async fn get_timestamp(&mut self) -> Result<i64, TinkerforgeError>

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.

pub async fn set_offset(&mut self, offset: i8) -> Result<(), TinkerforgeError>

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 async fn get_offset(&mut self) -> Result<i8, TinkerforgeError>

Returns the offset as set by [set_offset].

pub async fn set_date_time_callback_configuration( &mut self, period: u32, ) -> Result<(), TinkerforgeError>

Sets the period with which the [get_date_time_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

pub async fn get_date_time_callback_configuration( &mut self, ) -> Result<u32, TinkerforgeError>

Returns the period as set by [set_date_time_callback_configuration].

pub async fn set_alarm( &mut self, month: i8, day: i8, hour: i8, minute: i8, second: i8, weekday: i8, interval: i32, ) -> Result<(), TinkerforgeError>

Configures a repeatable alarm. The [get_alarm_callback_receiver] receiver 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.

Associated constants:

• REAL_TIME_CLOCK_V2_BRICKLET_ALARM_MATCH_DISABLED
• REAL_TIME_CLOCK_V2_BRICKLET_ALARM_INTERVAL_DISABLED

pub async fn get_alarm(&mut self) -> Result<Alarm, TinkerforgeError>

Returns the alarm configuration as set by [set_alarm].

Associated constants:

• REAL_TIME_CLOCK_V2_BRICKLET_ALARM_MATCH_DISABLED
• REAL_TIME_CLOCK_V2_BRICKLET_ALARM_INTERVAL_DISABLED

pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>

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.

pub async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>

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.

Associated constants:

• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_STATUS_OK
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• REAL_TIME_CLOCK_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>

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.

pub async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>

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.

pub async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>

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.

Associated constants:

• REAL_TIME_CLOCK_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• REAL_TIME_CLOCK_V2_BRICKLET_STATUS_LED_CONFIG_ON
• REAL_TIME_CLOCK_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• REAL_TIME_CLOCK_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>

Returns the configuration as set by [set_status_led_config]

Associated constants:

• REAL_TIME_CLOCK_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• REAL_TIME_CLOCK_V2_BRICKLET_STATUS_LED_CONFIG_ON
• REAL_TIME_CLOCK_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• REAL_TIME_CLOCK_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>

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.

pub async fn reset(&mut self) -> Result<(), TinkerforgeError>

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!

pub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>

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.

pub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>

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

pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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. |device_identifier_constant|

Trait Implementations

impl Clone for RealTimeClockV2Bricklet

fn clone(&self) -> RealTimeClockV2Bricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.