Visual Basic .NET - Real-Time Clock Bricklet

Dies ist die Beschreibung der Visual Basic .NET 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 Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Real-Time Clock Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim rtc As New BrickletRealTimeClock(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Get current date and time
        Dim year As Integer
        Dim month, day, hour, minute, second, centisecond, weekday As Byte

        rtc.GetDateTime(year, month, day, hour, minute, second, centisecond, weekday)

        Console.WriteLine("Year: " + year.ToString())
        Console.WriteLine("Month: " + month.ToString())
        Console.WriteLine("Day: " + day.ToString())
        Console.WriteLine("Hour: " + hour.ToString())
        Console.WriteLine("Minute: " + minute.ToString())
        Console.WriteLine("Second: " + second.ToString())
        Console.WriteLine("Centisecond: " + centisecond.ToString())

        If weekday = BrickletRealTimeClock.WEEKDAY_MONDAY Then
            Console.WriteLine("Weekday: Monday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_TUESDAY Then
            Console.WriteLine("Weekday: Tuesday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_WEDNESDAY Then
            Console.WriteLine("Weekday: Wednesday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_THURSDAY Then
            Console.WriteLine("Weekday: Thursday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_FRIDAY Then
            Console.WriteLine("Weekday: Friday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_SATURDAY Then
            Console.WriteLine("Weekday: Saturday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_SUNDAY Then
            Console.WriteLine("Weekday: Sunday")
        End If

        ' Get current timestamp
        Dim timestamp As Long = rtc.GetTimestamp()
        Console.WriteLine("Timestamp: " + timestamp.ToString() + " ms")

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback

Download (ExampleCallback.vb)

 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
62
Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Real-Time Clock Bricklet

    ' Callback subroutine for date and time callback
    Sub DateTimeCB(ByVal sender As BrickletRealTimeClock, ByVal year As Integer, _
                   ByVal month As Byte, ByVal day As Byte, ByVal hour As Byte, _
                   ByVal minute As Byte, ByVal second As Byte, _
                   ByVal centisecond As Byte, ByVal weekday As Byte, _
                   ByVal timestamp As Long)
        Console.WriteLine("Year: " + year.ToString())
        Console.WriteLine("Month: " + month.ToString())
        Console.WriteLine("Day: " + day.ToString())
        Console.WriteLine("Hour: " + hour.ToString())
        Console.WriteLine("Minute: " + minute.ToString())
        Console.WriteLine("Second: " + second.ToString())
        Console.WriteLine("Centisecond: " + centisecond.ToString())

        If weekday = BrickletRealTimeClock.WEEKDAY_MONDAY Then
            Console.WriteLine("Weekday: Monday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_TUESDAY Then
            Console.WriteLine("Weekday: Tuesday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_WEDNESDAY Then
            Console.WriteLine("Weekday: Wednesday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_THURSDAY Then
            Console.WriteLine("Weekday: Thursday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_FRIDAY Then
            Console.WriteLine("Weekday: Friday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_SATURDAY Then
            Console.WriteLine("Weekday: Saturday")
        Else If weekday = BrickletRealTimeClock.WEEKDAY_SUNDAY Then
            Console.WriteLine("Weekday: Sunday")
        End If

        Console.WriteLine("Timestamp: " + timestamp.ToString())
        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim rtc As New BrickletRealTimeClock(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register date and time callback to subroutine DateTimeCB
        AddHandler rtc.DateTimeCallback, AddressOf DateTimeCB

        ' Set period for date and time callback 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.SetDateTimeCallbackPeriod(5000)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

Class BrickletRealTimeClock(ByVal uid As String, ByVal ipcon As IPConnection)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

Dim realTimeClock As New BrickletRealTimeClock("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Sub BrickletRealTimeClock.SetDateTime(ByVal year As Integer, ByVal month As Byte, ByVal day As Byte, ByVal hour As Byte, ByVal minute As Byte, ByVal second As Byte, ByVal centisecond As Byte, ByVal weekday As Byte)

Setzt das aktuelle Datum (inklusive Wochentag) und die aktuelle Zeit mit Hundertstelsekunden Auflösung.

Mögliche Wertebereiche:

  • Year: 2000 bis 2099
  • Month: 1 bis 12 (Januar bis Dezember)
  • Day: 1 bis 31
  • Hour: 0 bis 23
  • Minute: 0 bis 59
  • Second: 0 bis 59
  • Centisecond: 0 bis 99
  • Weekday: 1 bis 7 (Montag bis Sonntag)

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:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7
Sub BrickletRealTimeClock.GetDateTime(ByRef year As Integer, ByRef month As Byte, ByRef day As Byte, ByRef hour As Byte, ByRef minute As Byte, ByRef second As Byte, ByRef centisecond As Byte, ByRef weekday As Byte)

Gibt das aktuelle Datum (inklusive Wochentag) und die aktuelle Zeit der Echtzeituhr mit Hundertstelsekunden Auflösung zurück.

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

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7
Function BrickletRealTimeClock.GetTimestamp() As Long

Gibt das aktuelle Datum und Zeit der Echtzeituhr in Millisekunden umgerechnet zurück. Der Zeitstempel hat eine effektive Auflösung von Hundertstelsekunden.

Fortgeschrittene Funktionen

Sub BrickletRealTimeClock.SetOffset(ByVal offset As Short)

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.

Function BrickletRealTimeClock.GetOffset() As Short

Gibt den Versatz zurück, wie von SetOffset() gesetzt.

Function BrickletRealTimeClock.GetAPIVersion() As Byte()

Gibt die Version der API Definition (Major, Minor, Revision) 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.

Function BrickletRealTimeClock.GetResponseExpected(ByVal functionId As Byte) As Boolean

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 SetResponseExpected(). 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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickletRealTimeClock.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME = 1
  • BrickletRealTimeClock.FUNCTION_SET_OFFSET = 4
  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • BrickletRealTimeClock.FUNCTION_SET_ALARM = 8
Sub BrickletRealTimeClock.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletRealTimeClock.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

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 kann 'a', 'b', 'c' oder 'd' sein.

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

Sub BrickletRealTimeClock.SetDateTimeCallbackPeriod(ByVal period As Long)

Setzt die Periode in ms mit welcher der DateTimeCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

Der Standardwert ist 0.

Neu in Version 2.0.1 (Plugin).

Function BrickletRealTimeClock.GetDateTimeCallbackPeriod() As Long

Gibt die Periode zurück, wie von SetDateTimeCallbackPeriod() gesetzt.

Neu in Version 2.0.1 (Plugin).

Sub BrickletRealTimeClock.SetAlarm(ByVal month As Short, ByVal day As Short, ByVal hour As Short, ByVal minute As Short, ByVal second As Short, ByVal weekday As Short, ByVal interval As Integer)

Konfiguriert einen wiederholbaren Alarm. Der AlarmCallback 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:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1
  • BrickletRealTimeClock.ALARM_INTERVAL_DISABLED = -1

Neu in Version 2.0.1 (Plugin).

Sub BrickletRealTimeClock.GetAlarm(ByRef month As Short, ByRef day As Short, ByRef hour As Short, ByRef minute As Short, ByRef second As Short, ByRef weekday As Short, ByRef interval As Integer)

Gibt die Alarmkonfiguration zurück, wie von SetAlarm() gesetzt.

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

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1
  • BrickletRealTimeClock.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 erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletRealTimeClock, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler realTimeClock.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

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.

Event BrickletRealTimeClock.DateTimeCallback(ByVal sender As BrickletRealTimeClock, ByVal year As Integer, ByVal month As Byte, ByVal day As Byte, ByVal hour As Byte, ByVal minute As Byte, ByVal second As Byte, ByVal centisecond As Byte, ByVal weekday As Byte, ByVal timestamp As Long)

Dieser Callback wird mit der Periode, wie gesetzt mit SetDateTimeCallbackPeriod(), ausgelöst. Die Parameter sind die gleichen wie die von GetDateTime() und GetTimestamp() kombiniert.

Der DateTimeCallback 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:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7

Neu in Version 2.0.1 (Plugin).

Event BrickletRealTimeClock.AlarmCallback(ByVal sender As BrickletRealTimeClock, ByVal year As Integer, ByVal month As Byte, ByVal day As Byte, ByVal hour As Byte, ByVal minute As Byte, ByVal second As Byte, ByVal centisecond As Byte, ByVal weekday As Byte, ByVal timestamp As Long)

Dieser Callback wird jedes mal ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe SetAlarm()). Die Parameter sind die gleichen wie die von GetDateTime() und GetTimestamp() kombiniert.

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

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7

Neu in Version 2.0.1 (Plugin).

Konstanten

Const BrickletRealTimeClock.DEVICE_IDENTIFIER

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

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Const BrickletRealTimeClock.DEVICE_DISPLAY_NAME

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