Mathematica - Real-Time Clock Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Real-Time Clock Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
rtc=NETNew["Tinkerforge.BrickletRealTimeClock",uid,ipcon]
ipcon@Connect[host,port]

(*Get current date and time*)
year=0;month=0;day=0;hour=0;minute=0;second=0;centisecond=0;weekday=0
rtc@GetDateTime[year,month,day,hour,minute,second,centisecond,weekday]

Print["Year: "<>ToString[year]]
Print["Month: "<>ToString[month]]
Print["Day: "<>ToString[day]]
Print["Hour: "<>ToString[hour]]
Print["Minute: "<>ToString[minute]]
Print["Second: "<>ToString[second]]
Print["Centisecond: "<>ToString[centisecond]]
If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUMONDAY,Print["Weekday: Monday"]]
If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUTUESDAY,Print["Weekday: Tuesday"]]
If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUWEDNESDAY,Print["Weekday: Wednesday"]]
If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUTHURSDAY,Print["Weekday: Thursday"]]
If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUFRIDAY,Print["Weekday: Friday"]]
If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUSATURDAY,Print["Weekday: Saturday"]]
If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUSUNDAY,Print["Weekday: Sunday"]]

(*Get current timestamp*)
Print["Timestamp: "<>ToString[N[Quantity[rtc@GetTimestamp[],"ms"]]]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[rtc]
ReleaseNETObject[ipcon]

Callback

Download (ExampleCallback.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Real-Time Clock Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
rtc=NETNew["Tinkerforge.BrickletRealTimeClock",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for date and time callback*)
DateTimeCB[sender_,year_,month_,day_,hour_,minute_,second_,centisecond_,weekday_,
           timestamp_]:=
 Module[{},
  Print["Year: "<>ToString[year]];
  Print["Month: "<>ToString[month]];
  Print["Day: "<>ToString[day]];
  Print["Hour: "<>ToString[hour]];
  Print["Minute: "<>ToString[minute]];
  Print["Second: "<>ToString[second]];
  Print["Centisecond: "<>ToString[centisecond]];
  If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUMONDAY,Print["Weekday: Monday"]];
  If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUTUESDAY,Print["Weekday: Tuesday"]];
  If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUWEDNESDAY,Print["Weekday: Wednesday"]];
  If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUTHURSDAY,Print["Weekday: Thursday"]];
  If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUFRIDAY,Print["Weekday: Friday"]];
  If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUSATURDAY,Print["Weekday: Saturday"]];
  If[weekday==Tinkerforge`BrickletRealTimeClock`WEEKDAYUSUNDAY,Print["Weekday: Sunday"]];
  Print["Timestamp: "<>ToString[timestamp]]
 ]

AddEventHandler[rtc@DateTimeCallback,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]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[rtc]
ReleaseNETObject[ipcon]

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletRealTimeClock[uid, ipcon] → realTimeClock
Parameter:
  • uid – Typ: String
  • ipcon – Typ: NETObject[IPConnection]
Rückgabe:
  • realTimeClock – Typ: NETObject[BrickletRealTimeClock]

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

