Top Description Fields Methods
org.osgi.service.zigbee.descriptors

public Interface ZigBeePowerDescriptor

This interface represents a power descriptor as described in the ZigBee Specification.

The Power Descriptor gives a dynamic indication of the power status of the node.

Author
$Id: a41eaf6ad1d257d54d80b0140bd8540348f5419d $

Field Summary

Modifier and TypeField and Description
public static final short
CRITICAL_LEVEL

Current power source level: critical.

public static final short
FULL_LEVEL

Current power source level: 100%.

public static final short
LOW_LEVEL

Current power source level: 33%.

public static final short
MIDDLE_LEVEL

Current power source level: 66%.

Method Summary

Modifier and TypeMethod and Description
public short

Returns:

the current power mode.
getCurrentPowerMode()

Returns the current power mode.

public short

Returns:

the current power source field of the Power Descriptor.
getCurrentPowerSource()

Returns the current power source field of the Power Descriptor.

public short

Returns:

the current power source level. May be one of CRITICAL_LEVEL, LOW_LEVEL, MIDDLE_LEVEL, FULL_LEVEL.
getCurrentPowerSourceLevel()

Returns the current power source level.

public boolean

Returns:

true if constant (mains) power is available or false otherwise.
isConstantMainsPowerAvailable()

Checks if constant (mains) power is available.

public boolean

Returns:

true if the currently selected power source is the disposable battery.
isDisposableBattery()

Checks if the currently selected power source is the disposable battery.

public boolean

Returns:

true if a disposable battery is available or false otherwise.
isDisposableBatteryAvailable()

Checks if a disposable battery is available.

public boolean

Returns:

true if the currently selected power source is the mains power.
isMainsPower()

Checks if the currently selected power source is the mains power.

public boolean

Returns:

true if the Current Power Mode field tells that the receiver is on when the device is stimulated by pressing a button, for instance.
isOnWhenStimulated()

Checks if the receiver is on when the device is simulated.

public boolean

Returns:

true if the Current Power Mode field is periodically on.
isPeriodicallyOn()

Checks if the Current Power Mode field is periodically on.

public boolean

Returns:

true if the currently selected power source is the rechargeable battery.
isRechargableBattery()

Checks if the currently selected power source is the rechargeable battery.

public boolean

Returns:

true if a rechargeable battery is available or false otherwise.
isRechargableBatteryAvailable()

Checks if a rechargeable battery is available.

public boolean

Returns:

true if the Current Power Mode field is synchronized on idle.
isSyncronizedWithOnIdle()

Checks if synchronized with the receiver on-when-idle subfield of the node descriptor.

Field Detail

CRITICAL_LEVELback to summary
public static final short CRITICAL_LEVEL

Current power source level: critical.

FULL_LEVELback to summary
public static final short FULL_LEVEL

Current power source level: 100%.

LOW_LEVELback to summary
public static final short LOW_LEVEL

Current power source level: 33%.

MIDDLE_LEVELback to summary
public static final short MIDDLE_LEVEL

Current power source level: 66%.

Method Detail

getCurrentPowerModeback to summary
public short getCurrentPowerMode()

Returns the current power mode.

Returns:short

the current power mode.

getCurrentPowerSourceback to summary
public short getCurrentPowerSource()

Returns the current power source field of the Power Descriptor.

Returns:short

the current power source field of the Power Descriptor.

getCurrentPowerSourceLevelback to summary
public short getCurrentPowerSourceLevel()

Returns the current power source level.

Returns:short

the current power source level. May be one of CRITICAL_LEVEL, LOW_LEVEL, MIDDLE_LEVEL, FULL_LEVEL.

isConstantMainsPowerAvailableback to summary
public boolean isConstantMainsPowerAvailable()

Checks if constant (mains) power is available.

Returns:boolean

true if constant (mains) power is available or false otherwise.

isDisposableBatteryback to summary
public boolean isDisposableBattery()

Checks if the currently selected power source is the disposable battery.

Returns:boolean

true if the currently selected power source is the disposable battery.

isDisposableBatteryAvailableback to summary
public boolean isDisposableBatteryAvailable()

Checks if a disposable battery is available.

Returns:boolean

true if a disposable battery is available or false otherwise.

isMainsPowerback to summary
public boolean isMainsPower()

Checks if the currently selected power source is the mains power.

Returns:boolean

true if the currently selected power source is the mains power.

isOnWhenStimulatedback to summary
public boolean isOnWhenStimulated()

Checks if the receiver is on when the device is simulated.

Returns:boolean

true if the Current Power Mode field tells that the receiver is on when the device is stimulated by pressing a button, for instance.

isPeriodicallyOnback to summary
public boolean isPeriodicallyOn()

Checks if the Current Power Mode field is periodically on.

Returns:boolean

true if the Current Power Mode field is periodically on.

isRechargableBatteryback to summary
public boolean isRechargableBattery()

Checks if the currently selected power source is the rechargeable battery.

Returns:boolean

true if the currently selected power source is the rechargeable battery.

isRechargableBatteryAvailableback to summary
public boolean isRechargableBatteryAvailable()

Checks if a rechargeable battery is available.

Returns:boolean

true if a rechargeable battery is available or false otherwise.

isSyncronizedWithOnIdleback to summary
public boolean isSyncronizedWithOnIdle()

Checks if synchronized with the receiver on-when-idle subfield of the node descriptor.

Returns:boolean

true if the Current Power Mode field is synchronized on idle.