YRealTimeClock (Yoctopuce Java API 2.1.11632-SNAPSHOT API)

java.lang.Object
- com.yoctopuce.YoctoAPI.YFunction
- - com.yoctopuce.YoctoAPI.YRealTimeClock

```
public class YRealTimeClock
extends YFunction
```
YRealTimeClock Class: real-time clock control interface, available for instance in the YoctoHub-GSM-4G, the YoctoHub-Wireless-SR, the YoctoHub-Wireless-g or the YoctoHub-Wireless-n The YRealTimeClock class provide access to the embedded real-time clock available on some Yoctopuce devices. It can provide current date and time, even after a power outage lasting several days. It is the base for automated wake-up functions provided by the WakeUpScheduler. The current time may represent a local time as well as an UTC time, but no automatic time change will occur to account for daylight saving time.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YRealTimeClock.TimedReportCallback` TimedReportCallback for RealTimeClock
`static interface`	`YRealTimeClock.UpdateCallback` Deprecated UpdateCallback for RealTimeClock

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_dateTime`
`protected int`	`_disableHostSync`
`protected int`	`_timeSet`
`protected long`	`_unixTime`
`protected int`	`_utcOffset`
`protected YRealTimeClock.UpdateCallback`	`_valueCallbackRealTimeClock`
`static String`	`DATETIME_INVALID` invalid dateTime value
`static int`	`DISABLEHOSTSYNC_FALSE` invalid disableHostSync value
`static int`	`DISABLEHOSTSYNC_INVALID`
`static int`	`DISABLEHOSTSYNC_TRUE`
`static int`	`TIMESET_FALSE` invalid timeSet value
`static int`	`TIMESET_INVALID`
`static int`	`TIMESET_TRUE`
`static long`	`UNIXTIME_INVALID` invalid unixTime value
`static int`	`UTCOFFSET_INVALID` invalid utcOffset value

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID

Constructor Summary

Constructors
Modifier Constructor and Description

protected YRealTimeClock(String func)

