Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Set the default link key #257

Merged
merged 2 commits into from Sep 17, 2018
Merged

Set the default link key #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7ed2a4
Set the default link key
cdjackson Sep 10, 2018
700e49d
Merge branch 'master' into link_key
cdjackson Sep 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions org.openhab.binding.zigbee/README.md
View file
Open in desktop
Expand Up @@ -10,6 +10,23 @@ A ZigBee Coordinator is the network controller, and is therefore the heart of th

Coordinators need to be installed manually and the serial port and baud rate must be set. These are set to match the configuration that the dongle is in. Should you wish to use a different baud rate than the default speed of the device, you must change the configuration of the dongle using some other, and then configure the binding to match your change. If in doubt, you should leave the settings at their default values which should work in most cases.

#### Coordinator Configuration

##### Link Key (zigbee_linkkey)

The key is defined as 16 hexadecimal values. If not defined, this will default to the well known ZigBee HA link key.

If defined with the word ```INSTALLCODE:``` before the key, this will create a link key from an install code which may be shorter than 16 bytes.

eg ```5A 69 67 42 65 65 41 6C 6C 69 61 6E 63 65 30 39```
eg ```INSTALLCODE:00 11 22 33 44 55 66 77```

##### Network Key (zigbee_networkkey)

The key is defined as 16 hexadecimal values. If not defined, a random key will be created.

#### Supported Coordinators

The following coordinators are known to be supported.

| Name and Link | Coordinator | Comment |
Expand Down
1 change: 1 addition & 0 deletions ...enhab.binding.zigbee/src/main/java/org/openhab/binding/zigbee/ZigBeeBindingConstants.java
View file
Open in desktop
Expand Up @@ -159,6 +159,7 @@ public class ZigBeeBindingConstants {
public final static String CONFIGURATION_BAUD = "zigbee_baud";
public final static String CONFIGURATION_FLOWCONTROL = "zigbee_flowcontrol";
public static final String CONFIGURATION_NETWORKKEY = "zigbee_networkkey";
public static final String CONFIGURATION_LINKKEY = "zigbee_linkkey";
public static final String CONFIGURATION_PASSWORD = "zigbee_password";
public static final String CONFIGURATION_INITIALIZE = "zigbee_initialise";
public static final String CONFIGURATION_TRUSTCENTREMODE = "zigbee_trustcentremode";
Expand Down
38 changes: 31 additions & 7 deletions ...ing.zigbee/src/main/java/org/openhab/binding/zigbee/handler/ZigBeeCoordinatorHandler.java
View file
Open in desktop
Expand Up @@ -95,6 +95,7 @@ public abstract class ZigBeeCoordinatorHandler extends BaseBridgeHandler

private ZigBeeNetworkStateSerializerImpl networkStateSerializer;

protected ZigBeeKey linkKey;
protected ZigBeeKey networkKey;

private TransportConfig transportConfig;
Expand All @@ -116,6 +117,12 @@ public abstract class ZigBeeCoordinatorHandler extends BaseBridgeHandler

private volatile boolean bridgeRemoved = false;

/**
* Default ZigBeeAlliance09 link key
*/
private final static ZigBeeKey KEY_ZIGBEE_ALLIANCE_O9 = new ZigBeeKey(new int[] { 0x5A, 0x69, 0x67, 0x42, 0x65,
0x65, 0x41, 0x6C, 0x6C, 0x69, 0x61, 0x6E, 0x63, 0x65, 0x30, 0x39 });

public ZigBeeCoordinatorHandler(Bridge coordinator) {
super(coordinator);
}
Expand All @@ -126,6 +133,7 @@ public void initialize() {
panId = 0xffff;
channelId = 0;
initializeNetwork = false;
String linkKeyString = "";
String networkKeyString = "";

try {
Expand All @@ -145,11 +153,16 @@ public void initialize() {
}

Object param = getConfig().get(CONFIGURATION_NETWORKKEY);
logger.debug("Key {}", getConfig().get(CONFIGURATION_NETWORKKEY));
logger.debug("Network Key {}", getConfig().get(CONFIGURATION_NETWORKKEY));
if (param != null && param instanceof String) {
networkKeyString = (String) param;
}

param = getConfig().get(CONFIGURATION_LINKKEY);
logger.debug("Link Key {}", getConfig().get(CONFIGURATION_LINKKEY));
if (param != null && param instanceof String) {
linkKeyString = (String) param;
}
} catch (ClassCastException | NumberFormatException e) {
logger.error("{}: ZigBee initialisation exception ", thing.getUID(), e);
updateStatus(ThingStatus.OFFLINE);
Expand Down Expand Up @@ -225,10 +238,9 @@ public void initialize() {
}
}

logger.debug("Key String {}", networkKeyString);

// Process the network key
try {
logger.debug("Network Key String {}", networkKeyString);
networkKey = new ZigBeeKey(networkKeyString);
} catch (IllegalArgumentException e) {
networkKey = new ZigBeeKey();
Expand All @@ -237,10 +249,21 @@ public void initialize() {
// If no key exists, generate a random key and save it back to the configuration
if (!networkKey.isValid()) {
networkKey = ZigBeeKey.createRandom();
logger.debug("Key initialised {}", networkKey);
logger.debug("Network key initialised {}", networkKey);
}

logger.debug("Key final array {}", networkKey);
logger.debug("Network key final array {}", networkKey);

// Process the link key
try {
logger.debug("Link Key String {}", linkKeyString);
linkKey = new ZigBeeKey(linkKeyString);
} catch (IllegalArgumentException e) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestion: Add a log statement within the catch block, so that it gets visible in the log that (and why) the system falls back to the well-known key.

That the system fell back to the well-known key is also visible (though somewhat implicit) from the log statement with the final link key array, the additional log statement would make this more explicit.

linkKey = KEY_ZIGBEE_ALLIANCE_O9;
logger.debug("Link Key String has invalid format. Revert to default key.");
}

logger.debug("Link key final array {}", linkKey);
}

@Override
Expand Down Expand Up @@ -344,8 +367,6 @@ private void initialiseZigBee() {
networkManager.addExtension(new ZigBeeIasCieExtension());
networkManager.addExtension(new ZigBeeOtaUpgradeExtension());

logger.debug("Key initialise {}", networkKey);

// Add any listeners that were registered before the manager was registered
synchronized (listeners) {
for (ZigBeeNetworkNodeListener listener : listeners) {
Expand Down Expand Up @@ -375,6 +396,9 @@ private void initialiseZigBee() {
ExtendedPanId currentExtendedPanId = networkManager.getZigBeeExtendedPanId();

if (initializeNetwork) {
logger.debug("Link key initialise {}", linkKey);
logger.debug("Network key initialise {}", networkKey);
networkManager.setZigBeeLinkKey(linkKey);
networkManager.setZigBeeNetworkKey(networkKey);
networkManager.setZigBeeChannel(ZigBeeChannel.create(channelId));
networkManager.setZigBeePanId(panId);
Expand Down