From 65581f13d503724b4699dbbdb30dca09872cb660 Mon Sep 17 00:00:00 2001
From: Ziver Koc <ziver@koc.se>
Date: Tue, 26 Jan 2021 01:52:50 +0100
Subject: [PATCH] Some small updates and fixes for Zigbee

---
 hal-core/src/se/hal/ControllerManager.java    | 13 ++++---
 .../se/hal/intf/HalAbstractController.java    |  5 ++-
 .../src/se/hal/intf/HalEventController.java   |  3 ++
 .../src/se/hal/intf/HalSensorController.java  |  3 ++
 .../src/se/hal/page/EventConfigWebPage.java   |  1 -
 .../src/se/hal/struct/AbstractDevice.java     | 15 +++++---
 .../se/hal/EventControllerManagerTest.java    |  2 +-
 hal.conf.example                              |  1 +
 logging.properties                            | 21 ++++++++++--
 .../plugin/zigbee/HalZigbeeController.java    | 34 +++++++++++--------
 .../plugin/zigbee/ZigBeeJSerialCommPort.java  |  7 ++--
 .../zigbee/HalZigbeeControllerTest.java       | 10 ++++--
 12 files changed, 77 insertions(+), 38 deletions(-)

diff --git a/hal-core/src/se/hal/ControllerManager.java b/hal-core/src/se/hal/ControllerManager.java
index bf6c303a..a54d1171 100644
--- a/hal-core/src/se/hal/ControllerManager.java
+++ b/hal-core/src/se/hal/ControllerManager.java
@@ -19,7 +19,6 @@ import java.util.logging.Logger;
 /**
  * This class manages all SensorController and EventController objects
  */
-@SuppressWarnings("RedundantCast")
 public class ControllerManager implements HalSensorReportListener,
         HalEventReportListener,
         PreConfigurationActionListener,
@@ -31,21 +30,21 @@ public class ControllerManager implements HalSensorReportListener,
     /** All available sensor plugins **/
     private List<Class<? extends HalSensorConfig>> availableSensors = new ArrayList<>();
     /** List of all registered sensors **/
-    private List<Sensor> registeredSensors = Collections.synchronizedList(new ArrayList<Sensor>());
+    private List<Sensor> registeredSensors = Collections.synchronizedList(new ArrayList<>());
     /** List of auto detected sensors **/
-    private List<Sensor> detectedSensors = Collections.synchronizedList(new ArrayList<Sensor>());
+    private List<Sensor> detectedSensors = Collections.synchronizedList(new ArrayList<>());
     /** List of sensors that are currently being reconfigured **/
-    private List<Sensor> limboSensors = Collections.synchronizedList(new LinkedList<Sensor>());
+    private List<Sensor> limboSensors = Collections.synchronizedList(new LinkedList<>());
 
 
     /** All available event plugins **/
     private List<Class<? extends HalEventConfig>> availableEvents = new ArrayList<>();
     /** List of all registered events **/
-    private List<Event> registeredEvents = Collections.synchronizedList(new ArrayList<Event>());
+    private List<Event> registeredEvents = Collections.synchronizedList(new ArrayList<>());
     /** List of auto detected events **/
-    private List<Event> detectedEvents = Collections.synchronizedList(new ArrayList<Event>());
+    private List<Event> detectedEvents = Collections.synchronizedList(new ArrayList<>());
     /** List of all registered events **/
-    private List<Event> limboEvents = Collections.synchronizedList(new LinkedList<Event>());
+    private List<Event> limboEvents = Collections.synchronizedList(new LinkedList<>());
 
 
     /** A map of all instantiated controllers **/
diff --git a/hal-core/src/se/hal/intf/HalAbstractController.java b/hal-core/src/se/hal/intf/HalAbstractController.java
index 3379b174..515197c5 100644
--- a/hal-core/src/se/hal/intf/HalAbstractController.java
+++ b/hal-core/src/se/hal/intf/HalAbstractController.java
@@ -24,7 +24,8 @@
 
 package se.hal.intf;
 
