Rust - Real-Time Clock Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Real-Time Clock Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Real-Time Clock Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.

Beispiele

Der folgende Beispielcode ist 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

Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.

Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.

Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.

Grundfunktionen

pub fn RealTimeClockBricklet::new(uid: &str, ip_connection: &IpConnection) → RealTimeClockBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • real_time_clock – Typ: RealTimeClockBricklet

Erzeugt ein neues RealTimeClockBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ip_connection hinzu:

let real_time_clock = RealTimeClockBricklet::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden wurde (siehe Beispiele oben).

pub fn RealTimeClockBricklet::set_date_time(&self, year: u16, month: u8, day: u8, hour: u8, minute: u8, second: u8, centisecond: u8, weekday: u8) → ConvertingReceiver<()>
Parameter:
  • year – Typ: u16, Wertebereich: [2000 bis 2099]
  • month – Typ: u8, Wertebereich: [1 bis 12]
  • day – Typ: u8, Wertebereich: [1 bis 31]
  • hour – Typ: u8, Wertebereich: [0 bis 23]
  • minute – Typ: u8, Wertebereich: [0 bis 59]
  • second – Typ: u8, Wertebereich: [0 bis 59]
  • centisecond – Typ: u8, Wertebereich: [0 bis 99]
  • weekday – Typ: u8, Wertebereich: Siehe Konstanten

Setzt das aktuelle Datum (inklusive Wochentag).

Wenn die Backup Batterie eingebaut ist, dann behält die Echtzeituhr Datum und Zeit auch dann, wenn kein Brick das Bricklet mit Strom versorgt.

Die Echtzeituhr behandelt Schaltjahre und fügt den 29. Februar entsprechend ein. Schaltsekunden, Zeitzonen und die Sommerzeit werden jedoch nicht behandelt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für weekday:

  • 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>
Rückgabeobjekt:
  • year – Typ: u16, Wertebereich: [2000 bis 2099]
  • month – Typ: u8, Wertebereich: [1 bis 12]
  • day – Typ: u8, Wertebereich: [1 bis 31]
  • hour – Typ: u8, Wertebereich: [0 bis 23]
  • minute – Typ: u8, Wertebereich: [0 bis 59]
  • second – Typ: u8, Wertebereich: [0 bis 59]
  • centisecond – Typ: u8, Wertebereich: [0 bis 99]
  • weekday – Typ: u8, Wertebereich: Siehe Konstanten

Gibt das aktuelle Datum (inklusive Wochentag) und die aktuelle Zeit der Echtzeituhr zurück.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für weekday:

  • 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>
Rückgabe:
  • timestamp – Typ: i64, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

Gibt das aktuelle Datum und Zeit der Echtzeituhr. Der Zeitstempel hat eine effektive Auflösung von Hundertstelsekunden und ist der Versatz zum 01.01.2000 00:00:00,000.

Fortgeschrittene Funktionen

pub fn RealTimeClockBricklet::set_offset(&self, offset: i8) → ConvertingReceiver<()>
Parameter:
  • offset – Typ: i8, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]

Setzt den Versatz ein, den die Echtzeituhr ausgleichen soll. Der Versatz kann in 2,17 ppm Schritten zwischen -277,76 ppm (-128) und +275,59 ppm (127) eingestellt werden.

Die Echtzeituhr kann von der eigentlichen Zeit abweichen, bedingt durch die Frequenzabweichung des verbauten 32,768 kHz Quarzes. Selbst ohne Ausgleich (Werkseinstellung) sollte die daraus entstehende Zeitabweichung höchstens ±20 ppm (±52,6 Sekunden pro Monat) betragen.

Diese Abweichung kann berechnet werden, durch Vergleich der gleichen Zeitdauer einmal mit der Echtzeituhr (rtc_duration) gemessen und einmal mit einer genauen Kontrolluhr (ref_duration) gemessen.

Um das beste Ergebnis zu erzielen, sollte der eingestellte Versatz zuerst auf 0 ppm gesetzt und dann eine Zeitdauer von mindestens 6 Stunden gemessen werden.

Der neue Versatz (new_offset) kann dann wie folgt aus dem aktuell eingestellten Versatz (current_offset) und den gemessenen Zeitdauern berechnet werden:

