Ruby - Real-Time Clock Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_real_time_clock'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Real-Time Clock Bricklet

ipcon = IPConnection.new # Create IP connection
rtc = BrickletRealTimeClock.new 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 as [year, month, day, hour, minute, second, centisecond,
#                               weekday]
date_time = rtc.get_date_time

puts "Year: #{date_time[0]}"
puts "Month: #{date_time[1]}"
puts "Day: #{date_time[2]}"
puts "Hour: #{date_time[3]}"
puts "Minute: #{date_time[4]}"
puts "Second: #{date_time[5]}"
puts "Centisecond: #{date_time[6]}"

if date_time[7] == BrickletRealTimeClock::WEEKDAY_MONDAY
  puts "Weekday: Monday"
elsif date_time[7] == BrickletRealTimeClock::WEEKDAY_TUESDAY
  puts "Weekday: Tuesday"
elsif date_time[7] == BrickletRealTimeClock::WEEKDAY_WEDNESDAY
  puts "Weekday: Wednesday"
elsif date_time[7] == BrickletRealTimeClock::WEEKDAY_THURSDAY
  puts "Weekday: Thursday"
elsif date_time[7] == BrickletRealTimeClock::WEEKDAY_FRIDAY
  puts "Weekday: Friday"
elsif date_time[7] == BrickletRealTimeClock::WEEKDAY_SATURDAY
  puts "Weekday: Saturday"
elsif date_time[7] == BrickletRealTimeClock::WEEKDAY_SUNDAY
  puts "Weekday: Sunday"
end

# Get current timestamp
timestamp = rtc.get_timestamp
puts "Timestamp: #{timestamp} ms"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback

Download (example_callback.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_real_time_clock'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Real-Time Clock Bricklet

ipcon = IPConnection.new # Create IP connection
rtc = BrickletRealTimeClock.new 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
rtc.register_callback(BrickletRealTimeClock::CALLBACK_DATE_TIME) do |year, month, day,
                                                                     hour, minute, second,
                                                                     centisecond, weekday,
                                                                     timestamp|
  puts "Year: #{year}"
  puts "Month: #{month}"
  puts "Day: #{day}"
  puts "Hour: #{hour}"
  puts "Minute: #{minute}"
  puts "Second: #{second}"
  puts "Centisecond: #{centisecond}"

  if weekday == BrickletRealTimeClock::WEEKDAY_MONDAY
    puts "Weekday: Monday"
  elsif weekday == BrickletRealTimeClock::WEEKDAY_TUESDAY
    puts "Weekday: Tuesday"
  elsif weekday == BrickletRealTimeClock::WEEKDAY_WEDNESDAY
    puts "Weekday: Wednesday"
  elsif weekday == BrickletRealTimeClock::WEEKDAY_THURSDAY
    puts "Weekday: Thursday"
  elsif weekday == BrickletRealTimeClock::WEEKDAY_FRIDAY
    puts "Weekday: Friday"
  elsif weekday == BrickletRealTimeClock::WEEKDAY_SATURDAY
    puts "Weekday: Saturday"
  elsif weekday == BrickletRealTimeClock::WEEKDAY_SUNDAY
    puts "Weekday: Sunday"
  end

  puts "Timestamp: #{timestamp}"
  puts ''
end

# 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.set_date_time_callback_period 5000

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletRealTimeClock::new(uid, ipcon) → real_time_clock
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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

real_time_clock = BrickletRealTimeClock.new 'YOUR_DEVICE_UID', ipcon

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

BrickletRealTimeClock#set_date_time(year, month, day, hour, minute, second, centisecond, weekday) → nil
Parameter:
  • year -- int
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • centisecond -- int
  • weekday -- int

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
BrickletRealTimeClock#get_date_time → [int, int, int, int, int, int, int, int]

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

Das zurückgegebene Array enthält die Werte year, month, day, hour, minute, second, centisecond und weekday.

BrickletRealTimeClock#get_timestamp → int

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

Fortgeschrittene Funktionen

BrickletRealTimeClock#set_offset(offset) → nil
Parameter:offset -- int

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#get_offset → int

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

BrickletRealTimeClock#get_api_version → [int, int, int]

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.

BrickletRealTimeClock#get_response_expected(function_id) → bool
Parameter:function_id -- int

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 #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:

  • BrickletRealTimeClock::FUNCTION_SET_DATE_TIME = 1
  • BrickletRealTimeClock::FUNCTION_SET_OFFSET = 4
  • BrickletRealTimeClock::FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • BrickletRealTimeClock::FUNCTION_SET_ALARM = 8
BrickletRealTimeClock#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id -- int
  • response_expected -- 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:

  • BrickletRealTimeClock::FUNCTION_SET_DATE_TIME = 1
  • BrickletRealTimeClock::FUNCTION_SET_OFFSET = 4
  • BrickletRealTimeClock::FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • BrickletRealTimeClock::FUNCTION_SET_ALARM = 8
BrickletRealTimeClock#set_response_expected_all(response_expected) → nil
Parameter:response_expected -- bool

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

BrickletRealTimeClock#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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.

Das zurückgegebene Array enthält die Werte uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickletRealTimeClock#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:callback_id -- int

Registriert den block für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletRealTimeClock#set_date_time_callback_period(period) → nil
Parameter:period -- int

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

Der ::CALLBACK_DATE_TIME 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).

BrickletRealTimeClock#get_date_time_callback_period → int

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

Neu in Version 2.0.1 (Plugin).

BrickletRealTimeClock#set_alarm(month, day, hour, minute, second, weekday, interval) → nil
Parameter:
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • weekday -- int
  • interval -- int

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

BrickletRealTimeClock#get_alarm → [int, int, int, int, int, int, int]

Gibt die Alarmkonfiguration zurück, wie von #set_alarm 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).

Das zurückgegebene Array enthält die Werte month, day, hour, minute, second, weekday und interval.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion #register_callback des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite Parameter der Block:

real_time_clock.register_callback BrickletRealTimeClock::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletRealTimeClock::CALLBACK_DATE_TIME
Parameter:
  • year -- int
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • centisecond -- int
  • weekday -- int
  • timestamp -- int

Dieser Callback wird mit der Periode, wie gesetzt mit #set_date_time_callback_period, ausgelöst. Die Parameter sind die gleichen wie die von #get_date_time und #get_timestamp kombiniert.

Der ::CALLBACK_DATE_TIME 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).

BrickletRealTimeClock::CALLBACK_ALARM
Parameter:
  • year -- int
  • month -- int
  • day -- int
  • hour -- int
  • minute -- int
  • second -- int
  • centisecond -- int
  • weekday -- int
  • timestamp -- int

Dieser Callback wird jedes mal ausgelöst, wenn das aktuelle Datum und die aktuelle Uhrzeit mit dem eingestellten Alarm übereinstimmen (siehe #set_alarm). Die Parameter sind die gleichen wie die von #get_date_time und #get_timestamp 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

BrickletRealTimeClock::DEVICE_IDENTIFIER

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

Die #get_identity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletRealTimeClock::DEVICE_DISPLAY_NAME

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