Ruby - Real-Time Clock Bricklet 2.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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_real_time_clock_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
rtc = BrickletRealTimeClockV2.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, timestamp]
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] == BrickletRealTimeClockV2::WEEKDAY_MONDAY
  puts "Weekday: Monday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_TUESDAY
  puts "Weekday: Tuesday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_WEDNESDAY
  puts "Weekday: Wednesday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_THURSDAY
  puts "Weekday: Thursday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_FRIDAY
  puts "Weekday: Friday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_SATURDAY
  puts "Weekday: Saturday"
elsif date_time[7] == BrickletRealTimeClockV2::WEEKDAY_SUNDAY
  puts "Weekday: Sunday"
end

puts "Timestamp: #{date_time[8]} 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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_real_time_clock_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
rtc = BrickletRealTimeClockV2.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(BrickletRealTimeClockV2::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 == BrickletRealTimeClockV2::WEEKDAY_MONDAY
    puts "Weekday: Monday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_TUESDAY
    puts "Weekday: Tuesday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_WEDNESDAY
    puts "Weekday: Wednesday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_THURSDAY
    puts "Weekday: Thursday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_FRIDAY
    puts "Weekday: Friday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_SATURDAY
    puts "Weekday: Saturday"
  elsif weekday == BrickletRealTimeClockV2::WEEKDAY_SUNDAY
    puts "Weekday: Sunday"
  end

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

# Set period for date and time callback to 5s (5000ms)
rtc.set_date_time_callback_configuration 5000

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

Grundfunktionen¶

BrickletRealTimeClockV2::new(uid, ipcon) → real_time_clock_v2¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	real_time_clock_v2 – Typ: BrickletRealTimeClockV2

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

real_time_clock_v2 = BrickletRealTimeClockV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletRealTimeClockV2#set_date_time(year, month, day, hour, minute, second, centisecond, weekday) → nil¶

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

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

BrickletRealTimeClockV2#get_date_time → [int, int, int, int, int, int, int, int, int]¶

Rückgabe-Array:

0: year – Typ: int, Wertebereich: [2000 bis 2099] 1: month – Typ: int, Wertebereich: [1 bis 12] 2: day – Typ: int, Wertebereich: [1 bis 31] 3: hour – Typ: int, Wertebereich: [0 bis 23] 4: minute – Typ: int, Wertebereich: [0 bis 59] 5: second – Typ: int, Wertebereich: [0 bis 59] 6: centisecond – Typ: int, Wertebereich: [0 bis 99] 7: weekday – Typ: int, Wertebereich: Siehe Konstanten 8: timestamp – Typ: int, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

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

Der Zeitstempel stellt das aktuelle Datum und die aktuelle Zeit der Echtzeituhr in Millisekunden umgerechnet dar und ist der Versatz zum 01.01.2000 00:00:00,0000.

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

Für weekday:

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

BrickletRealTimeClockV2#get_timestamp → int¶

Rückgabe:	timestamp – Typ: int, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

Gibt das aktuelle Datum und Zeit der Echtzeituhr in Millisekunden umgerechnet zurück. Der Zeitstempel hat eine effektive Auflösung von Hundertstelsekunden und ist der Versatz zum 01.01.2000 00:00:00,0000.

Fortgeschrittene Funktionen¶

BrickletRealTimeClockV2#set_offset(offset) → nil¶

Parameter:	offset – Typ: int, 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.

BrickletRealTimeClockV2#get_offset → int¶

Rückgabe:	offset – Typ: int, Einheit: 217/100 ppm, Wertebereich: [-128 bis 127]

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

BrickletRealTimeClockV2#get_spitfp_error_count → [int, int, int, int]¶

Rückgabe-Array:	0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1] 3: error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

• ACK-Checksummen Fehler,
• Message-Checksummen Fehler,
• Framing Fehler und
• Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletRealTimeClockV2#set_status_led_config(config) → nil¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

