public interface WakeUp extends Function
WakeUpfunction provides device awake monitoring. It's especially applicable to battery-operated devices. Such device can notify the system that it's awake and can receive commands with a
The device can periodically wake up for commands. The interval can be managed
|Modifier and Type||Field and Description|
Specifies the awake property name.
Specifies the wake up interval.
|Modifier and Type||Method and Description|
Returns the current wake up interval.
Sets wake up interval according to the specified unit.
static final String PROPERTY_AWAKE
PropertyMetadata.ACCESS_EVENTABLE. If the device is awake, it will trigger a property event.
The property value type is
BooleanData. The boolean data is
true. It marks that the device is awake.
static final String PROPERTY_WAKE_UP_INTERVAL
getWakeUpInterval()and can be modified with
LevelData getWakeUpInterval() throws DeviceException
PROPERTY_WAKE_UP_INTERVALproperty. The device can periodically wake up and receive command based on this interval.
The interval can be measured in different units like hours, minutes,
seconds, etc. The unit is specified in
void setWakeUpInterval(BigDecimal interval, String unit) throws DeviceException
PROPERTY_WAKE_UP_INTERVALproperty. The device can periodically wake up and receive command based on this interval. The unit can be
null, then the interval is measured in milliseconds.
interval- The new wake up interval.
unit- The interval unit. If the unit is
null, the interval is measured in milliseconds.
IllegalStateException- If this function service object has already been unregistered.
DeviceException- If an operation error is available.
IllegalArgumentException- If there is an invalid argument.
Copyright © OSGi Alliance (2000, 2015). All Rights Reserved. Licensed under the OSGi Specification License, Version 2.0