Merge pull request #141 from bwssytems/hal-integration

Hal integration and other enhancement and fixes

Author: bwssytems

README.md

@@ -21,7 +21,7 @@ Then locate the jar and start the server with:
 ATTENTION: This requires JDK 1.8 to run
 
 ```
-java -jar ha-bridge-2.0.6.jar
+java -jar ha-bridge-2.5.0.jar
 ```
 ### Automation on Linux systems
 To have this configured and running automatically there are a few resources to use. One is using Docker and a docker container has been built for this and can be gotten here: https://github.com/aptalca/docker-ha-bridge
@@ -35,19 +35,19 @@ After=network.target
 
 [Service]
 Type=simple
-ExecStart=/usr/bin/java -jar -Dconfig.file=/home/pi/amazon-echo/data/habridge.config /home/pi/amazon-echo/ha-bridge-2.0.6.jar
+ExecStart=/usr/bin/java -jar -Dconfig.file=/home/pi/amazon-echo/data/habridge.config /home/pi/amazon-echo/ha-bridge-2.5.0.jar
 
 [Install]
 WantedBy=multi-user.target
 ```
 
 Basic script setup to run the bridge on a pi.
 
-Create the directory and make sure that ha-bridge-2.0.6.jar is in your /home/pi/habridge directory.
+Create the directory and make sure that ha-bridge-2.5.0.jar is in your /home/pi/habridge directory.
 ```
 pi@raspberrypi:~ $ mkdir habridge
 pi@raspberrypi:~ $ cd habridge
-pi@raspberrypi:~/habridge $ wget https://github.com/bwssytems/ha-bridge/releases/download/v2.0.6/ha-bridge-2.0.6.jar
+pi@raspberrypi:~/habridge $ wget https://github.com/bwssytems/ha-bridge/releases/download/v2.0.6/ha-bridge-2.5.0.jar
 ```
 Edit the shell script for starting:
 ```
@@ -57,7 +57,7 @@ Then cut and past this, modify any locations that are not correct
 ```
 cd /home/pi/habridge
 rm /home/pi/habridge/habridge-log.txt
-nohup java -jar /home/pi/habridge/ha-bridge-2.0.6.jar > /home/pi/habridge/habridge-log.txt 2>&1 &
+nohup java -jar /home/pi/habridge/ha-bridge-2.5.0.jar > /home/pi/habridge/habridge-log.txt 2>&1 &
 chmod 777 /home/pi/habridge/habridge-log.txt
 ```
 Exit and save the file with ctrl-X and follow the prompts and then execute on the command line:
@@ -109,7 +109,7 @@ The server defaults to running on port 8080. To override what the default is, sp
 #### UPNP Response Port
 The upnp response port that will be used. The default is 50000.  
 #### Vera Names and IP Addresses
-Provide IP Addresses of your Veras that you want to utilize with the bridge. Also, give a meaningful name to each one so it is easy to decipher in the helper tab. When these names and IP's are given, the bridge will be able to control the devices or scenes by the call it receives and send it to the target Vera and devce/scene you configure. 
+Provide IP Addresses of your Veras that you want to utilize with the bridge. Also, give a meaningful name to each one so it is easy to decipher in the helper tab. When these names and IP's are given, the bridge will be able to control the devices or scenes by the call it receives and send it to the target Vera and device/scene you configure. 
 #### Harmony Names and IP Addresses
 Provide IP Addresses of your Harmony Hubs that you want to utilize with the bridge. Also, give a meaningful name to each one so it is easy to decipher in the helper tab. When these names and IP's are given, the bridge will be able to control the activity or buttons by the call it receives and send it to the target Harmony Hub and activity/button you configure. 
 #### Harmony Username
@@ -120,6 +120,10 @@ The password for the user name of the MyHarmony.com account for the Harmony Hub.
 Provide IP Addresses of your Hue Bridges that you want to proxy through the bridge. Also, give a meaningful name to each one so it is easy to decipher in the helper tab. When these names and IP's are given, the bridge will passthru the call it receives to the target Hue and device you configure.
 
 Don't forget - You will need to push the link button when you got to the Hue Tab the first time ater the process comes up.  (The user name is not persistent when the process comes up.)
