ZCL Library 4.3 Java

ZCL Library overview
Starting communication with an UBee
Subscribe to receive node events
Sending a Read attributes command
Sending a Write attributes command
Sending a Discover attributes command
Sending a Read reporting configuration command
Sending a Configure reporting command
Sending a Cluster Specific command
Sending a ZCL Frame command
Subscribe to receive notification events
Create a Binding to receive notifications
Create a Binding to actuate a device
Set the path of the license file
Set the license key by programming

1. ZCL Library overview

The ZCL library API allows facilitating the development of application which interfaces with the Cleode UBee™ dongle.
It includes a JAR ("zcl-connector.jar") and a C++ dynamic library (".dll" for Windows, ".so" for Linux or ".dynlib" for MacOSX).

This API provides services for the following functionalities:

Management and configuration of UBee.
Reception of association events, update of Zigbee nodes.
Reading of present Zigbee nodes in the network.
Emission and reception of commands ZCL.
Subscription to receive notifications of Zigbee nodes.
Creation and deletion of bindings between Zigbee nodes.
Authorization of Zigbee nodes to be gone into the network.

2. Starting communication with an UBee

The detection of UBee on any USB port is automatic, except in the case where the port name is specified.
The return value of startUbee() service indicates if the UBee is detected or not.

When UBee is detected, an ubeeStarted event is notified and you can check the license validity.
If UBee is unplugged, an ubeeReleased event is notified. And thereafter every 5 seconds, the API verify if UBee is replugged.
When you call the stopUbee() service, an ubeeStopped event is notified.
If UBee is awaiting reprogramming, an ubeeWaitingBoot event is notified.

public class Application implements AliveCallback
{	
	ZigbeeConnectorServices zcs = ZigbeeConnector.singleton.getZigbeeConnectorServices();

	public Application() throws IOException
	{
		// Start the communication with UBee
		boolean result = zcs.startUbee(this);

		//Display if the UBee is detected or not
		System.out.printf("UBee is %s \n", (result ? "detected" : "not detected"));

		System.out.println("Press any key to Quit the application");
		// Wait for the pressing any key
		System.in.read();
		
		// Stop the communication with UBee
		zcs.stopUbee();
	}

	public void ubeeStarted() {
		System.out.println("====> UBee Started notification");
		System.out.printf("UBee License validity for %s : %s\n",
			zcs.getCoordinator(), Boolean.toString(zcs.isLicenseValid()));
	}

	@Override
	public void ubeeReleased() {
		System.out.println("====> UBee Released notification");
	}

	@Override
	public void ubeeStopped() {
		System.out.println("====> UBee Stopped notification");
	}

	@Override
	public void ubeeWaitingBoot() {
		System.out.println("====> UBee Waiting Boot notification");
	}
}

Starting UBee on a specific port name

// Windows
zcs.startUbee(this, "COM22");

// Linux
zcs.startUbee(this, "/dev/ttyUSB1");

3. Subscribe to receive node events

This subscription allows to receive the events such as associating, updating and deleting of the Zigbee nodes.
It is strongly recommended to make a clone of the node if you want to store the node instance and to modify it.

After the UBee is starting, a discovery of Zigbee node is done and at least 3 events are notified for each node.
  - When the structure of the node has been read : Created / Discover.
  - When the model identifier of the node has been read : Updated / ModelID.
  - When the bindings of the node has been read : Updated / Bindings.

public class Application implements AliveCallback, ZigbeeConnectorNodeEvents
{	
	ZigbeeConnectorServices zcs = ZigbeeConnector.singleton.getZigbeeConnectorServices();

	public Application() throws IOException
	{
		// Subcribe to receive node events
		zcs.subscribe(this);
		
		// Start the communication with UBee
		zcs.startUbee(this);

		System.out.println("Press any key to Quit the application");
		// Wait for the pressing any key
		System.in.read();
		
		// Stop the communication with UBee
		zcs.stopUbee();
	}

	...

	@Override
	public void notifyNodeCreated(final Node node, final Reason reason) {
		System.out.printf("====> Node Created %s : %s\n", node, reason);
	}

	@Override
	public void notifyNodeUpdated(final Node node, final Reason reason) {
		System.out.printf("====> Node Updated %s : %s\n", node, reason);
	}

	@Override
	public void notifyNodeDeleted(final Node node, final Reason reason) {
		System.out.printf("====> Node Deleted %s : %s\n", node, reason);
	}
}

4. Sending a Read attributes command

The Read Attributes command is used to read the attribute values of a cluster from the device.
The response of this request is received on the callback passed as parameter to the service.