realTimeClock=NETNew["Tinkerforge.BrickletRealTimeClock","YOUR_DEVICE_UID",ipcon]

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickletRealTimeClock@SetDateTime[year, month, day, hour, minute, second, centisecond, weekday] → Null
Parameter:
  • year – Typ: Integer, Wertebereich: [2000 bis 2099]
  • month – Typ: Integer, Wertebereich: [1 bis 12]
  • day – Typ: Integer, Wertebereich: [1 bis 31]
  • hour – Typ: Integer, Wertebereich: [0 bis 23]
  • minute – Typ: Integer, Wertebereich: [0 bis 59]
  • second – Typ: Integer, Wertebereich: [0 bis 59]
  • centisecond – Typ: Integer, Wertebereich: [0 bis 99]
  • weekday – Typ: Integer, 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:

  • BrickletRealTimeClock`WEEKDAYUMONDAY = 1
  • BrickletRealTimeClock`WEEKDAYUTUESDAY = 2
  • BrickletRealTimeClock`WEEKDAYUWEDNESDAY = 3
  • BrickletRealTimeClock`WEEKDAYUTHURSDAY = 4
  • BrickletRealTimeClock`WEEKDAYUFRIDAY = 5
  • BrickletRealTimeClock`WEEKDAYUSATURDAY = 6
  • BrickletRealTimeClock`WEEKDAYUSUNDAY = 7
BrickletRealTimeClock@GetDateTime[out year, out month, out day, out hour, out minute, out second, out centisecond, out weekday] → Null
Ausgabeparameter:
  • year – Typ: Integer, Wertebereich: [2000 bis 2099]
  • month – Typ: Integer, Wertebereich: [1 bis 12]
  • day – Typ: Integer, Wertebereich: [1 bis 31]
  • hour – Typ: Integer, Wertebereich: [0 bis 23]
  • minute – Typ: Integer, Wertebereich: [0 bis 59]
  • second – Typ: Integer, Wertebereich: [0 bis 59]
  • centisecond – Typ: Integer, Wertebereich: [0 bis 99]
  • weekday – Typ: Integer, 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:

  • BrickletRealTimeClock`WEEKDAYUMONDAY = 1
  • BrickletRealTimeClock`WEEKDAYUTUESDAY = 2
  • BrickletRealTimeClock`WEEKDAYUWEDNESDAY = 3
  • BrickletRealTimeClock`WEEKDAYUTHURSDAY = 4
  • BrickletRealTimeClock`WEEKDAYUFRIDAY = 5
  • BrickletRealTimeClock`WEEKDAYUSATURDAY = 6
  • BrickletRealTimeClock`WEEKDAYUSUNDAY = 7
BrickletRealTimeClock@GetTimestamp[] → timestamp
Rückgabe:
  • timestamp – Typ: Integer, 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

BrickletRealTimeClock@SetOffset[offset] → Null
Parameter:
  • offset – Typ: Integer, 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.

BrickletRealTimeClock@GetOffset[] → offset
Rückgabe:
  • offset – Typ: Integer, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]

Gibt den Versatz zurück, wie von SetOffset[] gesetzt.

BrickletRealTimeClock@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Ausgabeparameter:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Integer, Wertebereich: [ToCharacterCode["a"][[0]] bis ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]]
  • hardwareVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, Wertebereich: [0 bis 255]
  • firmwareVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Integer, 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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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

BrickletRealTimeClock@SetDateTimeCallbackPeriod[period] → Null
Parameter:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode 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.

Neu in Version 2.0.1 (Plugin).

BrickletRealTimeClock@GetDateTimeCallbackPeriod[] → period
Rückgabe:
  • period – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetDateTimeCallbackPeriod[] gesetzt.

Neu in Version 2.0.1 (Plugin).

BrickletRealTimeClock@SetAlarm[month, day, hour, minute, second, weekday, interval] → Null
Parameter:
  • month – Typ: Integer, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • day – Typ: Integer, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • hour – Typ: Integer, Wertebereich: [-1, 0 bis 23] mit Konstanten
  • minute – Typ: Integer, Wertebereich: [-1, 0 bis 59] mit Konstanten
  • second – Typ: Integer, Wertebereich: [-1, 0 bis 59] mit Konstanten
  • weekday – Typ: Integer, Wertebereich: [-1, 1 bis 7] mit Konstanten
  • interval – Typ: Integer, Einheit: 1 s, Wertebereich: [-1, 1 bis 231 - 1] mit Konstanten

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:

Für month:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für day:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für hour:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für minute:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für second:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für weekday:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für interval:

  • BrickletRealTimeClock`ALARMUINTERVALUDISABLED = -1

Neu in Version 2.0.1 (Plugin).

BrickletRealTimeClock@GetAlarm[out month, out day, out hour, out minute, out second, out weekday, out interval] → Null
Ausgabeparameter:
  • month – Typ: Integer, Wertebereich: [-1, 1 bis 12] mit Konstanten
  • day – Typ: Integer, Wertebereich: [-1, 1 bis 31] mit Konstanten
  • hour – Typ: Integer, Wertebereich: [-1, 0 bis 23] mit Konstanten
  • minute – Typ: Integer, Wertebereich: [-1, 0 bis 59] mit Konstanten
  • second – Typ: Integer, Wertebereich: [-1, 0 bis 59] mit Konstanten
  • weekday – Typ: Integer, Wertebereich: [-1, 1 bis 7] mit Konstanten
  • interval – Typ: Integer, Einheit: 1 s, Wertebereich: [-1, 1 bis 231 - 1] mit Konstanten

Gibt die Alarmkonfiguration zurück, wie von SetAlarm[] gesetzt.

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

Für month:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für day:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für hour:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für minute:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für second:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für weekday:

  • BrickletRealTimeClock`ALARMUMATCHUDISABLED = -1

