freesmartphone.org RealtimeClock Interface

Description

This interface provides access to a Realtime Clock device.

Namespace

org.freesmartphone.Device.RealtimeClock

Methods

Signals

Properties

None

Errors

None

Methods

GetCurrentTime ( ) → i

Description: Retrieve the current time from the RTC.

Returns:

i: time The current time in seconds since epoch.

SetCurrentTime ( i )

Description: Set the current time in the RTC.

Parameters:*

i: time The current time in seconds since epoch.

GetWakeupTime ( ) → i

Description: Retrieve the currently programmed wakeup time from the RTC.

Returns:

i: time The wakeup time in seconds since epoch, if programmed. 0, otherwise.

SetWakeupTime ( i )

Description: Program a wakeup time in the RTC.

Parameters:*

i: time The wakeuptime in seconds since epoch. Set to 0, if you want to disable wakeup.

Signals

WakeupTimeChanged ( i )

Description: Sent, when the programmed RTC wakeup time has been changed.

Parameters:

i: time The wakeup time in seconds since epoch, if programmed. 0, otherwise.

Alarm ( i )

Description: Sent, when the programmed RTC wakeup time has been reached.

Parameters:

i: time The wakeup time in seconds since epoch.