• BrickletRealTimeClockV2::STATUS_LED_CONFIG_OFF = 0
• BrickletRealTimeClockV2::STATUS_LED_CONFIG_ON = 1
• BrickletRealTimeClockV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletRealTimeClockV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletRealTimeClockV2#get_status_led_config → int¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von #set_status_led_config gesetzt.

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

Für config:

• BrickletRealTimeClockV2::STATUS_LED_CONFIG_OFF = 0
• BrickletRealTimeClockV2::STATUS_LED_CONFIG_ON = 1
• BrickletRealTimeClockV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletRealTimeClockV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletRealTimeClockV2#get_chip_temperature → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletRealTimeClockV2#reset → nil¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletRealTimeClockV2#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Rückgabe-Array:

0: uid – Typ: str, Länge: bis zu 8 1: connected_uid – Typ: str, Länge: bis zu 8 2: position – Typ: chr, Wertebereich: ['a' bis 'h', 'z'] 3: hardware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] 4: firmware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] 5: device_identifier – Typ: int, 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¶

BrickletRealTimeClockV2#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameter:	callback_id – Typ: int

Registriert den block für die gegebene callback_id.

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

BrickletRealTimeClockV2#set_date_time_callback_configuration(period) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletRealTimeClockV2#get_date_time_callback_configuration → int¶

Rückgabe:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletRealTimeClockV2#set_alarm(month, day, hour, minute, second, weekday, interval) → nil¶

Parameter:

month – Typ: int, Wertebereich: [-1, 1 bis 12] mit Konstanten day – Typ: int, Wertebereich: [-1, 1 bis 31] mit Konstanten hour – Typ: int, Wertebereich: [-1, 0 bis 23] mit Konstanten minute – Typ: int, Wertebereich: [-1, 0 bis 59] mit Konstanten second – Typ: int, Wertebereich: [-1, 0 bis 59] mit Konstanten weekday – Typ: int, Wertebereich: [-1, 1 bis 7] mit Konstanten interval – Typ: int, Einheit: 1 s, Wertebereich: [-1, 1 bis 231 - 1] mit Konstanten

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:

Für month:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für day:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für hour:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für minute:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für second:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für weekday:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für interval:

• BrickletRealTimeClockV2::ALARM_INTERVAL_DISABLED = -1

BrickletRealTimeClockV2#get_alarm → [int, int, int, int, int, int, int]¶

Rückgabe-Array:

0: month – Typ: int, Wertebereich: [-1, 1 bis 12] mit Konstanten 1: day – Typ: int, Wertebereich: [-1, 1 bis 31] mit Konstanten 2: hour – Typ: int, Wertebereich: [-1, 0 bis 23] mit Konstanten 3: minute – Typ: int, Wertebereich: [-1, 0 bis 59] mit Konstanten 4: second – Typ: int, Wertebereich: [-1, 0 bis 59] mit Konstanten 5: weekday – Typ: int, Wertebereich: [-1, 1 bis 7] mit Konstanten 6: interval – Typ: int, Einheit: 1 s, Wertebereich: [-1, 1 bis 231 - 1] mit Konstanten

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

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

Für month:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für day:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für hour:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für minute:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für second:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für weekday:

• BrickletRealTimeClockV2::ALARM_MATCH_DISABLED = -1

Für interval:

• BrickletRealTimeClockV2::ALARM_INTERVAL_DISABLED = -1

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_v2.register_callback BrickletRealTimeClockV2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

BrickletRealTimeClockV2::CALLBACK_DATE_TIME¶

Callback-Parameter:

year – Typ: int, Wertebereich: [2000 bis 2099] month – Typ: int, Wertebereich: [1 bis 12] day – Typ: int, Wertebereich: [1 bis 31] hour – Typ: int, Wertebereich: [0 bis 23] minute – Typ: int, Wertebereich: [0 bis 59] second – Typ: int, Wertebereich: [0 bis 59] centisecond – Typ: int, Wertebereich: [0 bis 99] weekday – Typ: int, Wertebereich: Siehe Konstanten timestamp – Typ: int, Einheit: 1 ms, Wertebereich: [-263 bis 263 - 1]

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

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