+#### HAL Names and IP Addresses
+Provide IP Addresses of your HAL Systems that you want to utilize with the bridge. Also, give a meaningful name to each one so it is easy to decipher in the helper tab. When these names and IP's are given, the bridge will be able to control the devices or scenes by the call it receives and send it to the target HAL and device/scene you configure. 
+#### HAL Token
+The token you generate or give to a HAL and must be the same for all HAL's you have identified. This needs to be given if you are using the HAL features.
 #### Nest Username
 The user name of the home.nest.com account for the Nest user. This needs to be given if you are using the Nest features. There is no need to give any ip address or host information as this contacts your cloud account.
 #### Nest Password

pom.xml

@@ -5,7 +5,7 @@
 
 	<groupId>com.bwssystems.HABridge</groupId>
 	<artifactId>ha-bridge</artifactId>
-	<version>2.0.7</version>
+	<version>3.0.0</version>
 	<packaging>jar</packaging>
 
 	<name>HA Bridge</name>
@@ -89,18 +89,8 @@
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
-            <version>2.2.4</version>
+            <version>2.6.2</version>
         </dependency>
-        <dependency>
-            <groupId>com.fasterxml.jackson.core</groupId>
-            <artifactId>jackson-databind</artifactId>
-            <version>2.6.0</version>
-        </dependency>
-		<dependency>
-		  <groupId>com.cedarsoftware</groupId>
-		  <artifactId>json-io</artifactId>
-		  <version>4.1.6</version>
-		</dependency>
 		<dependency>
 		  <groupId>net.java.dev.eval</groupId>
 		  <artifactId>eval</artifactId>

src/main/java/com/bwssystems/HABridge/BridgeSettings.java

