Package com.tinkerforge
Class BrickletRealTimeClockV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletRealTimeClockV2
-
public class BrickletRealTimeClockV2 extends Device
Battery-backed real-time clock
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletRealTimeClockV2.Alarm
static interface
BrickletRealTimeClockV2.AlarmListener
This listener is triggered every time the current date and time matches the configured alarm (seesetAlarm(int, int, int, int, int, int, int)
).class
BrickletRealTimeClockV2.DateTime
static interface
BrickletRealTimeClockV2.DateTimeListener
This listener is triggered periodically with the period that is set bysetDateTimeCallbackConfiguration(long)
.class
BrickletRealTimeClockV2.SPITFPErrorCount
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletRealTimeClockV2(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(BrickletRealTimeClockV2.AlarmListener listener)
Adds a Alarm listener.void
addDateTimeListener(BrickletRealTimeClockV2.DateTimeListener listener)
Adds a DateTime listener.BrickletRealTimeClockV2.Alarm
getAlarm()
Returns the alarm configuration as set bysetAlarm(int, int, int, int, int, int, int)
.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.BrickletRealTimeClockV2.DateTime
getDateTime()
Returns the current date (including weekday) and the current time of the real-time.long
getDateTimeCallbackConfiguration()
Returns the period as set bysetDateTimeCallbackConfiguration(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.int
getOffset()
Returns the offset as set bysetOffset(int)
.BrickletRealTimeClockV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
long
getTimestamp()
Returns the current date and the time of the real-time clock converted to milliseconds.long
readUID()
Returns the current UID as an integer.void
removeAlarmListener(BrickletRealTimeClockV2.AlarmListener listener)
Removes a Alarm listener.void
removeDateTimeListener(BrickletRealTimeClockV2.DateTimeListener listener)
Removes a DateTime listener.void
reset()
Calling this function will reset the Bricklet.void
setAlarm(int month, int day, int hour, int minute, int second, int weekday, int interval)
Configures a repeatable alarm.int
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested mode change was instigated.void
setDateTime(int year, int month, int day, int hour, int minute, int second, int centisecond, int weekday)
Sets the current date (including weekday) and the current time.void
setDateTimeCallbackConfiguration(long period)
Sets the period with which theBrickletRealTimeClockV2.DateTimeListener
listener is triggered periodically.void
setOffset(int 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).void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
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_CONFIGURATION
public static final byte FUNCTION_SET_DATE_TIME_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_DATE_TIME_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_DATE_TIME_CALLBACK_CONFIGURATION
- 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_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- 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 int WEEKDAY_MONDAY
- See Also:
- Constant Field Values
-
WEEKDAY_TUESDAY
public static final int WEEKDAY_TUESDAY
- See Also:
- Constant Field Values
-
WEEKDAY_WEDNESDAY
public static final int WEEKDAY_WEDNESDAY
- See Also:
- Constant Field Values
-
WEEKDAY_THURSDAY
public static final int WEEKDAY_THURSDAY
- See Also:
- Constant Field Values
-
WEEKDAY_FRIDAY
public static final int WEEKDAY_FRIDAY
- See Also:
- Constant Field Values
-
WEEKDAY_SATURDAY
public static final int WEEKDAY_SATURDAY
- See Also:
- Constant Field Values
-
WEEKDAY_SUNDAY
public static final int WEEKDAY_SUNDAY
- See Also:
- Constant Field Values
-
ALARM_MATCH_DISABLED
public static final int ALARM_MATCH_DISABLED
- See Also:
- Constant Field Values
-
ALARM_INTERVAL_DISABLED
public static final int ALARM_INTERVAL_DISABLED
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletRealTimeClockV2
public BrickletRealTimeClockV2(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, int month, int day, int hour, int minute, int second, int centisecond, int 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 BrickletRealTimeClockV2.DateTime getDateTime() throws TinkerforgeException
Returns the current date (including weekday) and the current time of the real-time. The timestamp represents the current date and the the current time of the real-time clock converted to milliseconds and is an offset to 2000-01-01 00:00:00.0000.- Throws:
TinkerforgeException
-
getTimestamp
public long getTimestamp() throws TinkerforgeException
Returns the current date and the time of the real-time clock converted to milliseconds. The timestamp has an effective resolution of hundredths of a second and is an offset to 2000-01-01 00:00:00.0000.- Throws:
TinkerforgeException
-
setOffset
public void setOffset(int 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 int getOffset() throws TinkerforgeException
Returns the offset as set bysetOffset(int)
.- Throws:
TinkerforgeException
-
setDateTimeCallbackConfiguration
public void setDateTimeCallbackConfiguration(long period) throws TinkerforgeException
Sets the period with which theBrickletRealTimeClockV2.DateTimeListener
listener is triggered periodically. A value of 0 turns the listener off.- Throws:
TinkerforgeException
-
getDateTimeCallbackConfiguration
public long getDateTimeCallbackConfiguration() throws TinkerforgeException
Returns the period as set bysetDateTimeCallbackConfiguration(long)
.- Throws:
TinkerforgeException
-
setAlarm
public void setAlarm(int month, int day, int hour, int minute, int second, int weekday, int interval) throws TinkerforgeException
Configures a repeatable alarm. TheBrickletRealTimeClockV2.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.- Throws:
TinkerforgeException
-
getAlarm
public BrickletRealTimeClockV2.Alarm getAlarm() throws TinkerforgeException
Returns the alarm configuration as set bysetAlarm(int, int, int, int, int, int, int)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletRealTimeClockV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
Returns the error count for the communication between Brick and Bricklet. The errors are divided into * ACK checksum errors, * message checksum errors, * framing errors and * overflow errors. The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
Sets the bootloader mode and returns the status after the requested mode change was instigated. You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(int[])
. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256). This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before. The firmware is written to flash every 4 chunks. You can only write firmware in bootloader mode. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature! The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
Calling this function will reset the Bricklet. All configurations will be lost. After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first. We recommend that you use Brick Viewer to change the UID.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- 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(BrickletRealTimeClockV2.DateTimeListener listener)
Adds a DateTime listener.
-
removeDateTimeListener
public void removeDateTimeListener(BrickletRealTimeClockV2.DateTimeListener listener)
Removes a DateTime listener.
-
addAlarmListener
public void addAlarmListener(BrickletRealTimeClockV2.AlarmListener listener)
Adds a Alarm listener.
-
removeAlarmListener
public void removeAlarmListener(BrickletRealTimeClockV2.AlarmListener listener)
Removes a Alarm listener.
-
-