Package org.osgi.service.zigbee.descriptors

Interface ZigBeePowerDescriptor

  • 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 Detail

      • CRITICAL_LEVEL

        static final short CRITICAL_LEVEL
        Current power source level: critical.
        See Also:
        Constant Field Values

      • LOW_LEVEL

        static final short LOW_LEVEL
        Current power source level: 33%.
        See Also:
        Constant Field Values

      • MIDDLE_LEVEL

        static final short MIDDLE_LEVEL
        Current power source level: 66%.
        See Also:
        Constant Field Values

      • FULL_LEVEL

        static final short FULL_LEVEL
        Current power source level: 100%.
        See Also:
        Constant Field Values

    • Method Detail

      • getCurrentPowerMode

        short getCurrentPowerMode()
        Returns the current power mode.
        Returns:
        the current power mode.

      • getCurrentPowerSource

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

      • isMainsPower

        boolean isMainsPower()
        Checks if the currently selected power source is the mains power.
        Returns:
        true if the currently selected power source is the mains power.

      • isDisposableBattery

        boolean isDisposableBattery()
        Checks if the currently selected power source is the disposable battery.
        Returns:
        true if the currently selected power source is the disposable battery.

      • isRechargableBattery

        boolean isRechargableBattery()
        Checks if the currently selected power source is the rechargeable battery.
        Returns:
        true if the currently selected power source is the rechargeable battery.

      • isConstantMainsPowerAvailable

        boolean isConstantMainsPowerAvailable()
        Checks if constant (mains) power is available.
        Returns:
        true if constant (mains) power is available or false otherwise.

      • isDisposableBatteryAvailable

        boolean isDisposableBatteryAvailable()
        Checks if a disposable battery is available.
        Returns:
        true if a disposable battery is available or false otherwise.

      • isRechargableBatteryAvailable

        boolean isRechargableBatteryAvailable()
        Checks if a rechargeable battery is available.
        Returns:
        true if a rechargeable battery is available or false otherwise.

      • isSyncronizedWithOnIdle

        boolean isSyncronizedWithOnIdle()
        Checks if synchronized with the receiver on-when-idle subfield of the node descriptor.
        Returns:
        true if the Current Power Mode field is synchronized on idle.

      • isPeriodicallyOn

        boolean isPeriodicallyOn()
        Checks if the Current Power Mode field is periodically on.
        Returns:
        true if the Current Power Mode field is periodically on.

      • isOnWhenStimulated

        boolean isOnWhenStimulated()
        Checks if the receiver is on when the device is simulated.
        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.