@@ -20,6 +20,7 @@
 import com.google.gson.Gson;
 
 public class BridgeSettings extends BackupHandler {
+	private static final Logger log = LoggerFactory.getLogger(BridgeSettings.class);
 	private BridgeSettingsDescriptor theBridgeSettings;
 	private BridgeControlDescriptor bridgeControl;
 
@@ -35,7 +36,6 @@ public BridgeSettingsDescriptor getBridgeSettingsDescriptor() {
 		return theBridgeSettings;
 	}
 	public void buildSettings() {
-        Logger log = LoggerFactory.getLogger(BridgeSettings.class);
         InetAddress address = null;
         String addressString = null;
         String theVeraAddress = null;
@@ -146,15 +146,22 @@ public void buildSettings() {
         	theBridgeSettings.setUpnpDeviceDb(Configuration.DEVICE_DB_DIRECTORY);
 
         if(theBridgeSettings.getNumberoflogmessages() == null)
-        	theBridgeSettings.setNumberoflogmessages(Configuration.NUMBER_OF_LOG_MESSAGES);
+        	theBridgeSettings.setNumberoflogmessages(new Integer(Configuration.NUMBER_OF_LOG_MESSAGES));
+
+        if(theBridgeSettings.getNumberoflogmessages() <= 0)
+        	theBridgeSettings.setNumberoflogmessages(new Integer(Configuration.NUMBER_OF_LOG_MESSAGES));
+
+        if(theBridgeSettings.getButtonsleep() == null)
+        	theBridgeSettings.setButtonsleep(Integer.parseInt(Configuration.DEFAULT_BUTTON_SLEEP));
 
-        if(theBridgeSettings.getButtonsleep() <= 0)
+        if(theBridgeSettings.getButtonsleep() < 0)
         	theBridgeSettings.setButtonsleep(Integer.parseInt(Configuration.DEFAULT_BUTTON_SLEEP));
 
         theBridgeSettings.setVeraconfigured(theBridgeSettings.isValidVera());
         theBridgeSettings.setHarmonyconfigured(theBridgeSettings.isValidHarmony());
         theBridgeSettings.setNestConfigured(theBridgeSettings.isValidNest());
         theBridgeSettings.setHueconfigured(theBridgeSettings.isValidHue());
+        theBridgeSettings.setHalconfigured(theBridgeSettings.isValidHal());
         if(serverPortOverride != null)
         	theBridgeSettings.setServerPort(serverPortOverride);
 		setupParams(Paths.get(theBridgeSettings.getConfigfile()), ".cfgbk", "habridge.config-");
@@ -171,31 +178,17 @@ private void _loadConfig() {
 
 	private void _loadConfig(Path aPath) {
 		String jsonContent = configReader(aPath);
-		BridgeSettingsDescriptor aBridgeSettings = new Gson().fromJson(jsonContent, BridgeSettingsDescriptor.class);
-		theBridgeSettings.setButtonsleep(aBridgeSettings.getButtonsleep());
-		theBridgeSettings.setUpnpConfigAddress(aBridgeSettings.getUpnpConfigAddress());
-		theBridgeSettings.setServerPort(aBridgeSettings.getServerPort());
-		theBridgeSettings.setUpnpResponsePort(aBridgeSettings.getUpnpResponsePort());
-		theBridgeSettings.setUpnpDeviceDb(aBridgeSettings.getUpnpDeviceDb());
-		theBridgeSettings.setVeraAddress(aBridgeSettings.getVeraAddress());
-		theBridgeSettings.setHarmonyAddress(aBridgeSettings.getHarmonyAddress());
-		theBridgeSettings.setHarmonyUser(aBridgeSettings.getHarmonyUser());
-		theBridgeSettings.setHarmonyPwd(aBridgeSettings.getHarmonyPwd());
-		theBridgeSettings.setUpnpStrict(aBridgeSettings.isUpnpStrict());
-		theBridgeSettings.setTraceupnp(aBridgeSettings.isTraceupnp());
-		theBridgeSettings.setNestuser(aBridgeSettings.getNestuser());
-		theBridgeSettings.setNestpwd(aBridgeSettings.getNestpwd());
-		theBridgeSettings.setVeraconfigured(aBridgeSettings.isValidVera());
-		theBridgeSettings.setHarmonyconfigured(aBridgeSettings.isValidHarmony());
-		theBridgeSettings.setNestConfigured(aBridgeSettings.isValidNest());
-		theBridgeSettings.setNumberoflogmessages(aBridgeSettings.getNumberoflogmessages());
-		theBridgeSettings.setFarenheit(aBridgeSettings.isFarenheit());
-		theBridgeSettings.setHueaddress(aBridgeSettings.getHueaddress());
-		theBridgeSettings.setHueconfigured(aBridgeSettings.isValidHue());
+		try {
+		theBridgeSettings = new Gson().fromJson(jsonContent, BridgeSettingsDescriptor.class);
+		} catch (Exception e) {
+			log.warn("Issue loading values from file: " + aPath.toUri().toString() + ", Gson convert failed.");
+			theBridgeSettings = new BridgeSettingsDescriptor();
+			theBridgeSettings.setConfigfile(aPath.toString());
+		}
+		
     }
 
 	public void save(BridgeSettingsDescriptor newBridgeSettings) {
-        Logger log = LoggerFactory.getLogger(BridgeSettings.class);
         log.debug("Save HA Bridge settings.");
 		Path configPath = Paths.get(theBridgeSettings.getConfigfile());
     	JsonTransformer aRenderer = new JsonTransformer();
@@ -206,7 +199,6 @@ public void save(BridgeSettingsDescriptor newBridgeSettings) {
 
 
 	private void configWriter(String content, Path filePath) {
-        Logger log = LoggerFactory.getLogger(BridgeSettings.class);
 		if(Files.exists(filePath) && !Files.isWritable(filePath)){
 			log.error("Error file is not writable: " + filePath);
 			return;
@@ -235,8 +227,6 @@ private void configWriter(String content, Path filePath) {
 	}
 
 	private String configReader(Path filePath) {
-        Logger log = LoggerFactory.getLogger(BridgeSettings.class);
-
 		String content = null;
 		if(Files.notExists(filePath) || !Files.isReadable(filePath)){
 			log.warn("Error reading the file: " + filePath + " - Does not exist or is not readable. continuing...");

src/main/java/com/bwssystems/HABridge/BridgeSettingsDescriptor.java

@@ -1,6 +1,9 @@
 package com.bwssystems.HABridge;
 
 import java.util.List;
+import java.util.Map;
+
+import com.bwssystems.HABridge.api.hue.WhitelistEntry;
 
 public class BridgeSettingsDescriptor {
 	private String upnpconfigaddress;
@@ -24,6 +27,11 @@ public class BridgeSettingsDescriptor {
 	private Integer numberoflogmessages;
 	private IpList hueaddress;
 	private boolean hueconfigured;
+	private IpList haladdress;
+	private String haltoken;
+	private boolean halconfigured;
+	private Map<String, WhitelistEntry> whitelist;
+	private boolean settingsChanged;
 
 	public BridgeSettingsDescriptor() {
 		super();
@@ -33,7 +41,10 @@ public BridgeSettingsDescriptor() {
 		this.veraconfigured = false;
 		this.harmonyconfigured = false;
 		this.hueconfigured = false;
+		this.halconfigured = false;
 		this.farenheit = true;
+		this.whitelist = null;
+		this.settingsChanged = false;
 	}
 	public String getUpnpConfigAddress() {
 		return upnpconfigaddress;
@@ -167,6 +178,36 @@ public boolean isHueconfigured() {
 	public void setHueconfigured(boolean hueconfigured) {
 		this.hueconfigured = hueconfigured;
 	}
+	public IpList getHaladdress() {
+		return haladdress;
+	}
+	public void setHaladdress(IpList haladdress) {
+		this.haladdress = haladdress;
+	}
+	public String getHaltoken() {
+		return haltoken;
+	}
+	public void setHaltoken(String haltoken) {
+		this.haltoken = haltoken;
+	}
+	public boolean isHalconfigured() {
+		return halconfigured;
+	}
+	public void setHalconfigured(boolean halconfigured) {
+		this.halconfigured = halconfigured;
+	}
+	public Map<String, WhitelistEntry> getWhitelist() {
+		return whitelist;
+	}
+	public void setWhitelist(Map<String, WhitelistEntry> whitelist) {
+		this.whitelist = whitelist;
+	}
+	public boolean isSettingsChanged() {
+		return settingsChanged;
+	}
+	public void setSettingsChanged(boolean settingsChanged) {
+		this.settingsChanged = settingsChanged;
+	}
 	public Boolean isValidVera() {
 		if(this.getVeraAddress() == null || this.getVeraAddress().getDevices().size() <= 0)
 			return false;
@@ -202,4 +243,14 @@ public Boolean isValidHue() {
 			return false;
 		return true;
 	}
+	public Boolean isValidHal() {
+		if(this.getHaladdress() == null || this.getHaladdress().getDevices().size() <= 0)
+			return false;		
+		List<NamedIP> devicesList = this.getHaladdress().getDevices();
+		if(devicesList.get(0).getIp().contains(Configuration.DEFAULT_ADDRESS))
+			return false;
+		if(this.getHaltoken() == null || this.getHaltoken().equals(""))
+			return false;
+		return true;
+	}
 }

src/main/java/com/bwssystems/HABridge/HABridge.java

@@ -10,6 +10,7 @@
 import com.bwssystems.HABridge.upnp.UpnpListener;
 import com.bwssystems.HABridge.upnp.UpnpSettingsResource;
 import com.bwssystems.NestBridge.NestHome;
+import com.bwssystems.hal.HalHome;
 import com.bwssystems.harmony.HarmonyHome;
 import com.bwssystems.hue.HueHome;
 
@@ -36,6 +37,7 @@ public static void main(String[] args) {
         HarmonyHome harmonyHome;
         NestHome nestHome;
         HueHome hueHome;
+        HalHome halHome;
         HueMulator theHueMulator;
         UpnpSettingsResource theSettingResponder;
         UpnpListener theUpnpListener;
@@ -66,8 +68,10 @@ public static void main(String[] args) {
 	        nestHome = new NestHome(bridgeSettings.getBridgeSettingsDescriptor());
 	        //setup the hue passtrhu configuration if available
 	        hueHome = new HueHome(bridgeSettings.getBridgeSettingsDescriptor());
+	        //setup the hal configuration if available
+	        halHome = new HalHome(bridgeSettings.getBridgeSettingsDescriptor());
 	        // setup the class to handle the resource setup rest api
-	        theResources = new DeviceResource(bridgeSettings.getBridgeSettingsDescriptor(), harmonyHome, nestHome, hueHome);
+	        theResources = new DeviceResource(bridgeSettings.getBridgeSettingsDescriptor(), harmonyHome, nestHome, hueHome, halHome);
 	        // setup the class to handle the hue emulator rest api
 	        theHueMulator = new HueMulator(bridgeSettings.getBridgeSettingsDescriptor(), theResources.getDeviceRepository(), harmonyHome, nestHome, hueHome);
 	        theHueMulator.setupServer();
@@ -83,7 +87,8 @@ public static void main(String[] args) {
 	        	log.info("HA Bridge (v" + theVersion.getVersion() + ") reinitialization requessted....");
 	        else
 	        	bridgeSettings.getBridgeControl().setStop(true);
-
+	        if(bridgeSettings.getBridgeSettingsDescriptor().isSettingsChanged())
+	        	bridgeSettings.save(bridgeSettings.getBridgeSettingsDescriptor());
 	        bridgeSettings.getBridgeControl().setReinit(false);
 	        stop();
 	        nestHome.closeTheNest();

src/main/java/com/bwssystems/HABridge/api/hue/DeviceResponse.java

@@ -11,6 +11,7 @@ public class DeviceResponse {
     private String name;
     private String modelid;
     private String manufacturername;
+    private String luminaireuniqueid;
     private String uniqueid;
     private String swversion;
 
@@ -70,7 +71,15 @@ public void setSwversion(String swversion) {
         this.swversion = swversion;
     }
 
-    public static DeviceResponse createResponse(DeviceDescriptor device){
+    public String getLuminaireuniqueid() {
+		return luminaireuniqueid;
+	}
+
+	public void setLuminaireuniqueid(String luminaireuniqueid) {
+		this.luminaireuniqueid = luminaireuniqueid;
+	}
+
+	public static DeviceResponse createResponse(DeviceDescriptor device){
         DeviceResponse response = new DeviceResponse();
         response.setState(device.getDeviceState());
 
@@ -80,6 +89,7 @@ public static DeviceResponse createResponse(DeviceDescriptor device){
         response.setType("Dimmable light");
         response.setModelid("LWB004");
         response.setSwversion("66012040");
+        response.setLuminaireuniqueid(null);
 
         return response;
     }

src/main/java/com/bwssystems/HABridge/api/hue/DeviceTypes.java

@@ -0,0 +1,18 @@
+package com.bwssystems.HABridge.api.hue;
+
+public class DeviceTypes {
+	private Boolean bridge;
+	private String[] lights;
+	public Boolean getBridge() {
+		return bridge;
+	}
+	public void setBridge(Boolean bridge) {
+		this.bridge = bridge;
+	}
+	public String[] getLights() {
+		return lights;
+	}
+	public void setLights(String[] lights) {
+		this.lights = lights;
+	}
+}

src/main/java/com/bwssystems/HABridge/api/hue/GroupResponse.java

@@ -0,0 +1,33 @@
+package com.bwssystems.HABridge.api.hue;
+
+public class GroupResponse {
+	private DeviceState action;
+	private String[] lights;
+	private String name;
+	public DeviceState getAction() {
+		return action;
+	}
+	public void setAction(DeviceState action) {
+		this.action = action;
+	}
+	public String[] getLights() {
+		return lights;
+	}
+	public void setLights(String[] lights) {
+		this.lights = lights;
+	}
+	public String getName() {
+		return name;
+	}
+	public void setName(String name) {
+		this.name = name;
+	}
+	
+	 public static GroupResponse createGroupResponse(String[] theLights) {
+		 GroupResponse theResponse = new GroupResponse();
+		 theResponse.setAction(DeviceState.createDeviceState());
+		 theResponse.setName("Lightset 0");
+		 theResponse.setLights(theLights);
+		 return theResponse;
+	 }
+}