Struct tinkerforge::real_time_clock_v2_bricklet::RealTimeClockV2Bricklet

source ·

pub struct RealTimeClockV2Bricklet { /* private fields */ }

Expand description

Battery-backed real-time clock

Implementations

source

pub fn new(uid: &str, ip_connection: &IpConnection) -> RealTimeClockV2Bricklet

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

source

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

source

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

source

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.

source

pub fn get_date_time_callback_receiver(
&self
) -> ConvertingCallbackReceiver<DateTimeEvent>

This receiver is triggered periodically with the period that is set by Set Date Time Receiver Configuration. The parameters are the same as for Get Date Time.

source

pub fn get_alarm_callback_receiver(
&self
) -> ConvertingCallbackReceiver<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.

source

pub fn 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.

Associated constants:

REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_MONDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_TUESDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_WEDNESDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_THURSDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_FRIDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_SATURDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_SUNDAY

source

pub fn 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 timestamp represents the current date and the the current time of the real-time clock converted to milliseconds.

Associated constants:

REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_MONDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_TUESDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_WEDNESDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_THURSDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_FRIDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_SATURDAY
REAL_TIME_CLOCK_V2BRICKLET_WEEKDAY_SUNDAY

source

pub fn 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.

source

pub fn 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.

source

pub fn get_offset(&self) -> ConvertingReceiver<i8>

Returns the offset as set by Set Offset.

source

pub fn set_date_time_callback_configuration(
&self,
period: u32
) -> ConvertingReceiver<()>

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

The default value is 0.

source

pub fn get_date_time_callback_configuration(&self) -> ConvertingReceiver<u32>

Returns the period as set by Set Date Time Receiver Configuration.

source

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

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_V2BRICKLET_ALARM_MATCH_DISABLED
REAL_TIME_CLOCK_V2BRICKLET_ALARM_INTERVAL_DISABLED

source

pub fn get_alarm(&self) -> ConvertingReceiver<Alarm>

Returns the alarm configuration as set by Set Alarm.

Associated constants:

REAL_TIME_CLOCK_V2BRICKLET_ALARM_MATCH_DISABLED
REAL_TIME_CLOCK_V2BRICKLET_ALARM_INTERVAL_DISABLED

source

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>

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.

source

pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>

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_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_STATUS_OK
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

source

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see Set Bootloader Mode.

Associated constants:

REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
REAL_TIME_CLOCK_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

source

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

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.

source

pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

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.

source

pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>

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_V2BRICKLET_STATUS_LED_CONFIG_OFF
REAL_TIME_CLOCK_V2BRICKLET_STATUS_LED_CONFIG_ON
REAL_TIME_CLOCK_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
REAL_TIME_CLOCK_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by Set Status LED Config

Associated constants:

REAL_TIME_CLOCK_V2BRICKLET_STATUS_LED_CONFIG_OFF
REAL_TIME_CLOCK_V2BRICKLET_STATUS_LED_CONFIG_ON
REAL_TIME_CLOCK_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
REAL_TIME_CLOCK_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

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

source