Merge pull request #258 from stipus/master

HomeSeer.js - Added thermostat support

platforms/HomeSeer.js

@@ -2,8 +2,15 @@
 
 //
 // HomeSeer Platform Shim for HomeBridge
-// V0.1 - Jean-Michel Joudrier (stipus at stipus dot com) - 2015/10/07 - Initial version
+// V0.1 - Jean-Michel Joudrier (stipus at stipus dot com) - 2015/10/07
-// V0.2 - Jean-Michel Joudrier (stipus at stipus dot com) - 2015/10/10 - occupancy sensor fix
+// - Initial version
+// V0.2 - Jean-Michel Joudrier (stipus at stipus dot com) - 2015/10/10
+// - Occupancy sensor fix
+// V0.3 - Jean-Michel Joudrier (stipus at stipus dot com) - 2015/10/11
+// - Added TemperatureUnit=F|C option to temperature sensors
+// - Added negative temperature support to temperature sensors
+// V0.4 - Jean-Michel Joudrier (stipus at stipus dot com) - 2015/10/12
+// - Added thermostat support
 //
 //
 // Remember to add platform to config.json. 
@@ -14,24 +21,50 @@
 // Example:
 // "platforms": [
 //     {
-//         "platform": "HomeSeer",         // required
+//         "platform": "HomeSeer",              // Required
-//         "name": "HomeSeer",             // required
+//         "name": "HomeSeer",                  // Required
-//         "url": "http://192.168.3.4:81", // required
+//         "host": "http://192.168.3.4:81",     // Required - If you did setup HomeSeer authentication, use "http://user:password@ip_address:port"
 //         "accessories":[
 //            {
-//              "ref":8,                   // required - HomeSeer Device Reference (To get it, select the HS Device - then Advanced Tab) 
+//              "ref":8,                        // Required - HomeSeer Device Reference (To get it, select the HS Device - then Advanced Tab) 
-//              "type":"Lightbulb",        // Optional - Lightbulb is the default
+//              "type":"Lightbulb",             // Optional - Lightbulb is the default
-//              "name":"My Light",         // Optional - HomeSeer device name is the default
+//              "name":"My Light",              // Optional - HomeSeer device name is the default
-//              "offValue":"0",            // Optional - 0 is the default
+//              "offValue":"0",                 // Optional - 0 is the default
-//              "onValue":"100",           // Optional - 100 is the default
+//              "onValue":"100",                // Optional - 100 is the default
-//              "can_dim":true             // Optional - true is the default - false for a non dimmable lightbulb
+//              "can_dim":true                  // Optional - true is the default - false for a non dimmable lightbulb
 //            },
 //            {
-//              "ref":9                    // This is a dimmable Lightbulb by default
+//              "ref":9                         // This is a dimmable Lightbulb by default
 //            },
 //            {
-//              "ref":58,                  // This is an controllable outlet
+//              "ref":58,                       // This is an controllable outlet
 //              "type":"Outlet"
+//            },
+//            {
+//              "ref":111,
+//              "type":"TemperatureSensor",     // Required for a temperature sensor
+//              "temperatureUnit":"F",          // Optional - C is the default
+//              "name":"Bedroom temp"           // Optional - HomeSeer device name is the default
+//            },
+//            {
+//              "ref":113,                      // Required - HomeSeer Device Reference of the Current Temperature Device
+//              "type":"Thermostat",            // Required for a Thermostat
+//              "name":"Température Salon",     // Optional - HomeSeer device name is the default
+//              "temperatureUnit":"C",          // Optional - F for Fahrenheit, C for Celsius, C is the default
+//              "setPointRef":167,              // Required - HomeSeer device reference for your thermostat Set Point.
+//              "setPointReadOnly":true,        // Optional - Set to false if your SetPoint is read/write. true is the default
+//              "stateRef":166,                 // Required - HomeSeer device reference for your thermostat current state
+//              "stateOffValues":[0,4,5],       // Required - List of the HomeSeer device values for a HomeKit state=OFF
+//              "stateHeatValues":[1],          // Required - List of the HomeSeer device values for a HomeKit state=HEAT
+//              "stateCoolValues":[2],          // Required - List of the HomeSeer device values for a HomeKit state=COOL
+//              "stateAutoValues":[3],          // Required - List of the HomeSeer device values for a HomeKit state=AUTO
+//              "controlRef":168,               // Required - HomeSeer device reference for your thermostat mode control (It can be the same as stateRef for some thermostats)
+//              "controlOffValue":0,            // Required - Value for OFF
+//              "controlHeatValue":1,           // Required - Value for HEAT
+//              "controlCoolValue":2,           // Required - Value for COOL
+//              "controlAutoValue":3,           // Required - Value for AUTO
+//              "coolingThresholdRef":169,      // Optional - Not-implemented-yet - HomeSeer device reference for your thermostat cooling threshold
+//              "heatingThresholdRef":170       // Optional - Not-implemented-yet - HomeSeer device reference for your thermostat heating threshold               
 //            }
 //         ]
 //     }
