ZigBee API for Java is a fork of ZB4OSGI for usage without OSGI. Changes include removal of OSGI related dependencies and refactored API.
See the API Java Doc here
ZB4OSGI: http://zb4osgi.aaloa.org/
Questions can be sent to the following email address: '[email protected]'.
You can also contact me directly: '[email protected]'.
The URL to the discussion group: https://groups.google.com/d/forum/zigbee4java
The URL to the FAQ: https://groups.google.com/d/forum/zigbee4java
This library provides API to ZigBee network through CC2531 dongle.
Example hardware that can be controlled with zigbee4java:
- Philips Hue Bulb
- Java 7
- Maven 3 and/or Gradle
- CC2531 dongle with USB serial / coordinator firmware. Flashing new firmware requires CCDEBUGGER hardware component.
- Second CC2531 dongle if you want to have cheap packet sniffer. There are probably better packet sniffers out there.
You need to buy the following items:
- http://www.ti.com/tool/cc2531emk (NOTE: Buy two if you want to use another as packet sniffer.)
- http://www.ti.com/tool/cc-debugger
- Download and install Z-STACK-HOME from http://www.ti.com/tool/z-stack
- View CCDEBUGGER user guide: http://www.ti.com/lit/ug/swru197h/swru197h.pdf
- Flash CC2531ZNP-Pro-Secure_Standard.hex with Smart RF Studio included in Z-STACK-HOME.
Serial-comm and zigbee4java dependencies can be found from the following repository for convenience.
<repositories>
<repository>
<id>jcenter-bintray</id>
<name>bintray</name>
<url>http://jcenter.bintray.com</url>
</repository>
</repositories>
Maven:
<dependencies>
<dependency>
<groupId>org.bubblecloud.zigbee4java</groupId>
<artifactId>zigbee-api</artifactId>
<version>2.0.11</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>org.bubblecloud.zigbee4java</groupId>
<artifactId>zigbee-serial-javase</artifactId>
<version>2.0.11</version>
</dependency>
</dependencies>
Gradle:
dependencies
{
compile 'org.bubblecloud.zigbee:zigbee-api:2.0.10'
compile 'org.bubblecloud.zigbee:zigbee-serial-javase:2.0.10'
}
Maven:
git clone https://github.com/tlaukkan/zigbee4java.git zigbee4java
cd zigbee4java
mvn clean install
Gradle:
git clone https://github.com/tlaukkan/zigbee4java.git zigbee4java
cd zigbee4java
gradlew clean build
Simple usage example:
final SerialPortImpl serialPort = new SerialPortImpl("/dev/ttyACM0", 38400);
final ZigBeeApi zigBeeApi = new ZigBeeApi(serialPort, 4951, 11, false, DiscoveryMode.ALL);
zigBeeApi.startup();
...
final Device lamp = zigBeeApi.getZigBeeApiContext().getDevice("00:17:88:01:00:BE:51:EC/11");
final Basic basic = lamp.getCluster(Basic);
final String manufactureName = basic.getManufacturerName();
final OnOff onOff = lamp.getCluster(OnOff.class);
onOff.on();
final int onOffAttributeIndex = 0;
final Reporter reporter = onOff.getAttribute(onOffAttributeIndex).getReporter();
reporter.addReportListener(reportListener);
Complete startup and shutdown example including network state loading:
final boolean resetNetwork = false;
final SerialPortImpl serialPort = new SerialPortImpl("COM5", 38400);
final ZigBeeApi zigBeeApi = new ZigBeeApi(serialPort, 4951, 11, false, DiscoveryMode.ALL);
final File networkStateFile = new File("network.json");
final boolean networkStateExists = networkStateFile.exists();
if (!resetNetwork && networkStateExists) {
LOGGER.info("ZigBeeApi loading network state...");
final String networkState = FileUtils.readFileToString(networkStateFile);
zigBeeApi.deserializeNetworkState(networkState);
LOGGER.info("ZigBeeApi loading network state done.");
}
LOGGER.info("ZigBeeApi startup...");
if (!zigBeeApi.startup()) {
LOGGER.error("Error initializing ZigBeeApi.");
return;
}
LOGGER.info("ZigBeeApi startup done.");
if (!networkStateExists) {
LOGGER.info("ZigBeeApi initial browsing...");
while (!zigBeeApi.isInitialBrowsingComplete()) {
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
}
LOGGER.info("Waiting for initial browsing to complete.");
}
LOGGER.info("ZigBeeApi initial browsing done.");
}
LOGGER.info("ZigBeeApi listing devices...");
final List<Device> devices = zigBeeApi.getDevices();
for (final Device device : devices) {
LOGGER.info(device.getNetworkAddress() + ")" + device.getDeviceType());
}
LOGGER.info("ZigBeeApi listing devices done.");
LOGGER.info("ZigBeeApi shutdown...");
zigBeeApi.shutdown();
serialPort.close();
LOGGER.info("ZigBeeApi shutdown done.");
LOGGER.info("ZigBeeApi saving network state...");
FileUtils.writeStringToFile(networkStateFile, zigBeeApi.serializeNetworkState(), false);
LOGGER.info("ZigBeeApi saving network state done.");
This is an example how to interface directly with ZCL commands to accept IAS zone enroll request:
zigBeeApi.addCommandListener(new ZclCommandListener() {
@Override
public void commandReceived(final ZclCommandMessage command) {
if (command.getCommand() == ZclCommandType.ZONE_ENROLL_REQUEST_COMMAND) {
final int remoteAddress = command.getSourceAddress();
final short remoteEndPoint = command.getSourceEnpoint();
final byte transactionId = command.getTransactionId();
final ZclCommandMessage responseMessage = new ZclCommandMessage(
remoteAddress, remoteEndPoint, ZclCommandType.ZONE_ENROLL_RESPONSE_COMMAND, transactionId);
responseMessage.addField(ZclFieldType.ZONE_ENROLL_RESPONSE_COMMAND_ENROLL_RESPONSE_CODE, 0);
responseMessage.addField(ZclFieldType.ZONE_ENROLL_RESPONSE_COMMAND_ZONE_ID, 0);
new Thread(new Runnable() {
@Override
public void run() {
try {
zigBeeApi.sendCommand(responseMessage);
} catch (final ZigBeeNetworkManagerException e) {
}
}
}).start();
}
}
});
- ZigBeeConsole.java
- Follow Google Java style: https://google.github.io/styleguide/javaguide.html
- Add unit tests for your commit if applicable / possible.
- Build before commit.
- Rebase instead of merge when pushing.
- Check that Travis CI build passes after pushing.
- Fix any issues in your commit found in Codacy analysis.
Release can be done only from master branch by tagging the head revision with the following syntax:
{VERSION}-release-ready
For example:
2.0.10-release-ready
This will trigger a release build by the build agent.