Merge pull request #353 from thkl/master

HomeMatic Platform - new Devices and Bugfixing

platforms/HomeMatic.js

@@ -2,9 +2,25 @@
 //
 // Homematic Platform Shim for HomeBridge 
 // 
+// to add the homematic platform add this to config.json. Example:
+// "platforms": [
+//     {
+//         "platform": "HomeMatic",
+//         "name": "HomeMatic",
+//         "filter_device":[],
+//         "filter_channel":["BidCos-RF.KEQXXXXXXX:4", "BidCos-RF.LEQXXXXXXX:2"],
+//         "outlets":[ "BidCos-RF.KEQXXXXXXX:4","BidCos-RF.IEQXXXXXXX:1"]
+// 
+//     }
+//
 // V0.1 - 2015/10/29
 // - initial version
 // - reintegrated Homematic Platform fork from https://github.com/thkl/homebridge/tree/xmlrpc
+// 2015/10/30 thkl
+// - added Rotary Sensors ; fixed thermostat
+ 
+// ],
+
 
 
 var types = require("hap-nodejs/accessories/types.js");
@@ -292,15 +308,16 @@ HomeMaticPlatform.prototype = {
               // that.log('name', ch.name, ' -> address:', ch.address);
               if ((ch.address !== undefined) && (!isChannelFiltered)) {
 
-                if ((ch.type == "SWITCH") || (ch.type == "BLIND") || (ch.type == "SHUTTER_CONTACT") || (ch.type == "DIMMER") || (ch.type == "CLIMATECONTROL_RT_TRANSCEIVER") ||  (ch.type == "MOTION_DETECTOR") ||  (ch.type == "KEYMATIC")) {
+               
                   // Switch found
                   // Check if marked as Outlet
                   var special = (that.outlets.indexOf(ch.address) > -1) ? "OUTLET" : undefined;
                   var accessory = new HomeMaticGenericChannel(that.log, that, ch.id, ch.name, ch.type, ch.address, special);
+                  if (accessory.sType()!=undefined) {
+                  	// support exists for this channel
                   	that.foundAccessories.push(accessory);
                   }
 
-
               } else {
                 that.log(device.name + " has no address");
               }
@@ -313,7 +330,7 @@ HomeMaticPlatform.prototype = {
         });
 
         /*
-                      				    accessory = new HomeMaticGenericChannel(that.log, that, "1234" , "DummyKM" , "KEYMATIC" , "1234");
+                      				    var accessory = new HomeMaticGenericChannel(that.log, that, "1234" , "DummyKM" , "SMOKE_DETECTOR" , "1234");
         				                that.foundAccessories.push(accessory);
 
                       				    accessory = new HomeMaticGenericChannel(that.log, that, "5678" , "DummyBLIND" , "BLIND" , "5678");
@@ -343,6 +360,12 @@ HomeMaticPlatform.prototype = {
   },
 
 
+  setRegaValue: function(channel, datapoint, value) {
+      var rega = new RegaRequest(this.log, this.ccuIP);
+      rega.setValue(channel, datapoint, value);
+      return;
+  },
+
   getValue: function(channel, datapoint, callback) {
 
     if (channel.indexOf("BidCos-RF.") > -1)  {

platforms/HomematicChannel.js

@@ -1,4 +1,3 @@
-"use strict";
 var types = require("hap-nodejs/accessories/types.js");
 
 
@@ -12,28 +11,38 @@ function HomeMaticGenericChannel(log, platform, id, name, type, adress, special)
   this.eventupdate = false;
   this.special  = special;
   this.currentStateCharacteristic = [];
-  this.reverseDP = [];
+  this.datapointMappings = [];
 }
 
 
 
+
 HomeMaticGenericChannel.prototype = {
 
 
+  addValueMapping: function(dp,value,mappedvalue) {
+    if (this.datapointMappings[dp]==undefined) {
+      this.datapointMappings[dp] = [];
+    }
+    this.datapointMappings[dp][value] = mappedvalue;
+  } ,
+
  // Return current States
   query: function(dp,callback) {
-    if (this.state[dp] !== undefined) {
+    var that = this;
-      callback(this.state[dp]);
+      
+    if (this.state[dp] != undefined) {
+     if (callback!=undefined){callback(this.state[dp]);}
     } else {
 //      that.log("No cached Value found start fetching and send temp 0 back");
       this.remoteGetValue(dp);
-      callback(0);
+      if (callback!=undefined){callback(0);}
     }
 
   },
 
   dpvalue:function(dp,fallback) {
-    if (this.state[dp] !== undefined) {
+    if (this.state[dp] != undefined) {
       return(this.state[dp]);
     } else {
       return fallback;
@@ -62,24 +71,19 @@ HomeMaticGenericChannel.prototype = {
     this.eventupdate = false;
   },
 
-  reverse: function(value) {
-    if (value == "true") return "false";
-    if (value == "false") return "true";
-    if (value === 0) return 1;
-    if (value === 1) return 0;
-    if (value == "0") return "1";
-    if (value == "1") return "0";
-    return value;
-  },
-
   cache:function(dp,value) {
     var that = this;
 
-    if ((that.reverseDP[dp] !== undefined) && (that.reverseDP[dp] === true)) {
+
-      value = that.reverse(value);
+	// Check custom Mapping from HM to HomeKit
+    var map = this.datapointMappings[dp];
+    if (map != undefined) {
+      if (map[value]!=undefined) {
+         value = map[value];
+      }
     }
 	
-    if (that.currentStateCharacteristic[dp] !== undefined) {
+    if (that.currentStateCharacteristic[dp]!=undefined) {
        that.currentStateCharacteristic[dp].updateValue(value, null);
     }
     this.state[dp] = value;
@@ -88,7 +92,7 @@ HomeMaticGenericChannel.prototype = {
 
   delayed: function(mode, dp,value,delay) {
   
-    if (this.eventupdate === true) {
+   if (this.eventupdate==true) {
     return;
    }
    
@@ -99,27 +103,31 @@ HomeMaticGenericChannel.prototype = {
 
     this.log(this.name + " delaying command "+mode + " " + dp +" with value " + value);
     var that = this;
-    this.delayed[delay] = setTimeout(function() {
+    this.delayed[delay] = setTimeout( function(){clearTimeout(that.delayed[delay]);that.command(mode,dp,value)}, delay?delay:100 );
-      clearTimeout(that.delayed[delay]);
-      that.command(mode, dp, value);
-    }, delay ? delay : 100);
   },
 
   command: function(mode,dp,value,callback) {
    
-    if (this.eventupdate === true) {
+   if (this.eventupdate==true) {
     return;
    }
    var that = this;
 
    if (mode == "set") {
-      //this.log("Send " + value + " to Datapoint " + dp + " at " + that.adress);
+        this.log("Send " + value + " to Datapoint " + dp + " at " + that.adress);
 		that.platform.setValue(that.adress,dp,value);
    }
+
+   if (mode == "setrega") {
+        this.log("Send " + value + " to Datapoint " + dp + " at " + that.adress);
+		that.platform.setRegaValue(that.adress,dp,value);
+   }
+
   },
 
   informationCharacteristics: function() {
-    return [{
+    return [
+      {
         cType: types.NAME_CTYPE,
         onUpdate: null,
         perms: ["pr"],
@@ -169,12 +177,13 @@ HomeMaticGenericChannel.prototype = {
         supportBonjour: false,
         manfDescription: "Identify Accessory",
         designedMaxLength: 1
-    }];
+      }
+    ]
   },
 
   controlCharacteristics: function(that) {
    
-    var cTypes = [{
+    cTypes = [{
       cType: types.NAME_CTYPE,
       onUpdate: null,
       perms: ["pr"],
@@ -184,14 +193,14 @@ HomeMaticGenericChannel.prototype = {
       supportBonjour: false,
       manfDescription: "Name of service",
       designedMaxLength: 255
-    }];
+    }]
     
     
     if (this.type=="SWITCH") {
        cTypes.push({
         cType: types.POWER_STATE_CTYPE,
         onUpdate: function(value) {
-          that.command("set", "STATE", (value == 1) ? true : false);
+            that.command("set","STATE" , (value==1)?true:false)
         },
 
         onRead: function(callback) {
@@ -227,13 +236,14 @@ HomeMaticGenericChannel.prototype = {
         supportBonjour: false,
         manfDescription: "Is Outlet in Use",
         designedMaxLength: 1
-        });
+      })
      } 
     }
     
       
      if (this.type=="KEYMATIC") {
-      cTypes.push({
+     cTypes.push(
+      {
         cType: types.CURRENT_LOCK_MECHANISM_STATE_CTYPE,
         
         onRead: function(callback) {
@@ -253,11 +263,12 @@ HomeMaticGenericChannel.prototype = {
         supportBonjour: false,
         manfDescription: "Current State of your Lock",
  		designedMaxLength: 1
-      }, {
+      },
+      {
         cType: types.TARGET_LOCK_MECHANISM_STATE_CTYPE,
         
         onUpdate: function(value) {
-            that.command("set", "STATE", (value == 1) ? "true" : "false");
+            that.command("set","STATE",(value==1)?"true":"false")
         },
         
         onRead: function(callback) {
@@ -265,7 +276,8 @@ HomeMaticGenericChannel.prototype = {
         },
         
         onRegister: function(characteristic) { 
-            that.reverseDP["STATE"] = true;
+            that.addValueMapping("STATE","1",0);
+            that.addValueMapping("STATE","0",1);
             that.currentStateCharacteristic["STATE"] = characteristic;
             characteristic.eventEnabled = true;
             that.remoteGetValue("STATE");
@@ -279,13 +291,14 @@ HomeMaticGenericChannel.prototype = {
         supportBonjour: false,
         manfDescription: "Target State of your Lock",
  		designedMaxLength: 1
-        },
+      }
       
+      ,
       {
         cType: types.TARGET_DOORSTATE_CTYPE,
         
          onUpdate: function(value) {
-            that.command("set", "OPEN", "true");
+            that.command("set","OPEN" , "true")
         },
 
         onRead: function(callback) {
@@ -306,13 +319,17 @@ HomeMaticGenericChannel.prototype = {
  		designedMaxLength: 1
       }      
       );
+      
+      
     }
 
+
+
     if (this.type=="DIMMER") {
      cTypes.push({
         cType: types.POWER_STATE_CTYPE,
         onUpdate: function(value) {
-          that.command("set", "LEVEL", (value == true) ? "1" : "0");
+            that.command("set","LEVEL" , (value==true) ? "1" : "0")
         },
 
         onRead: function(callback) {
@@ -332,7 +349,8 @@ HomeMaticGenericChannel.prototype = {
         supportBonjour: false,
         manfDescription: "Change the power state",
         designedMaxLength: 1
-      }, {
+      },
+      {
         cType: types.BRIGHTNESS_CTYPE,
         onUpdate: function(value) {
           that.delayed("set","LEVEL" , String(value/100),100);
@@ -362,8 +380,11 @@ HomeMaticGenericChannel.prototype = {
       });
     }
 
+
+
     if (this.type=="BLIND") {
-      cTypes.push({
+     cTypes.push(
+      {
         cType: types.WINDOW_COVERING_CURRENT_POSITION_CTYPE,
         
         onRead: function(callback) {
@@ -416,7 +437,8 @@ HomeMaticGenericChannel.prototype = {
         designedMaxValue: 100,
         designedMinStep: 1,
         unit: "%"
-        }, {
+      },
+      {
       cType: types.WINDOW_COVERING_OPERATION_STATE_CTYPE,
         
         onRead: function(callback) {
@@ -443,8 +465,11 @@ HomeMaticGenericChannel.prototype = {
       );
     }
     
+    // Simple Contact (Magnet)
+    
     if (this.type=="SHUTTER_CONTACT") { 
-      cTypes.push({
+	 cTypes.push(
+	 {  
 	 	cType: types.CONTACT_SENSOR_STATE_CTYPE,
             
         onRead: function(callback) {
@@ -466,8 +491,38 @@ HomeMaticGenericChannel.prototype = {
 	 });
 	}
 	
+	// Rotary Handle 
+    if (this.type=="ROTARY_HANDLE_SENSOR") { 
+	 cTypes.push(
+	 {  
+	 	cType: types.CONTACT_SENSOR_STATE_CTYPE,
+            
+        onRead: function(callback) {
+            that.query("STATE",callback);
+        },
+        
+        onRegister: function(characteristic) {  
+            that.addValueMapping("STATE","2",1);
+		    that.currentStateCharacteristic["STATE"] = characteristic;
+            characteristic.eventEnabled = true;
+            that.remoteGetValue("STATE");
+        },
+      
+      perms: ["pr","ev"],
+      format: "bool",
+      initialValue: that.dpvalue("STATE",0),
+      supportEvents: false,
+      supportBonjour: false,
+      manfDescription: "Current State"
+	 });
+	}
+	
+	
+	// Motion Detector
+	
 	if (this.type=="MOTION_DETECTOR") { 
-      cTypes.push({
+	 cTypes.push(
+	 {  
 	 	cType: types.MOTION_DETECTED_CTYPE,
          
         onRead: function(callback) {
@@ -489,47 +544,50 @@ HomeMaticGenericChannel.prototype = {
 	 });
 	}
 	
-    if (this.type == "CLIMATECONTROL_RT_TRANSCEIVER") {
+	// Smoke Detector
+	if (this.type=="SMOKE_DETECTOR") { 
+	 cTypes.push(
+	 {  
+	 	cType: "00000076-0000-1000-8000-0026BB765291",
+         
+        onRead: function(callback) {
+            that.query("STATE",callback);
+        },
+        
+        onRegister: function(characteristic) { 
+            that.currentStateCharacteristic["STATE"] = characteristic;
+            characteristic.eventEnabled = true;
+            that.remoteGetValue("STATE");
+        },
+      
+      perms: ["pr","ev"],
+      format: "bool",
+      initialValue: that.dpvalue("STATE",0),
+      supportEvents: false,
+      supportBonjour: false,
+      manfDescription: "Smoke detected"
+	 });
+	}
+	
+	// Heating Device
+	
+	if ((this.type=="CLIMATECONTROL_RT_TRANSCEIVER") || (this.type=="THERMALCONTROL_TRANSMIT")) {
     
     cTypes.push({
-        cType: types.NAME_CTYPE,
+      cType: types.NAME_CTYPE,onUpdate: null,perms: ["pr"],format: "string",
-        onUpdate: null,
+      initialValue: this.name,supportEvents: true,supportBonjour: false,manfDescription: "Name of service",designedMaxLength: 255
-        perms: ["pr"],
-        format: "string",
-        initialValue: this.name,
-        supportEvents: true,
-        supportBonjour: false,
-        manfDescription: "Name of service",
-        designedMaxLength: 255
     },
 	
 	{
-          cType: types.CURRENTHEATINGCOOLING_CTYPE,
+      cType: types.CURRENTHEATINGCOOLING_CTYPE,onUpdate: null,
-          onUpdate: null,
+      perms: ["pr"],format: "int",initialValue: 1,supportEvents: false,
-          perms: ["pr"],
+      supportBonjour: false,manfDescription: "Current Mode",designedMaxLength: 1,designedMinValue: 1,designedMaxValue: 1,designedMinStep: 1
-          format: "int",
-          initialValue: 1,
-          supportEvents: false,
-          supportBonjour: false,
-          manfDescription: "Current Mode",
-          designedMaxLength: 1,
-          designedMinValue: 1,
-          designedMaxValue: 1,
-          designedMinStep: 1
     },
   
     {
-          cType: types.TARGETHEATINGCOOLING_CTYPE,
+      cType: types.TARGETHEATINGCOOLING_CTYPE,onUpdate: null,perms: ["pw","pr"],
-          onUpdate: null,
+      format: "int",initialValue: 1,supportEvents: false,supportBonjour: false,manfDescription: "Target Mode",
-          perms: ["pw", "pr"],
+      designedMinValue: 1,designedMaxValue: 1,designedMinStep: 1
-          format: "int",
-          initialValue: 1,
-          supportEvents: false,
-          supportBonjour: false,
-          manfDescription: "Target Mode",
-          designedMinValue: 1,
-          designedMaxValue: 1,
-          designedMinStep: 1
     },
     
     {
@@ -545,58 +603,49 @@ HomeMaticGenericChannel.prototype = {
             characteristic.eventEnabled = true;
             that.remoteGetValue("ACTUAL_TEMPERATURE");
       },
-          perms: ["pr", "ev"],
+      perms: ["pw","pr","ev"], perms: ["pr"],format: "double",
-          format: "double",
       initialValue: that.dpvalue("ACTUAL_TEMPERATURE",20),
-          supportEvents: false,
+      supportEvents: false,supportBonjour: false,manfDescription: "Current Temperature",unit: "celsius"
-          supportBonjour: false,
-          manfDescription: "Current Temperature",
-          unit: "celsius"
     },
     
     {
       cType: types.TARGET_TEMPERATURE_CTYPE,
       onUpdate: function(value) {
-            that.delayed("set", "SET_TEMPERATURE", value, 500);
+            if (that.state["CONTROL_MODE"]!=1) {
+              that.delayed("setrega", "MANU_MODE",value,500);
+              that.state["CONTROL_MODE"]=1; // set to Manual Mode
+            } else {
+              that.delayed("setrega", "SET_TEMPERATURE", value,500);
+            }
       },
       onRead: function(callback) {
 			that.query("SET_TEMPERATURE",callback);
+			that.query("CONTROL_MODE",undefined);
 			
       },
       onRegister: function(characteristic) { 
             that.currentStateCharacteristic["SET_TEMPERATURE"] = characteristic;
             characteristic.eventEnabled = true;
             that.remoteGetValue("SET_TEMPERATURE");
+            that.remoteGetValue("CONTROL_MODE");
       },
-          perms: ["pw", "pr", "ev"],
+      perms: ["pw","pr","ev"],format: "double",
-          format: "double",
       initialValue: that.dpvalue("SET_TEMPERATURE",16),
-          supportEvents: false,
+      supportEvents: false,supportBonjour: false, manfDescription: "Target Temperature",
-          supportBonjour: false,
+      designedMinValue: 16,designedMaxValue: 38,designedMinStep: 1,unit: "celsius"
-          manfDescription: "Target Temperature",
-          designedMinValue: 16,
-          designedMaxValue: 38,
-          designedMinStep: 1,
-          unit: "celsius"
     },
     
     {
-          cType: types.TEMPERATURE_UNITS_CTYPE,
+      cType: types.TEMPERATURE_UNITS_CTYPE,onRead: null,
-          onRead: null,
+      perms: ["pr"],format: "int",initialValue: 0,supportEvents: false,
-          perms: ["pr"],
+      supportBonjour: false,manfDescription: "Current Temperature Unit",unit: "celsius"
-          format: "int",
-          initialValue: 0,
-          supportEvents: false,
-          supportBonjour: false,
-          manfDescription: "Current Temperature Unit",
-          unit: "celsius"
     }
 
    );
    }
     
 	
-    return cTypes;
+    return cTypes
   },
 
   sType: function() {
@@ -618,23 +667,26 @@ HomeMaticGenericChannel.prototype = {
       return types.WINDOW_COVERING_STYPE;
 	}
 
-    if (this.type == "CLIMATECONTROL_RT_TRANSCEIVER") {
+    if ((this.type=="CLIMATECONTROL_RT_TRANSCEIVER") || (this.type=="THERMALCONTROL_TRANSMIT")) { 
       return types.THERMOSTAT_STYPE;
 	}
 	
-    if (this.type == "SHUTTER_CONTACT") {
+	if ((this.type=="SHUTTER_CONTACT") || (this.type=="ROTARY_HANDLE_SENSOR")) { 
       return types.CONTACT_SENSOR_STYPE;
 	}
 		
 	if (this.type=="MOTION_DETECTOR") {
-      return types.MOTION_SENSOR_STYPE;
+	  return types.MOTION_SENSOR_STYPE
 	}
 
 
 	if (this.type=="KEYMATIC") {
-      return types.LOCK_MECHANISM_STYPE;
+	  return types.LOCK_MECHANISM_STYPE
 	}
 	
+	if (this.type=="SMOKE_DETECTOR") {
+	  return "00000087-0000-1000-8000-0026BB765291";
+	}
 	
 	
   },
@@ -643,12 +695,13 @@ HomeMaticGenericChannel.prototype = {
     var that = this;
     var services = [{
       sType: types.ACCESSORY_INFORMATION_STYPE,
-      characteristics: this.informationCharacteristics()
+      characteristics: this.informationCharacteristics(),
-    }, {
+    },
+    {
       sType: this.sType(),
       characteristics: this.controlCharacteristics(that)
     }];
-    this.log("Loaded services for " + this.name);
+    this.log("Loaded services for " + this.name)
     return services;
   }
 };