Für interval:

  • BrickletRealTimeClock`ALARMUINTERVALUDISABLED = -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 Funktion einem Callback Property des Geräte Objektes zugewiesen wird:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[realTimeClock@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

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[sender, year, month, day, hour, minute, second, centisecond, weekday, timestamp]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletRealTimeClock]
  • year – Typ: Integer, Wertebereich: [2000 bis 2099]
  • month – Typ: Integer, Wertebereich: [1 bis 12]
  • day – Typ: Integer, Wertebereich: [1 bis 31]
  • hour – Typ: Integer, Wertebereich: [0 bis 23]
  • minute – Typ: Integer, Wertebereich: [0 bis 59]
  • second – Typ: Integer, Wertebereich: [0 bis 59]
  • centisecond – Typ: Integer, Wertebereich: [0 bis 99]
  • weekday – Typ: Integer, Wertebereich: Siehe Konstanten
  • timestamp – Typ: Integer, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

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:

Für weekday:

  • BrickletRealTimeClock`WEEKDAYUMONDAY = 1
  • BrickletRealTimeClock`WEEKDAYUTUESDAY = 2
  • BrickletRealTimeClock`WEEKDAYUWEDNESDAY = 3
  • BrickletRealTimeClock`WEEKDAYUTHURSDAY = 4
  • BrickletRealTimeClock`WEEKDAYUFRIDAY = 5
  • BrickletRealTimeClock`WEEKDAYUSATURDAY = 6
  • BrickletRealTimeClock`WEEKDAYUSUNDAY = 7

Neu in Version 2.0.1 (Plugin).

event BrickletRealTimeClock@AlarmCallback[sender, year, month, day, hour, minute, second, centisecond, weekday, timestamp]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletRealTimeClock]
  • year – Typ: Integer, Wertebereich: [2000 bis 2099]
  • month – Typ: Integer, Wertebereich: [1 bis 12]
  • day – Typ: Integer, Wertebereich: [1 bis 31]
  • hour – Typ: Integer, Wertebereich: [0 bis 23]
  • minute – Typ: Integer, Wertebereich: [0 bis 59]
  • second – Typ: Integer, Wertebereich: [0 bis 59]
  • centisecond – Typ: Integer, Wertebereich: [0 bis 99]
  • weekday – Typ: Integer, Wertebereich: Siehe Konstanten
  • timestamp – Typ: Integer, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

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:

Für weekday:

  • BrickletRealTimeClock`WEEKDAYUMONDAY = 1
  • BrickletRealTimeClock`WEEKDAYUTUESDAY = 2
  • BrickletRealTimeClock`WEEKDAYUWEDNESDAY = 3
  • BrickletRealTimeClock`WEEKDAYUTHURSDAY = 4
  • BrickletRealTimeClock`WEEKDAYUFRIDAY = 5
  • BrickletRealTimeClock`WEEKDAYUSATURDAY = 6
  • BrickletRealTimeClock`WEEKDAYUSUNDAY = 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.

BrickletRealTimeClock@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Ausgabeparameter:
  • apiVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, 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.

BrickletRealTimeClock@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId – Typ: Integer, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: True/False

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.

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

Für functionId:

  • BrickletRealTimeClock`FUNCTIONUSETUDATEUTIME = 1
  • BrickletRealTimeClock`FUNCTIONUSETUOFFSET = 4
  • BrickletRealTimeClock`FUNCTIONUSETUDATEUTIMEUCALLBACKUPERIOD = 6
  • BrickletRealTimeClock`FUNCTIONUSETUALARM = 8
BrickletRealTimeClock@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId – Typ: Integer, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: True/False

Ä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 functionId:

  • BrickletRealTimeClock`FUNCTIONUSETUDATEUTIME = 1
  • BrickletRealTimeClock`FUNCTIONUSETUOFFSET = 4
  • BrickletRealTimeClock`FUNCTIONUSETUDATEUTIMEUCALLBACKUPERIOD = 6
  • BrickletRealTimeClock`FUNCTIONUSETUALARM = 8
BrickletRealTimeClock@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected – Typ: True/False

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

Konstanten

BrickletRealTimeClock`DEVICEUIDENTIFIER

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.

BrickletRealTimeClock`DEVICEDISPLAYNAME

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