org.osgi.service.zigbee.descriptors

Interface ZigBeeNodeDescriptor

public interface ZigBeeNodeDescriptor

This interface represents a Node Descriptor as described in the ZigBee Specification.

The Node Descriptor contains information about the capabilities of the node.

"Consumers of this API must not implement this interface"

Method Summary

Modifier and Type	Method and Description
ZigBeeFrequencyBand	getFrequencyBand() Returns the radio frequency band the node is currently operating on.
short	getLogicalType() Returns the logical type of the described node.
ZigBeeMacCapabiliyFlags	getMacCapabilityFlags() Returns the MAC Capability Flags field information.
int	getManufacturerCode() Returns the manufacturer code of the described node.
int	getMaxBufferSize() Returns the maximum buffer size of the described node.
int	getMaxIncomingTransferSize() Returns the maximum incoming transfer size of the described node.
int	getMaxOutgoingTransferSize() Returns the maximum outgoing transfer size of the described node.
ZigBeeServerMask	getServerMask() Returns the server mask of the described node.
boolean	isComplexDescriptorAvailable() Checks if a complex descriptor is available.
boolean	isExtendedActiveEndpointListAvailable() Checks if extended active endpoint list is available.
boolean	isExtendedSimpleDescriptorListAvailable() Checks if extended simple descriptor is available.
boolean	isUserDescriptorAvailable() Checks if a user descriptor is available.

Method Detail

getLogicalType

short getLogicalType()

Returns the logical type of the described node.

Returns:

one of: ZigBeeNode.COORDINATOR, ZigBeeNode.ROUTER, ZigBeeNode.ZED.

isComplexDescriptorAvailable

boolean isComplexDescriptorAvailable()

Checks if a complex descriptor is available.

Returns:

true if a complex descriptor is available or false otherwise.

isUserDescriptorAvailable

boolean isUserDescriptorAvailable()

Checks if a user descriptor is available.

Returns:

true if a user descriptor is available or false otherwise.

getFrequencyBand

ZigBeeFrequencyBand getFrequencyBand()

Returns the radio frequency band the node is currently operating on.

Returns:

returns the information about the radio frequency band the node is currently operating on.

getMacCapabilityFlags

ZigBeeMacCapabiliyFlags getMacCapabilityFlags()

Returns the MAC Capability Flags field information.

Returns:

the MAC Capability Flags field information.

getManufacturerCode

int getManufacturerCode()

Returns the manufacturer code of the described node.

Returns:

the manufacturer code of the described node.

getMaxBufferSize

int getMaxBufferSize()

Returns the maximum buffer size of the described node.

Returns:

the maximum buffer size of the described node.

getMaxIncomingTransferSize

int getMaxIncomingTransferSize()

Returns the maximum incoming transfer size of the described node.

Returns:

the maximum incoming transfer size of the described node.

getMaxOutgoingTransferSize

int getMaxOutgoingTransferSize()

Returns the maximum outgoing transfer size of the described node.

Returns:

the maximum outgoing transfer size of the described node.

getServerMask

ZigBeeServerMask getServerMask()

Returns the server mask of the described node.

Returns:

the server mask of the described node.

isExtendedActiveEndpointListAvailable

boolean isExtendedActiveEndpointListAvailable()

Checks if extended active endpoint list is available.

Returns:

true if extended active endpoint list is available or false otherwise.

isExtendedSimpleDescriptorListAvailable

boolean isExtendedSimpleDescriptorListAvailable()

Checks if extended simple descriptor is available.

Returns:

true if extended simple descriptor is available or false otherwise.