protected YRealTimeClock(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YRealTimeClock(String func)`
`protected`	`YRealTimeClock(YAPIContext ctx, String func)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`_invokeValueCallback(String value)`
`protected void`	`_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)`
`static YRealTimeClock`	`FindRealTimeClock(String func)` Retrieves a real-time clock for a given identifier.
`static YRealTimeClock`	`FindRealTimeClockInContext(YAPIContext yctx, String func)` Retrieves a real-time clock for a given identifier in a YAPI context.
`static YRealTimeClock`	`FirstRealTimeClock()` Starts the enumeration of real-time clocks currently accessible.
`static YRealTimeClock`	`FirstRealTimeClockInContext(YAPIContext yctx)` Starts the enumeration of real-time clocks currently accessible.
`String`	`get_dateTime()` Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
`int`	`get_disableHostSync()` Returns true if the automatic clock synchronization with host has been disabled, and false otherwise.
`int`	`get_timeSet()` Returns true if the clock has been set, and false otherwise.
`long`	`get_unixTime()` Returns the current time in Unix format (number of elapsed seconds since Jan 1st, 1970).
`int`	`get_utcOffset()` Returns the number of seconds between current time and UTC time (time zone).
`String`	`getDateTime()` Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
`int`	`getDisableHostSync()` Returns true if the automatic clock synchronization with host has been disabled, and false otherwise.
`int`	`getTimeSet()` Returns true if the clock has been set, and false otherwise.
`long`	`getUnixTime()` Returns the current time in Unix format (number of elapsed seconds since Jan 1st, 1970).
`int`	`getUtcOffset()` Returns the number of seconds between current time and UTC time (time zone).
`YRealTimeClock`	`nextRealTimeClock()` Continues the enumeration of real-time clocks started using yFirstRealTimeClock().
`int`	`registerValueCallback(YRealTimeClock.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`set_disableHostSync(int newval)` Changes the automatic clock synchronization with host working state.
`int`	`set_unixTime(long newval)` Changes the current time.
`int`	`set_utcOffset(int newval)` Changes the number of seconds between current time and UTC time (time zone).
`int`	`setDisableHostSync(int newval)` Changes the automatic clock synchronization with host working state.
`int`	`setUnixTime(long newval)` Changes the current time.
`int`	`setUtcOffset(int newval)` Changes the number of seconds between current time and UTC time (time zone).

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction
_AddToCache, _clearDataStreamCache, _decode_json_int, _decode_json_string, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _is_valid_pass, _json_get_array, _json_get_key, _json_get_string, _parse, _parserHelper, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_serialNumber, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNIXTIME_INVALID
```
public static final long UNIXTIME_INVALID
```
    invalid unixTime value
    
    See Also:
    
    Constant Field Values
  - DATETIME_INVALID
```
public static final String DATETIME_INVALID
```
    invalid dateTime value
    
    See Also:
    
    Constant Field Values
  - UTCOFFSET_INVALID
```
public static final int UTCOFFSET_INVALID
```
    invalid utcOffset value
    
    See Also:
    
    Constant Field Values
  - TIMESET_FALSE
```
public static final int TIMESET_FALSE
```
    invalid timeSet value
    
    See Also:
    
    Constant Field Values
  - TIMESET_TRUE
```
public static final int TIMESET_TRUE
```
    See Also:
    
    Constant Field Values
  - TIMESET_INVALID
```
public static final int TIMESET_INVALID
```
    See Also:
    
    Constant Field Values
  - DISABLEHOSTSYNC_FALSE
```
public static final int DISABLEHOSTSYNC_FALSE
```
    invalid disableHostSync value
    
    See Also:
    
    Constant Field Values
  - DISABLEHOSTSYNC_TRUE
```
public static final int DISABLEHOSTSYNC_TRUE
```
    See Also:
    
    Constant Field Values
  - DISABLEHOSTSYNC_INVALID
```
public static final int DISABLEHOSTSYNC_INVALID
```
    See Also:
    
    Constant Field Values
  - _unixTime
```
protected long _unixTime
```
  - _dateTime
```
protected String _dateTime
```
  - _utcOffset
```
protected int _utcOffset
```
  - _timeSet
```
protected int _timeSet
```
  - _disableHostSync
```
protected int _disableHostSync
```
  - _valueCallbackRealTimeClock
```
protected YRealTimeClock.UpdateCallback _valueCallbackRealTimeClock
```
- Constructor Detail
  - YRealTimeClock
```
protected YRealTimeClock(YAPIContext ctx,
                         String func)
```
    Parameters:
    
    func - : functionid
  - YRealTimeClock
```
protected YRealTimeClock(String func)
```
    Parameters:
    
    func - : functionid
- Method Detail
  - _parseAttr
```
protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception
```
    Overrides:
    
    _parseAttr in class YFunction
    
    Throws:
    
    Exception
  - get_unixTime
```
public long get_unixTime()
                  throws YAPI_Exception
```
    Returns the current time in Unix format (number of elapsed seconds since Jan 1st, 1970).
    
    Returns:
    
    an integer corresponding to the current time in Unix format (number of elapsed seconds since Jan 1st, 1970)
    
    Throws:
    
    YAPI_Exception - on error
  - getUnixTime
```
public long getUnixTime()
                 throws YAPI_Exception
```
    Returns the current time in Unix format (number of elapsed seconds since Jan 1st, 1970).
    
    Returns:
    
    an integer corresponding to the current time in Unix format (number of elapsed seconds since Jan 1st, 1970)
    
    Throws:
    
    YAPI_Exception - on error
  - set_unixTime
```
public int set_unixTime(long newval)
                 throws YAPI_Exception
```
    Changes the current time. Time is specifid in Unix format (number of elapsed seconds since Jan 1st, 1970).
    
    Parameters:
    
    newval - : an integer corresponding to the current time
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setUnixTime
```
public int setUnixTime(long newval)
                throws YAPI_Exception
```
    Changes the current time. Time is specifid in Unix format (number of elapsed seconds since Jan 1st, 1970).
    
    Parameters:
    
    newval - : an integer corresponding to the current time
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_dateTime
```
public String get_dateTime()
                    throws YAPI_Exception
```
    Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
    
    Returns:
    
    a string corresponding to the current time in the form "YYYY/MM/DD hh:mm:ss"
    
    Throws:
    
    YAPI_Exception - on error
  - getDateTime
```
public String getDateTime()
                   throws YAPI_Exception
```
    Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
    
    Returns:
    
    a string corresponding to the current time in the form "YYYY/MM/DD hh:mm:ss"
    
    Throws:
    
    YAPI_Exception - on error
  - get_utcOffset
```
public int get_utcOffset()
                  throws YAPI_Exception
```
    Returns the number of seconds between current time and UTC time (time zone).
    
    Returns:
    
    an integer corresponding to the number of seconds between current time and UTC time (time zone)
    
    Throws:
    
    YAPI_Exception - on error
  - getUtcOffset
```
public int getUtcOffset()
                 throws YAPI_Exception
```
    Returns the number of seconds between current time and UTC time (time zone).
    
    Returns:
    
    an integer corresponding to the number of seconds between current time and UTC time (time zone)
    
    Throws:
    
    YAPI_Exception - on error
  - set_utcOffset
```
public int set_utcOffset(int newval)
                  throws YAPI_Exception
```
    Changes the number of seconds between current time and UTC time (time zone). The timezone is automatically rounded to the nearest multiple of 15 minutes. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the number of seconds between current time and UTC time (time zone)
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setUtcOffset
```
public int setUtcOffset(int newval)
                 throws YAPI_Exception
```
    Changes the number of seconds between current time and UTC time (time zone). The timezone is automatically rounded to the nearest multiple of 15 minutes. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the number of seconds between current time and UTC time (time zone)
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_timeSet
```
public int get_timeSet()
                throws YAPI_Exception
```
    Returns true if the clock has been set, and false otherwise.
    
    Returns:
    
    either YRealTimeClock.TIMESET_FALSE or YRealTimeClock.TIMESET_TRUE, according to true if the clock has been set, and false otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - getTimeSet
```
public int getTimeSet()
               throws YAPI_Exception
```
    Returns true if the clock has been set, and false otherwise.
    
    Returns:
    
    either YRealTimeClock.TIMESET_FALSE or YRealTimeClock.TIMESET_TRUE, according to true if the clock has been set, and false otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - get_disableHostSync
```
public int get_disableHostSync()
                        throws YAPI_Exception
```
    Returns true if the automatic clock synchronization with host has been disabled, and false otherwise.
    
    Returns:
    
    either YRealTimeClock.DISABLEHOSTSYNC_FALSE or YRealTimeClock.DISABLEHOSTSYNC_TRUE, according to true if the automatic clock synchronization with host has been disabled, and false otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - getDisableHostSync
```
public int getDisableHostSync()
                       throws YAPI_Exception
```
    Returns true if the automatic clock synchronization with host has been disabled, and false otherwise.
    
    Returns:
    
    either YRealTimeClock.DISABLEHOSTSYNC_FALSE or YRealTimeClock.DISABLEHOSTSYNC_TRUE, according to true if the automatic clock synchronization with host has been disabled, and false otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - set_disableHostSync
```
public int set_disableHostSync(int newval)
                        throws YAPI_Exception
```
    Changes the automatic clock synchronization with host working state. To disable automatic synchronization, set the value to true. To enable automatic synchronization (default), set the value to false. If you want the change to be kept after a device reboot, make sure to call the matching module saveToFlash().
    
    Parameters:
    
    newval - : either YRealTimeClock.DISABLEHOSTSYNC_FALSE or YRealTimeClock.DISABLEHOSTSYNC_TRUE, according to the automatic clock synchronization with host working state
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setDisableHostSync
```
public int setDisableHostSync(int newval)
                       throws YAPI_Exception
```
    Changes the automatic clock synchronization with host working state. To disable automatic synchronization, set the value to true. To enable automatic synchronization (default), set the value to false. If you want the change to be kept after a device reboot, make sure to call the matching module saveToFlash().
    
    Parameters:
    
    newval - : either YRealTimeClock.DISABLEHOSTSYNC_FALSE or YRealTimeClock.DISABLEHOSTSYNC_TRUE, according to the automatic clock synchronization with host working state
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - FindRealTimeClock
```
public static YRealTimeClock FindRealTimeClock(String func)
```
    Retrieves a real-time clock for a given identifier. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the real-time clock is online at the time it is invoked. The returned object is nevertheless valid. Use the method YRealTimeClock.isOnline() to test if the real-time clock is indeed online at a given time. In case of ambiguity when looking for a real-time clock by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name. If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
    Parameters:
    
    func - : a string that uniquely characterizes the real-time clock, for instance YHUBGSM5.realTimeClock.
    
    Returns:
    
    a YRealTimeClock object allowing you to drive the real-time clock.
  - FindRealTimeClockInContext
```
public static YRealTimeClock FindRealTimeClockInContext(YAPIContext yctx,
                                                        String func)
```
    Retrieves a real-time clock for a given identifier in a YAPI context. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the real-time clock is online at the time it is invoked. The returned object is nevertheless valid. Use the method YRealTimeClock.isOnline() to test if the real-time clock is indeed online at a given time. In case of ambiguity when looking for a real-time clock by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
    Parameters:
    
    yctx - : a YAPI context
    
    func - : a string that uniquely characterizes the real-time clock, for instance YHUBGSM5.realTimeClock.
    
    Returns:
    
    a YRealTimeClock object allowing you to drive the real-time clock.
  - registerValueCallback
```
public int registerValueCallback(YRealTimeClock.UpdateCallback callback)
```
    Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a null pointer as argument.
    
    Parameters:
    
    callback - : the callback function to call, or a null pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.
  - _invokeValueCallback
```
public int _invokeValueCallback(String value)
```
    Overrides:
    
    _invokeValueCallback in class YFunction
  - nextRealTimeClock
```
public YRealTimeClock nextRealTimeClock()
```
    Continues the enumeration of real-time clocks started using yFirstRealTimeClock(). Caution: You can't make any assumption about the returned real-time clocks order. If you want to find a specific a real-time clock, use RealTimeClock.findRealTimeClock() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YRealTimeClock object, corresponding to a real-time clock currently online, or a null pointer if there are no more real-time clocks to enumerate.
  - FirstRealTimeClock
```
public static YRealTimeClock FirstRealTimeClock()
```
    Starts the enumeration of real-time clocks currently accessible. Use the method YRealTimeClock.nextRealTimeClock() to iterate on next real-time clocks.
    
    Returns:
    
    a pointer to a YRealTimeClock object, corresponding to the first real-time clock currently online, or a null pointer if there are none.
  - FirstRealTimeClockInContext
```
public static YRealTimeClock FirstRealTimeClockInContext(YAPIContext yctx)
```
    Starts the enumeration of real-time clocks currently accessible. Use the method YRealTimeClock.nextRealTimeClock() to iterate on next real-time clocks.
    
    Parameters:
    
    yctx - : a YAPI context.
    
    Returns:
    
    a pointer to a YRealTimeClock object, corresponding to the first real-time clock currently online, or a null pointer if there are none.

Class YRealTimeClock

Nested Class Summary

Field Summary

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction

Constructor Summary

Method Summary

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction

Methods inherited from class java.lang.Object

Field Detail

UNIXTIME_INVALID

DATETIME_INVALID

UTCOFFSET_INVALID

TIMESET_FALSE

TIMESET_TRUE

TIMESET_INVALID

DISABLEHOSTSYNC_FALSE

DISABLEHOSTSYNC_TRUE

DISABLEHOSTSYNC_INVALID

_unixTime

_dateTime

_utcOffset

_timeSet

_disableHostSync

_valueCallbackRealTimeClock

Constructor Detail

YRealTimeClock

YRealTimeClock

Method Detail

_parseAttr

get_unixTime

getUnixTime

set_unixTime

setUnixTime

get_dateTime

getDateTime

get_utcOffset

getUtcOffset

set_utcOffset

setUtcOffset

get_timeSet

getTimeSet

get_disableHostSync

getDisableHostSync

set_disableHostSync

setDisableHostSync

FindRealTimeClock

FindRealTimeClockInContext

registerValueCallback

_invokeValueCallback

nextRealTimeClock

FirstRealTimeClock

FirstRealTimeClockInContext