@@ -43,7 +76,8 @@
 // - Fan (onValue, offValue options)
 // - Switch (onValue, offValue options)
 // - Outlet (onValue, offValue options)
-// - TemperatureSensor
+// - TemperatureSensor (temperatureUnit=C|F)
+// - Thermostat (temperatureUnit, setPoint, state, control options)
 // - ContactSensor
 // - MotionSensor
 // - LeakSensor
@@ -89,6 +123,7 @@ HomeSeerPlatform.prototype = {
         var that = this;
         var foundAccessories = [];
         var url = this.config["host"] + "/JSON?request=getstatus&ref=" + refList;
+        
         httpRequest( url, "GET", function(error, response, body) {
             if (error) {
                 this.log('HomeSeer status function failed: %s', error.message);
@@ -115,8 +150,9 @@ function HomeSeerAccessory(log, platformConfig, status ) {
     this.onValue = "100";
     this.offValue = "0";
 
-    this.control_url = platformConfig["host"] + "/JSON?request=controldevicebyvalue&ref=" + this.ref + "&value=";
+    this.access_url = platformConfig["host"] + "/JSON?";
-    this.status_url = platformConfig["host"] + "/JSON?request=getstatus&ref=" + this.ref;
+    this.control_url = this.access_url + "request=controldevicebyvalue&ref=" + this.ref + "&value=";
+    this.status_url = this.access_url + "request=getstatus&ref=" + this.ref;
 
     for( var i=0; i<platformConfig.accessories.length; i++ ) {
         if( platformConfig.accessories[i].ref == this.ref )
@@ -223,6 +259,152 @@ HomeSeerAccessory.prototype = {
         }.bind(this));
     },
 
+    setTemperature: function(temperature, callback) {
+        this.log("Setting temperature to %s", temperature);
+        if( this.config.temperatureUnit == "F" ) {
+            temperature = temperature*9/5+32;
+        }
+
+        var url = this.control_url + temperature;
+        httpRequest(url, 'GET', function(error, response, body) {
+            if (error) {
+                this.log('HomeSeer set temperature function failed: %s', error.message);
+                callback(error);
+            }
+            else {
+                this.log('HomeSeer set temperature function succeeded!');
+                callback();
+            }
+        }.bind(this));
+    },
+
+    getTemperature: function(callback) {
+        var url = this.status_url;
+
+        httpRequest(url, 'GET', function(error, response, body) {
+            if (error) {
+                this.log('HomeSeer get temperature function failed: %s', error.message);
+                callback( error, 0 );
+            }
+            else {
+                var status = JSON.parse( body );
+                var value = status.Devices[0].value;
+	
+                this.log('HomeSeer get temperature function succeeded: value=' + value );
+                if( this.config.temperatureUnit == "F" ) {
+                    value = (value-32)*5/9;
+                }
+                callback( null, value );
+            }
+        }.bind(this));
+    },
+
+    getThermostatCurrentHeatingCoolingState: function(callback) {
+        var ref = this.config.stateRef;
+        var url = this.access_url + "request=getstatus&ref=" + ref;
+
+        httpRequest(url, 'GET', function(error, response, body) {
+            if (error) {
+                this.log('HomeSeer get thermostat current heating cooling state function failed: %s', error.message);
+                callback( error, 0 );
+            }
+            else {
+                var status = JSON.parse( body );
+                var value = status.Devices[0].value;
+	
+                this.log('HomeSeer get thermostat current heating cooling state function succeeded: value=' + value );
+                if( this.config.stateOffValues.indexOf(value) != -1 )
+                    callback( null, 0 );
+                else if( this.config.stateHeatValues.indexOf(value) != -1 )
+                    callback( null, 1 );
+                else if( this.config.stateCoolValues.indexOf(value) != -1 )
+                    callback( null, 2 );
+                else if( this.config.stateAutoValues.indexOf(value) != -1 )
+                    callback( null, 3 );
+                else {
+                    this.log( "Error: value for thermostat current heating cooling state not in offValues, heatValues, coolValues or autoValues" );
+                    callback( null, 0 );                
+                }
+            }
+        }.bind(this));
+    },
+
+    setThermostatCurrentHeatingCoolingState: function(state, callback) {
+        this.log("Setting thermostat current heating cooling state to %s", state);
+
+        var ref = this.config.controlRef;
+        var value = 0;
+        if( state == 0 )
+            value = this.config.controlOffValue;
+        else if( state == 1 )
+            value = this.config.controlHeatValue;
+        else if( state == 2 )
+            value = this.config.controlCoolValue;
+        else if( state == 3 )
+            value = this.config.controlAutoValue;
+
+        var url = this.access_url + "request=controldevicebyvalue&ref=" + ref + "&value=" + value;
+        httpRequest(url, 'GET', function(error, response, body) {
+            if (error) {
+                this.log('HomeSeer set thermostat current heating cooling state function failed: %s', error.message);
+                callback(error);
+            }
+            else {
+                this.log('HomeSeer set thermostat current heating cooling state function succeeded!');
+                callback();
+            }
+        }.bind(this));
+    },
+
+    getThermostatTargetTemperature: function(callback) {
+        var ref = this.config.setPointRef;
+        var url = this.access_url + "request=getstatus&ref=" + ref;
+
+        httpRequest(url, 'GET', function(error, response, body) {
+            if (error) {
+                this.log('HomeSeer get thermostat target temperature function failed: %s', error.message);
+                callback( error, 0 );
+            }
+            else {
+                var status = JSON.parse( body );
+                var value = status.Devices[0].value;
+	
+                this.log('HomeSeer get thermostat target temperature function succeeded: value=' + value );
+                if( this.config.temperatureUnit == "F" ) {
+                    value = (value-32)*5/9;
+                }
+                callback( null, value );
+            }
+        }.bind(this));
+    },
+
+    setThermostatTargetTemperature: function(temperature, callback) {
+        this.log("Setting thermostat target temperature to %s", temperature);
+        if( this.config.temperatureUnit == "F" ) {
+            temperature = temperature*9/5+32;
+        }
+
+        var ref = this.config.setPointRef;
+        var url = this.access_url + "request=controldevicebyvalue&ref=" + ref + "&value=" + temperature;
+        httpRequest(url, 'GET', function(error, response, body) {
+            if (error) {
+                this.log('HomeSeer set thermostat target temperature function failed: %s', error.message);
+                callback(error);
+            }
+            else {
+                this.log('HomeSeer set thermostat target temperature function succeeded!');
+                callback();
+            }
+        }.bind(this));
+    },
+
+    getThermostatTemperatureDisplayUnits: function(callback) {
+        if( this.config.temperatureUnit == "F" )
+            callback( null, 1 );
+        else
+            callback( null, 0 );
+    },
+
     getServices: function() {
         var services = []
 
@@ -283,7 +465,9 @@ HomeSeerAccessory.prototype = {
             var temperatureSensorService = new Service.TemperatureSensor();
             temperatureSensorService
                 .getCharacteristic(Characteristic.CurrentTemperature)
-                .on('get', this.getValue.bind(this));
+                .on('get', this.getTemperature.bind(this));
+            temperatureSensorService
+                .getCharacteristic(Characteristic.CurrentTemperature).setProps( {minValue: -100} );
             services.push( temperatureSensorService );
             break;
             }
@@ -346,6 +530,34 @@ HomeSeerAccessory.prototype = {
             services.push( doorService );
             break;
             }
+        case "Thermostat": {
+            var thermostatService = new Service.Thermostat();
+            thermostatService
+                .getCharacteristic(Characteristic.CurrentTemperature)
+                .on('get', this.getTemperature.bind(this));
+            thermostatService
+                .getCharacteristic(Characteristic.TargetTemperature)
+                .on('get', this.getThermostatTargetTemperature.bind(this));
+            if( this.config.setPointReadOnly === null || this.config.setPointReadOnly === false )
+                thermostatService
+                    .getCharacteristic(Characteristic.TargetTemperature)
+                    .on('set', this.setThermostatTargetTemperature.bind(this));
+            thermostatService
+                .getCharacteristic(Characteristic.CurrentHeatingCoolingState)
+                .on('get', this.getThermostatCurrentHeatingCoolingState.bind(this));
+            thermostatService
+                .getCharacteristic(Characteristic.TargetHeatingCoolingState)
+                .on('get', this.getThermostatCurrentHeatingCoolingState.bind(this));
+            thermostatService
+                .getCharacteristic(Characteristic.TargetHeatingCoolingState)
+                .on('set', this.setThermostatCurrentHeatingCoolingState.bind(this));
+            thermostatService
+                .getCharacteristic(Characteristic.TemperatureDisplayUnits)
+                .on('get', this.getThermostatTemperatureDisplayUnits.bind(this));
+
+            services.push( thermostatService );
+            break;
+            }
         default:{
             var lightbulbService = new Service.Lightbulb();
             lightbulbService