@Version("1.0.1")
Package org.osgi.service.zigbee
This is the main package of this specification. It defines the interfaces that models the ZigBee concepts, like the ZigBee node and the ZigBee endpoint.
Each time a new ZigBee node is discovered, the driver will register a
ZigBeeNode
service and then one
ZigBeeEndpoint
service for
each ZigBee endpoint discovered on the node.
ZigBeeEndpoint
interface provides the
ZigBeeEndpoint.getServerCluster(int)
method
to get an interface reference to a ZCLCluster object.
ZCLCluster
interface contains methods that directly maps to the ZCL
profile-wide commands, like Read Attributes and Write Attributes, and allow
the developer to forge its own commands and send them through the invoke()
methods.
ZCL Attribute reportings are configured, registering a
ZCLEventListener
, provided that this service
is registered with the right service properties.
In addition to ZCL frames, the current specification allows also to send ZDP frames. Broadcasting and endpoint broadcasting is also supported for ZCL frames.
Bundles wishing to use this package must list the package in the Import-Package header of the bundle's manifest. This package has two types of users: the consumers that use the API in this package and the providers that implement the API in this package.
Example import for consumers using the API in this package:
Import-Package: org.osgi.service.zigbee; version="[1.0,2.0)"
Example import for providers implementing the API in this package:
Import-Package: org.osgi.service.zigbee; version="[1.0,1.1)"
- Author:
- $Id: 2a95b3be4100c2334c5340640664b2ef3c8a3a93 $
-
Interface Summary Interface Description ZCLAttribute This interface represents a ZCLAttribute.ZCLAttributeInfo This interface provides information about the attribute, like its ZCL attribute ID, if it manufacturer specific and about its data type (seeZCLAttributeInfo.getDataType()
).ZCLCluster This interface represents a ZCL Cluster.ZCLCommandResponse A response event for aZCLCommandResponseStream
.ZCLCommandResponseStream This type represents a stream of responses to a broadcast operation.ZCLEventListener This interface represents a listener to events from ZigBee Device nodes.ZCLFrame This interface models the ZigBee Cluster Library Frame.ZCLHeader This interface represents the ZCL Frame Header.ZCLReadStatusRecord This interface the reading result ofZCLCluster.readAttributes(ZCLAttributeInfo[])
.ZDPFrame This interface represents a ZDP frame.ZDPResponse This type represents a successful ZDP invocation.ZigBeeDataInput TheZigBeeDataInput
interface is designed for converting a series of bytes in Java data types.ZigBeeDataOutput TheZigBeeDataOutput
interface is designed for converting Java data types into a series of bytes.ZigBeeEndpoint This interface represents a ZigBee EndPoint.ZigBeeEvent This interface represents events generated by a ZigBee Device node.ZigBeeGroup This interface represents a ZigBee Group.ZigBeeHost This interface represents the machine that hosts the code to run a ZigBee device or client.ZigBeeLinkQuality This interface represents an entry of the NeighborTableList.ZigBeeNode This interface represents a ZigBee node, means a physical device that can communicate using the ZigBee protocol.ZigBeeRoute This interface represents an entry of the RoutingTableList -
Class Summary Class Description ZigBeeDataTypes This class contains the constants that are used internally by these API to represent the ZCL data types. -
Exception Summary Exception Description APSException This exception class is specialized for the APS errors.ZCLException This class represents root exception for all the code related to ZigBee/ZCL.ZDPException This class represents root exception for all the code related to ZDP.ZigBeeException This class represents root exception for all the code related to ZigBee.