OSGi 8.1.0 · org.osgi.service.zigbee · APIdia, the JavaDoc alternative

Device Service Specification for ZigBee Technology.

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 org.osgi.service.zigbee.ZigBeeNode service and then one org.osgi.service.zigbee.ZigBeeEndpoint service for each ZigBee endpoint discovered on the node.

org.osgi.service.zigbee.ZigBeeEndpoint interface provides the org.osgi.service.zigbee.ZigBeeEndpoint#getServerCluster(int) method to get an interface reference to a ZCLCluster object.

org.osgi.service.zigbee.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 org.osgi.service.zigbee.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)"

Interface Summary

Modifier and Type	Interface and Description
public interface	ZCLAttribute This interface represents a ZCLAttribute.
public interface	ZCLAttributeInfo This interface provides information about the attribute, like its ZCL attribute ID, if it manufacturer specific and about its data type (see `getDataType`).
public interface	ZCLCluster This interface represents a ZCL Cluster.
public interface	ZCLCommandResponse A response event for a `ZCLCommandResponseStream`.
public interface	ZCLCommandResponseStream This type represents a stream of responses to a broadcast operation.
public interface	ZCLEventListener This interface represents a listener to events from ZigBee Device nodes.
public interface	ZCLFrame This interface models the ZigBee Cluster Library Frame.
public interface	ZCLHeader This interface represents the ZCL Frame Header.
public interface	ZCLReadStatusRecord This interface the reading result of `ZCLCluster#readAttributes(ZCLAttributeInfo[])`.
public interface	ZDPFrame This interface represents a ZDP frame.
public interface	ZDPResponse This type represents a successful ZDP invocation.
public interface	ZigBeeDataInput The `ZigBeeDataInput` interface is designed for converting a series of bytes in Java data types.
public interface	ZigBeeDataOutput The `ZigBeeDataOutput` interface is designed for converting Java data types into a series of bytes.
public interface	ZigBeeEndpoint This interface represents a ZigBee EndPoint.
public interface	ZigBeeEvent This interface represents events generated by a ZigBee Device node.
public interface	ZigBeeGroup This interface represents a ZigBee Group.
public interface	ZigBeeHost This interface represents the machine that hosts the code to run a ZigBee device or client.
public interface	ZigBeeLinkQuality This interface represents an entry of the NeighborTableList.
public interface	ZigBeeNode This interface represents a ZigBee node, means a physical device that can communicate using the ZigBee protocol.
public interface	ZigBeeRoute This interface represents an entry of the RoutingTableList See Table 2.128 RoutingTableList Record Format in ZIGBEE SPECIFICATION: 1_053474r17ZB_TSC-ZigBee-Specification.pdf.

Class Summary

Modifier and Type	Class and Description
public class	APSException This exception class is specialized for the APS errors.
public class	ZCLException This class represents root exception for all the code related to ZigBee/ZCL.
public class	ZDPException This class represents root exception for all the code related to ZDP.
public class	ZigBeeDataTypes This class contains the constants that are used internally by these API to represent the ZCL data types.
public class	ZigBeeException This class represents root exception for all the code related to ZigBee.

Package org.osgi.service.zigbee

Interface Summary

Class Summary