new_offset = current_offset - round(1000000 * (rtc_duration - ref_duration) / rtc_duration / 2.17)

Wenn der Versatz berechnet werden soll, dann empfehlen wir den Kalibrierungsdialog in Brick Viewer dafür zu verwenden, anstatt die Berechnung von Hand durchzuführen.

Der Versatz wird im EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

pub fn RealTimeClockBricklet::get_offset(&self) → ConvertingReceiver<i8>
Rückgabe:
  • offset – Typ: i8, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]

Gibt den Versatz zurück, wie von RealTimeClockBricklet::set_offset gesetzt.

pub fn RealTimeClockBricklet::get_identity(&self) → ConvertingReceiver<Identity>
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connected_uid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'i', 'z']
  • hardware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: u16, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

pub fn RealTimeClockBricklet::set_date_time_callback_period(&self, period: u32) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der RealTimeClockBricklet::get_date_time_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der RealTimeClockBricklet::get_date_time_callback_receiver Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

Neu in Version 2.0.1 (Plugin).

pub fn RealTimeClockBricklet::get_date_time_callback_period(&self) → ConvertingReceiver<u32>
Rückgabe:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von RealTimeClockBricklet::set_date_time_callback_period gesetzt.

Neu 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<()>
Parameter:
  • month – Typ: i8, Wertebereich: [-1, 2000 bis 2099] mit Konstanten
  • day – Typ: i8, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • hour – Typ: i8, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • minute – Typ: i8, Wertebereich: [-1 bis 23] mit Konstanten
  • second – Typ: i8, Wertebereich: [-1 bis 59] mit Konstanten
  • weekday – Typ: i8, Wertebereich: [-1 bis 59] mit Konstanten
  • interval – Typ: i32, Einheit: 1 s, Wertebereich: Siehe Konstanten

Konfiguriert einen wiederholbaren Alarm. Der RealTimeClockBricklet::get_alarm_callback_receiver Callback wird ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem konfigurierten Alarm übereinstimmen.

Wird ein Parameter auf -1 gesetzt, dann wird es deaktiviert und nimmt nicht am Übereinstimmungstest teil. Werden alle Parameter auf -1 gesetzt, dann ist der Alarm vollständig deaktiviert.

Um z.B. den Alarm jeden Tag um 7:30 Uhr auszulösen kann dieser auf (-1, -1, 7, 30, -1, -1, -1) konfiguriert werden. Die Stunde ist auf 7 gesetzt und die Minute auf 30. Der Alarm wird ausgelöst, wenn alle aktiven Parameter mit dem aktuellen Datum und der aktuellen Zeit übereinstimmen.

Das Intervall hat eine spezielle Rolle. Wenn es nicht auf -1 gesetzt ist, dann konfiguriert sich der Alarm nach jeder Auslösung entsprechend selbst neu. Dies kann für wiederholende Alarme genutzt werden, die nicht durch Übereinstimmung mit Datum und Uhrzeit abgebildet werden können. Um z.B. alle 23 Sekunden einen Alarm auszulösen kann dieser als (-1, -1, -1, -1, -1, -1, 23) konfiguriert werden. Intern nimmt das Bricklet das aktuelle Datum und die aktuelle Uhrzeit, addiert 23 Sekunden und setzt das Ergebnis als Alarm. Der erste Alarm wir dann 23 Sekunden nach dem Aufruf ausgelöst werden. Da das Intervall nicht -1 ist wird das Bricklet dann intern wieder das gleiche tun: 23 Sekunden auf das aktuelle Datum und die aktuelle Uhrzeit addieren und das Ergebnis als Alarm setzten. Dadurch entsteht ein sich alle 23 Sekunden wiederholender Alarm.

Das Intervall kann auch in Kombination mit den anderen Parametern verwendet werden. Wird z.B. der Alarm auf (-1, -1, 7, 30, -1, -1, 300) konfiguriert dann wird der Alarm jeden Tag um 7:30 Uhr ausgelöst und dann all 5 Minuten wiederholt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für month:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für day:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für hour:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für minute:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für second:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für weekday:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für interval:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_INTERVAL_DISABLED = -1