-public interface HalAbstractController {
+
+public interface HalAbstractController<C, L> {
 
     /**
      * The framework might create dummy objects so any type of
@@ -33,13 +34,11 @@ public interface HalAbstractController {
      */
     void initialize() throws Exception;
 
-
     /**
      * @return the number of registered devices.
      */
     int size();
 
-
     /**
      * Close any resources associated with this controller.
      * This method could be called multiple times, first time
diff --git a/hal-core/src/se/hal/intf/HalEventController.java b/hal-core/src/se/hal/intf/HalEventController.java
index f8b7ff7c..9bb0837f 100644
--- a/hal-core/src/se/hal/intf/HalEventController.java
+++ b/hal-core/src/se/hal/intf/HalEventController.java
@@ -1,5 +1,8 @@
 package se.hal.intf;
 
+/**
+ * Controller interface for handling event based devices.
+ */
 public interface HalEventController extends HalAbstractController {
 
     /**
diff --git a/hal-core/src/se/hal/intf/HalSensorController.java b/hal-core/src/se/hal/intf/HalSensorController.java
index 035d6d50..8c193eeb 100644
--- a/hal-core/src/se/hal/intf/HalSensorController.java
+++ b/hal-core/src/se/hal/intf/HalSensorController.java
@@ -1,5 +1,8 @@
 package se.hal.intf;
 
+/**
+ * Controller interface for handling Sensor devices.
+ */
 public interface HalSensorController extends HalAbstractController {
 
     /**
diff --git a/hal-core/src/se/hal/page/EventConfigWebPage.java b/hal-core/src/se/hal/page/EventConfigWebPage.java
index 5afeaf84..8113a933 100644
--- a/hal-core/src/se/hal/page/EventConfigWebPage.java
+++ b/hal-core/src/se/hal/page/EventConfigWebPage.java
@@ -116,7 +116,6 @@ public class EventConfigWebPage extends HalWebPage {
         tmpl.set("availableEvents", ControllerManager.getInstance().getAvailableEvents());
 
         return tmpl;
-
     }
 
 }
diff --git a/hal-core/src/se/hal/struct/AbstractDevice.java b/hal-core/src/se/hal/struct/AbstractDevice.java
index 5c7dfa9d..42ff8fed 100644
--- a/hal-core/src/se/hal/struct/AbstractDevice.java
+++ b/hal-core/src/se/hal/struct/AbstractDevice.java
@@ -2,6 +2,7 @@ package se.hal.struct;
 
 import se.hal.ControllerManager;
 import se.hal.HalContext;
+import se.hal.intf.HalAbstractController;
 import se.hal.intf.HalDeviceData;
 import se.hal.intf.HalDeviceReportListener;
 import zutil.db.DBConnection;
@@ -50,7 +51,9 @@ public abstract class AbstractDevice<T extends AbstractDevice, C,D extends HalDe
     protected transient List<HalDeviceReportListener<T>> listeners = new LinkedList<>();
 
 
-    /**************** DEVICE CONFIG ******************/
+    // ----------------------------------------------------
+    // Device config methods
+    // ----------------------------------------------------
 
     public Configurator<C> getDeviceConfigurator() {
         C obj = getDeviceConfig();
@@ -123,9 +126,11 @@ public abstract class AbstractDevice<T extends AbstractDevice, C,D extends HalDe
         }
     }
 
-    public abstract Class<?> getController();
+    public abstract Class<? extends HalAbstractController> getController();
 
-    /**************** DEVICE DATA ******************/
+    // ----------------------------------------------------
+    // Device data methods
+    // ----------------------------------------------------
 
     /**
      * @return the latest known data from the device
@@ -143,7 +148,9 @@ public abstract class AbstractDevice<T extends AbstractDevice, C,D extends HalDe
      */
     protected abstract D getLatestDeviceData(DBConnection db);
 
-    /**************** OTHER ******************/
+    // ----------------------------------------------------
+    // Other methods
+    // ----------------------------------------------------
 
     public String getName() {
         return name;
diff --git a/hal-core/test/se/hal/EventControllerManagerTest.java b/hal-core/test/se/hal/EventControllerManagerTest.java
index 29d0d9a7..73648355 100644
--- a/hal-core/test/se/hal/EventControllerManagerTest.java
+++ b/hal-core/test/se/hal/EventControllerManagerTest.java
@@ -107,7 +107,7 @@ public class EventControllerManagerTest {
         }
     }
 
-    public static class TestController implements HalEventController{
+    public static class TestController implements HalEventController {
         int size;
 
         @Override
diff --git a/hal.conf.example b/hal.conf.example
index d543e99b..c7f1e2f4 100755
--- a/hal.conf.example
+++ b/hal.conf.example
@@ -26,6 +26,7 @@ hal.http_port=8080
 
 ## Zigbee plugin
 #zigbee.com_port=COM4
+#zigbee.dongle=CC2531|CONBEE|XBEE
 
 ## ZWave plugin
 #zwave.com_port=COM4
diff --git a/logging.properties b/logging.properties
index f5db9d3b..bfd8c297 100755
--- a/logging.properties
+++ b/logging.properties
@@ -1,15 +1,30 @@
 # logging.properties
 # LogUtil.readConfiguration("logging.properties");
 
+# -------------------------------------
+# HAL
+# -------------------------------------
+
 handlers = java.util.logging.ConsoleHandler, java.util.logging.FileHandler
 java.util.logging.ConsoleHandler.level = ALL
 java.util.logging.ConsoleHandler.formatter = zutil.log.CompactLogFormatter
 java.util.logging.FileHandler.level = ALL
 java.util.logging.FileHandler.formatter = zutil.log.CompactLogFormatter
 
-
-se.hal.level = ALL
+# Libs
 
 zutil.level = ALL
 zutil.db.bean.level = INFO
-zutil.net.http.page.HttpFilePage.level = INFO
\ No newline at end of file
+zutil.net.http.page.HttpFilePage.level = INFO
+
+# Hal Core
+
+se.hal.level = ALL
+
+# -------------------------------------
+# Plugins
+# -------------------------------------
+
+#com.zsmartsystems.zigbee.level = FINE
+com.zsmartsystems.zigbee.dongle.cc2531.zigbee.util.ByteUtils.level = INFO
+com.zsmartsystems.zigbee.dongle.cc2531.network.packet.ZToolPacketStream.level = INFO
\ No newline at end of file
diff --git a/plugins/hal-zigbee/src/se/hal/plugin/zigbee/HalZigbeeController.java b/plugins/hal-zigbee/src/se/hal/plugin/zigbee/HalZigbeeController.java
index a9d62b45..4fe90f3f 100644
--- a/plugins/hal-zigbee/src/se/hal/plugin/zigbee/HalZigbeeController.java
+++ b/plugins/hal-zigbee/src/se/hal/plugin/zigbee/HalZigbeeController.java
@@ -29,7 +29,12 @@ import java.util.logging.Logger;
 public class HalZigbeeController implements HalSensorController, HalEventController, HalAutoScannableController {
     private static final Logger logger = LogUtil.getLogger();
 
+    public static final String ZIGBEE_DONGLE_CC2531 = "CC2531";
+    public static final String ZIGBEE_DONGLE_CONBEE = "CONBEE";
+    public static final String ZIGBEE_DONGLE_XBEE   = "XBEE";
+
     private static final String CONFIG_ZIGBEE_PORT = "zigbee.com_port";
+    private static final String CONFIG_ZIGBEE_DONGLE = "zigbee.dongle";
 
     private ZigBeePort serialPort;
     private ZigBeeDataStore dataStore;
@@ -45,22 +50,23 @@ public class HalZigbeeController implements HalSensorController, HalEventControl
 
     @Override
     public boolean isAvailable() {
-        return HalContext.containsProperty(CONFIG_ZIGBEE_PORT);
+        return HalContext.containsProperty(CONFIG_ZIGBEE_PORT) &&
+                HalContext.containsProperty(CONFIG_ZIGBEE_DONGLE);
     }
     @Override
     public void initialize() {
-        initialize(
-                HalContext.getStringProperty(CONFIG_ZIGBEE_PORT));
+        initialize(HalContext.getStringProperty(CONFIG_ZIGBEE_PORT), HalContext.getStringProperty(CONFIG_ZIGBEE_DONGLE));
     }
-    public void initialize(String comPort) {
+    public void initialize(String comPort, String dongleName) {
         serialPort = new ZigBeeJSerialCommPort(comPort);
         dataStore = new ZigBeeDataStore();
+        TransportConfig transportOptions = new TransportConfig();
 
         // ----------------------------
         // Initialize Transport Network
         // ----------------------------
 
-        ZigBeeTransportTransmit dongle = getDongle("CC2531", serialPort);
+        ZigBeeTransportTransmit dongle = getDongle(dongleName, serialPort, transportOptions);
         networkManager = new ZigBeeNetworkManager(dongle);
         networkManager.setNetworkDataStore(dataStore);
         networkManager.setSerializer(DefaultSerializer.class, DefaultDeserializer.class);
@@ -77,10 +83,9 @@ public class HalZigbeeController implements HalSensorController, HalEventControl
 
         networkManager.setDefaultProfileId(ZigBeeProfileType.ZIGBEE_HOME_AUTOMATION.getKey());
 
-        TransportConfig transportOptions = new TransportConfig();
         transportOptions.addOption(TransportConfigOption.RADIO_TX_POWER, 3);
         transportOptions.addOption(TransportConfigOption.TRUST_CENTRE_JOIN_MODE, TrustCentreJoinMode.TC_JOIN_SECURE);
-        transportOptions.addOption(TransportConfigOption.TRUST_CENTRE_LINK_KEY, new ZigBeeKey(new int[] {
+        transportOptions.addOption(TransportConfigOption.TRUST_CENTRE_LINK_KEY, new ZigBeeKey(new int[] { // Add the default ZigBeeAlliance09 HA link key
                 0x5A, 0x69, 0x67, 0x42, 0x65, 0x65, 0x41, 0x6C, 0x6C, 0x69, 0x61, 0x6E, 0x63, 0x65, 0x30, 0x39 }));
         dongle.updateTransportConfig(transportOptions);
 
@@ -100,21 +105,22 @@ public class HalZigbeeController implements HalSensorController, HalEventControl
         // Other stuff
         // -----------
 
-        /*if (dongle instanceof ZigBeeDongleTiCc2531) {
+        if (dongle instanceof ZigBeeDongleTiCc2531) {
             ZigBeeDongleTiCc2531 tiDongle = (ZigBeeDongleTiCc2531) dongle;
             tiDongle.setLedMode(1, false);
             tiDongle.setLedMode(2, false);
-        }*/
+        }
     }
 
-    private static ZigBeeTransportTransmit getDongle(String name, ZigBeePort serialPort) {
+    private static ZigBeeTransportTransmit getDongle(String name, ZigBeePort serialPort, TransportConfig transportOptions) {
         switch (name) {
-        case "CC2531":
+        case ZIGBEE_DONGLE_CC2531:
+            transportOptions.addOption(TransportConfigOption.RADIO_TX_POWER, 3);
             return new ZigBeeDongleTiCc2531(serialPort);
-        case "XBEE":
-            return new ZigBeeDongleXBee(serialPort);
-        case "CONBEE":
+        case ZIGBEE_DONGLE_CONBEE:
             return new ZigBeeDongleConBee(serialPort);
+        case ZIGBEE_DONGLE_XBEE:
+            return new ZigBeeDongleXBee(serialPort);
         default:
             logger.severe("Unknown ZigBee dongle: " + name);
             return null;
diff --git a/plugins/hal-zigbee/src/se/hal/plugin/zigbee/ZigBeeJSerialCommPort.java b/plugins/hal-zigbee/src/se/hal/plugin/zigbee/ZigBeeJSerialCommPort.java
index 34a60e04..7693722b 100644
--- a/plugins/hal-zigbee/src/se/hal/plugin/zigbee/ZigBeeJSerialCommPort.java
+++ b/plugins/hal-zigbee/src/se/hal/plugin/zigbee/ZigBeeJSerialCommPort.java
@@ -112,6 +112,7 @@ public class ZigBeeJSerialCommPort implements ZigBeePort {
             return true;
         } catch (Exception e) {
             logger.error("Unable to open serial port: " + e.getMessage());
+            close();
             return false;
         }
     }
@@ -179,7 +180,7 @@ public class ZigBeeJSerialCommPort implements ZigBeePort {
 
     @Override
     public void write(int value) {
-        if (serialPort == null)
+        if (serialOutputstream == null)
             throw new RuntimeException("Unable to write, Serial port is not open.");
 
         try {
@@ -196,7 +197,7 @@ public class ZigBeeJSerialCommPort implements ZigBeePort {
 
     @Override
     public int read(int timeout) {
-        if (serialPort == null)
+        if (serialInputstream == null)
             throw new RuntimeException("Unable to read, Serial port is not open.");
 
         try {
@@ -212,7 +213,7 @@ public class ZigBeeJSerialCommPort implements ZigBeePort {
 
     @Override
     public void purgeRxBuffer() {
-        if (serialPort == null)
+        if (serialOutputstream == null)
             return;
 
         try {
diff --git a/plugins/hal-zigbee/test/se/hal/plugin/zigbee/HalZigbeeControllerTest.java b/plugins/hal-zigbee/test/se/hal/plugin/zigbee/HalZigbeeControllerTest.java
index 24a05928..2b3534d1 100644
--- a/plugins/hal-zigbee/test/se/hal/plugin/zigbee/HalZigbeeControllerTest.java
+++ b/plugins/hal-zigbee/test/se/hal/plugin/zigbee/HalZigbeeControllerTest.java
@@ -41,7 +41,7 @@ public class HalZigbeeControllerTest {
         LogUtil.setGlobalLevel(Level.ALL);
 
         HalZigbeeController controller = new HalZigbeeController();
-        controller.initialize("COM3");
+        controller.initialize("COM4", HalZigbeeController.ZIGBEE_DONGLE_CONBEE);
 
         System.out.println("PAN ID          = " + controller.networkManager.getZigBeePanId());
         System.out.println("Extended PAN ID = " + controller.networkManager.getZigBeeExtendedPanId());
@@ -90,8 +90,14 @@ public class HalZigbeeControllerTest {
     }
 
     private static char waitForInout() throws IOException {
+        System.out.print("");
         System.out.print("Input command and finish with ENTER: ");
 
-        return (char) System.in.read();
+        while (true) {
+            char input=(char)System.in.read();
+            if (input != '\n')
+                return input;
+        }
+
     }
 }
\ No newline at end of file