Package com.tinkerforge
Class BrickletRealTimeClock
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletRealTimeClock
-
public class BrickletRealTimeClock extends Device
Battery-backed real-time clock
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletRealTimeClock.Alarm
static interface
BrickletRealTimeClock.AlarmListener
This listener is triggered every time the current date and time matches the configured alarm (seesetAlarm(byte, byte, byte, byte, byte, byte, int)
).class
BrickletRealTimeClock.DateTime
static interface
BrickletRealTimeClock.DateTimeListener
This listener is triggered periodically with the period that is set bysetDateTimeCallbackPeriod(long)
.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
Fields Modifier and Type Field Description static int
ALARM_INTERVAL_DISABLED
static byte
ALARM_MATCH_DISABLED
static java.lang.String
DEVICE_DISPLAY_NAME
static int
DEVICE_IDENTIFIER
static byte
FUNCTION_GET_ALARM
static byte
FUNCTION_GET_DATE_TIME
static byte
FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD
static byte
FUNCTION_GET_IDENTITY
static byte
FUNCTION_GET_OFFSET
static byte
FUNCTION_GET_TIMESTAMP
static byte
FUNCTION_SET_ALARM
static byte
FUNCTION_SET_DATE_TIME
static byte
FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD
static byte
FUNCTION_SET_OFFSET
static short
WEEKDAY_FRIDAY
static short
WEEKDAY_MONDAY
static short
WEEKDAY_SATURDAY
static short
WEEKDAY_SUNDAY
static short
WEEKDAY_THURSDAY
static short
WEEKDAY_TUESDAY
static short
WEEKDAY_WEDNESDAY
-
Constructor Summary
Constructors Constructor Description BrickletRealTimeClock(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAlarmListener(BrickletRealTimeClock.AlarmListener listener)
Adds a Alarm listener.void
addDateTimeListener(BrickletRealTimeClock.DateTimeListener listener)
Adds a DateTime listener.BrickletRealTimeClock.Alarm
getAlarm()
Returns the alarm configuration as set bysetAlarm(byte, byte, byte, byte, byte, byte, int)
.BrickletRealTimeClock.DateTime
getDateTime()
Returns the current date (including weekday) and the current time of the real-time clock.long
getDateTimeCallbackPeriod()
Returns the period as set bysetDateTimeCallbackPeriod(long)
.Device.Identity
getIdentity()
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.byte
getOffset()
Returns the offset as set bysetOffset(byte)
.long
getTimestamp()
Returns the current date and the time of the real-time clock.void
removeAlarmListener(BrickletRealTimeClock.AlarmListener listener)
Removes a Alarm listener.void
removeDateTimeListener(BrickletRealTimeClock.DateTimeListener listener)
Removes a DateTime listener.void
setAlarm(byte month, byte day, byte hour, byte minute, byte second, byte weekday, int interval)
Configures a repeatable alarm.void
setDateTime(int year, short month, short day, short hour, short minute, short second, short centisecond, short weekday)
Sets the current date (including weekday) and the current time.void
setDateTimeCallbackPeriod(long period)
Sets the period with which theBrickletRealTimeClock.DateTimeListener
listener is triggered periodically.void
setOffset(byte offset)
Sets the offset the real-time clock should compensate for in 2.17 ppm steps between -277.76 ppm (-128) and +275.59 ppm (127).-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_SET_DATE_TIME
public static final byte FUNCTION_SET_DATE_TIME
- See Also:
- Constant Field Values
-
FUNCTION_GET_DATE_TIME
public static final byte FUNCTION_GET_DATE_TIME
- See Also:
- Constant Field Values
-
FUNCTION_GET_TIMESTAMP
public static final byte FUNCTION_GET_TIMESTAMP
- See Also:
- Constant Field Values
-
FUNCTION_SET_OFFSET
public static final byte FUNCTION_SET_OFFSET
- See Also:
- Constant Field Values
-
FUNCTION_GET_OFFSET
public static final byte FUNCTION_GET_OFFSET
- See Also:
- Constant Field Values
-
FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD
public static final byte FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD
public static final byte FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_ALARM
public static final byte FUNCTION_SET_ALARM
- See Also:
- Constant Field Values
-
FUNCTION_GET_ALARM
public static final byte FUNCTION_GET_ALARM
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
WEEKDAY_MONDAY
public static final short WEEKDAY_MONDAY
- See Also:
- Constant Field Values
-
WEEKDAY_TUESDAY
public static final short WEEKDAY_TUESDAY
- See Also:
- Constant Field Values
-
WEEKDAY_WEDNESDAY
public static final short WEEKDAY_WEDNESDAY
- See Also:
- Constant Field Values
-
WEEKDAY_THURSDAY
public static final short WEEKDAY_THURSDAY
- See Also:
- Constant Field Values
-
WEEKDAY_FRIDAY
public static final short WEEKDAY_FRIDAY
- See Also:
- Constant Field Values
-
WEEKDAY_SATURDAY
public static final short WEEKDAY_SATURDAY
- See Also:
- Constant Field Values
-
WEEKDAY_SUNDAY
public static final short WEEKDAY_SUNDAY
- See Also:
- Constant Field Values
-
ALARM_MATCH_DISABLED
public static final byte ALARM_MATCH_DISABLED
- See Also:
- Constant Field Values
-
ALARM_INTERVAL_DISABLED
public static final int ALARM_INTERVAL_DISABLED
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletRealTimeClock
public BrickletRealTimeClock(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
setDateTime
public void setDateTime(int year, short month, short day, short hour, short minute, short second, short centisecond, short weekday) throws TinkerforgeException
Sets the current date (including weekday) and the current time. If the backup battery is installed then the real-time clock keeps date and time even if the Bricklet is not powered by a Brick. The real-time clock handles leap year and inserts the 29th of February accordingly. But leap seconds, time zones and daylight saving time are not handled.- Throws:
TinkerforgeException
-
getDateTime
public BrickletRealTimeClock.DateTime getDateTime() throws TinkerforgeException
Returns the current date (including weekday) and the current time of the real-time clock.- Throws:
TinkerforgeException
-
getTimestamp
public long getTimestamp() throws TinkerforgeException
Returns the current date and the time of the real-time clock. The timestamp has an effective resolution of hundredths of a second and is an offset to 2000-01-01 00:00:00.000.- Throws:
TinkerforgeException
-
setOffset
public void setOffset(byte offset) throws TinkerforgeException
Sets the offset the real-time clock should compensate for in 2.17 ppm steps between -277.76 ppm (-128) and +275.59 ppm (127). The real-time clock time can deviate from the actual time due to the frequency deviation of its 32.768 kHz crystal. Even without compensation (factory default) the resulting time deviation should be at most ±20 ppm (±52.6 seconds per month). This deviation can be calculated by comparing the same duration measured by the real-time clock (``rtc_duration``) an accurate reference clock (``ref_duration``). For best results the configured offset should be set to 0 ppm first and then a duration of at least 6 hours should be measured. The new offset (``new_offset``) can be calculated from the currently configured offset (``current_offset``) and the measured durations as follow:: new_offset = current_offset - round(1000000 * (rtc_duration - ref_duration) / rtc_duration / 2.17) If you want to calculate the offset, then we recommend using the calibration dialog in Brick Viewer, instead of doing it manually. The offset is saved in the EEPROM of the Bricklet and only needs to be configured once.- Throws:
TinkerforgeException
-
getOffset
public byte getOffset() throws TinkerforgeException
Returns the offset as set bysetOffset(byte)
.- Throws:
TinkerforgeException
-
setDateTimeCallbackPeriod
public void setDateTimeCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletRealTimeClock.DateTimeListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletRealTimeClock.DateTimeListener
Listener is only triggered if the date or time changed since the last triggering. .. versionadded:: 2.0.1$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getDateTimeCallbackPeriod
public long getDateTimeCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetDateTimeCallbackPeriod(long)
. .. versionadded:: 2.0.1$nbsp;(Plugin)- Throws:
TinkerforgeException
-
setAlarm
public void setAlarm(byte month, byte day, byte hour, byte minute, byte second, byte weekday, int interval) throws TinkerforgeException
Configures a repeatable alarm. TheBrickletRealTimeClock.AlarmListener
listener is triggered if the current date and time matches the configured alarm. Setting a parameter to -1 means that it should be disabled and doesn't take part in the match. Setting all parameters to -1 disables the alarm completely. For example, to make the alarm trigger every day at 7:30 AM it can be configured as (-1, -1, 7, 30, -1, -1, -1). The hour is set to match 7 and the minute is set to match 30. The alarm is triggered if all enabled parameters match. The interval has a special role. It allows to make the alarm reconfigure itself. This is useful if you need a repeated alarm that cannot be expressed by matching the current date and time. For example, to make the alarm trigger every 23 seconds it can be configured as (-1, -1, -1, -1, -1, -1, 23). Internally the Bricklet will take the current date and time, add 23 seconds to it and set the result as its alarm. The first alarm will be triggered 23 seconds after the call. Because the interval is not -1, the Bricklet will do the same again internally, take the current date and time, add 23 seconds to it and set that as its alarm. This results in a repeated alarm that triggers every 23 seconds. The interval can also be used in combination with the other parameters. For example, configuring the alarm as (-1, -1, 7, 30, -1, -1, 300) results in an alarm that triggers every day at 7:30 AM and is then repeated every 5 minutes. .. versionadded:: 2.0.1$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getAlarm
public BrickletRealTimeClock.Alarm getAlarm() throws TinkerforgeException
Returns the alarm configuration as set bysetAlarm(byte, byte, byte, byte, byte, byte, int)
. .. versionadded:: 2.0.1$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier. The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addDateTimeListener
public void addDateTimeListener(BrickletRealTimeClock.DateTimeListener listener)
Adds a DateTime listener.
-
removeDateTimeListener
public void removeDateTimeListener(BrickletRealTimeClock.DateTimeListener listener)
Removes a DateTime listener.
-
addAlarmListener
public void addAlarmListener(BrickletRealTimeClock.AlarmListener listener)
Adds a Alarm listener.
-
removeAlarmListener
public void removeAlarmListener(BrickletRealTimeClock.AlarmListener listener)
Removes a Alarm listener.
-
-