Für weekday:

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

BrickletRealTimeClockV2::CALLBACK_ALARM¶

Callback-Parameter:

year – Typ: int, Wertebereich: [2000 bis 2099] month – Typ: int, Wertebereich: [1 bis 12] day – Typ: int, Wertebereich: [1 bis 31] hour – Typ: int, Wertebereich: [0 bis 23] minute – Typ: int, Wertebereich: [0 bis 59] second – Typ: int, Wertebereich: [0 bis 59] centisecond – Typ: int, Wertebereich: [0 bis 99] weekday – Typ: int, Wertebereich: Siehe Konstanten timestamp – Typ: int, 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 #set_alarm). Die Parameter sind die gleichen wie die von #get_date_time.

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

Für weekday:

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

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.

BrickletRealTimeClockV2#get_api_version → [int, ...]¶

Rückgabe-Array:	0: api_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, 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.

BrickletRealTimeClockV2#get_response_expected(function_id) → bool¶

Parameter:	function_id – Typ: int, 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 #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:

• BrickletRealTimeClockV2::FUNCTION_SET_DATE_TIME = 1
• BrickletRealTimeClockV2::FUNCTION_SET_OFFSET = 4
• BrickletRealTimeClockV2::FUNCTION_SET_DATE_TIME_CALLBACK_CONFIGURATION = 6
• BrickletRealTimeClockV2::FUNCTION_SET_ALARM = 8
• BrickletRealTimeClockV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletRealTimeClockV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletRealTimeClockV2::FUNCTION_RESET = 243
• BrickletRealTimeClockV2::FUNCTION_WRITE_UID = 248

BrickletRealTimeClockV2#set_response_expected(function_id, response_expected) → nil¶

Parameter:	function_id – Typ: int, 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:

• BrickletRealTimeClockV2::FUNCTION_SET_DATE_TIME = 1
• BrickletRealTimeClockV2::FUNCTION_SET_OFFSET = 4
• BrickletRealTimeClockV2::FUNCTION_SET_DATE_TIME_CALLBACK_CONFIGURATION = 6
• BrickletRealTimeClockV2::FUNCTION_SET_ALARM = 8
• BrickletRealTimeClockV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletRealTimeClockV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletRealTimeClockV2::FUNCTION_RESET = 243
• BrickletRealTimeClockV2::FUNCTION_WRITE_UID = 248

BrickletRealTimeClockV2#set_response_expected_all(response_expected) → nil¶

Parameter:	response_expected – Typ: bool

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletRealTimeClockV2#set_bootloader_mode(mode) → int¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

• BrickletRealTimeClockV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletRealTimeClockV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletRealTimeClockV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletRealTimeClockV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletRealTimeClockV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletRealTimeClockV2::BOOTLOADER_STATUS_OK = 0
• BrickletRealTimeClockV2::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletRealTimeClockV2::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletRealTimeClockV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletRealTimeClockV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletRealTimeClockV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletRealTimeClockV2#get_bootloader_mode → int¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

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

Für mode:

• BrickletRealTimeClockV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletRealTimeClockV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletRealTimeClockV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletRealTimeClockV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletRealTimeClockV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletRealTimeClockV2#set_write_firmware_pointer(pointer) → nil¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für #write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletRealTimeClockV2#write_firmware(data) → int¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von #set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletRealTimeClockV2#write_uid(uid) → nil¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletRealTimeClockV2#read_uid → int¶

Rückgabe:	uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

BrickletRealTimeClockV2::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Real-Time Clock Bricklet 2.0 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.

BrickletRealTimeClockV2::DEVICE_DISPLAY_NAME¶

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