Neu in Version 2.0.1 (Plugin).

pub fn RealTimeClockBricklet::get_alarm(&self) → ConvertingReceiver<Alarm>
Rückgabeobjekt:
  • month – Typ: i8, Wertebereich: [-1, 2000 bis 2099] mit Konstanten
  • day – Typ: i8, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • hour – Typ: i8, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • minute – Typ: i8, Wertebereich: [-1 bis 23] mit Konstanten
  • second – Typ: i8, Wertebereich: [-1 bis 59] mit Konstanten
  • weekday – Typ: i8, Wertebereich: [-1 bis 59] mit Konstanten
  • interval – Typ: i32, Einheit: 1 s, Wertebereich: Siehe Konstanten

Gibt die Alarmkonfiguration zurück, wie von RealTimeClockBricklet::set_alarm gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für month:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für day:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für hour:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für minute:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für second:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für weekday:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_MATCH_DISABLED = -1

Für interval:

  • REAL_TIME_CLOCK_BRICKLET_ALARM_INTERVAL_DISABLED = -1

Neu in Version 2.0.1 (Plugin).

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

pub fn RealTimeClockBricklet::get_date_time_callback_receiver(&self) → ConvertingCallbackReceiver<DateTimeEvent>
Event-Objekt:
  • year – Typ: u16, Wertebereich: [2000 bis 2099]
  • month – Typ: u8, Wertebereich: [1 bis 12]
  • day – Typ: u8, Wertebereich: [1 bis 31]
  • hour – Typ: u8, Wertebereich: [0 bis 23]
  • minute – Typ: u8, Wertebereich: [0 bis 59]
  • second – Typ: u8, Wertebereich: [0 bis 59]
  • centisecond – Typ: u8, Wertebereich: [0 bis 99]
  • weekday – Typ: u8, Wertebereich: Siehe Konstanten
  • timestamp – Typ: i64, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Date Time-Events.

Dieser Callback wird mit der Periode, wie gesetzt mit RealTimeClockBricklet::set_date_time_callback_period, ausgelöst. Die Felder der empfangenen Struktur sind die gleichen wie die von RealTimeClockBricklet::get_date_time und RealTimeClockBricklet::get_timestamp kombiniert.

Der RealTimeClockBricklet::get_date_time_callback_receiver Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für weekday:

  • 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

Neu in Version 2.0.1 (Plugin).

pub fn RealTimeClockBricklet::get_alarm_callback_receiver(&self) → ConvertingCallbackReceiver<AlarmEvent>
Event-Objekt:
  • year – Typ: u16, Wertebereich: [2000 bis 2099]
  • month – Typ: u8, Wertebereich: [1 bis 12]
  • day – Typ: u8, Wertebereich: [1 bis 31]
  • hour – Typ: u8, Wertebereich: [0 bis 23]
  • minute – Typ: u8, Wertebereich: [0 bis 59]
  • second – Typ: u8, Wertebereich: [0 bis 59]
  • centisecond – Typ: u8, Wertebereich: [0 bis 99]
  • weekday – Typ: u8, Wertebereich: Siehe Konstanten
  • timestamp – Typ: i64, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Alarm-Events.

Dieser Callback wird jedes mal ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe RealTimeClockBricklet::set_alarm). Die Felder der empfangenen Struktur sind die gleichen wie die von RealTimeClockBricklet::get_date_time und RealTimeClockBricklet::get_timestamp kombiniert.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für weekday:

  • 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

Neu in Version 2.0.1 (Plugin).

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

pub fn RealTimeClockBricklet::get_api_version(&self) → [u8; 3]
Rückgabeobjekt:
  • api_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

pub fn RealTimeClockBricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels RealTimeClockBricklet::set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • 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(&mut self, function_id: u8, response_expected: bool) → ()
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • 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) → ()
Parameter:
  • response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

pub const RealTimeClockBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Real-Time Clock Bricklet zu identifizieren.

Die RealTimeClockBricklet::get_identity Funktion und der IpConnection::get_enumerate_callback_receiver Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

pub const RealTimeClockBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Real-Time Clock Bricklet dar.