mtan93/homebridge
1
0
Fork 0
mirror of https://github.com/mtan93/homebridge.git synced 2026-03-28 21:03:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Return value guarding; Cleaner logs

Browse Source
This commit is contained in:
Snowdd1
2015-09-30 22:07:33 +02:00
parent bd979ea1f8
commit 98ee9f8f95
2 changed files with 108 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
accessories/knxdevice.js
View File

@@ -159,7 +159,7 @@ KNXDevice.prototype = {
knxregister_bool: function(addresses, characteristic) { knxregister_bool: function(addresses, characteristic) {
this.log("knx registering BOOLEAN " + addresses); this.log("knx registering BOOLEAN " + addresses);
knxd_registerGA(addresses, function(val, src, dest, type){ knxd_registerGA(addresses, function(val, src, dest, type){
this.log("Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type + " for " + characteristic.displayName); this.log("[" +this.name + "]: Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type + " for " + characteristic.displayName);
// iterate(characteristic); // iterate(characteristic);
characteristic.setValue(val ? 1 : 0, undefined, 'fromKNXBus'); characteristic.setValue(val ? 1 : 0, undefined, 'fromKNXBus');
}.bind(this)); }.bind(this));
@@ -167,7 +167,7 @@ KNXDevice.prototype = {
knxregister_boolReverse: function(addresses, characteristic) { knxregister_boolReverse: function(addresses, characteristic) {
this.log("knx registering BOOLEAN " + addresses); this.log("knx registering BOOLEAN " + addresses);
knxd_registerGA(addresses, function(val, src, dest, type){ knxd_registerGA(addresses, function(val, src, dest, type){
this.log("Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type + " for " + characteristic.displayName); this.log("[" +this.name + "]: Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type + " for " + characteristic.displayName);
// iterate(characteristic); // iterate(characteristic);
characteristic.setValue(val ? 0 : 1, undefined, 'fromKNXBus'); characteristic.setValue(val ? 0 : 1, undefined, 'fromKNXBus');
}.bind(this)); }.bind(this));
@@ -176,19 +176,19 @@ KNXDevice.prototype = {
knxregister_percent: function(addresses, characteristic) { knxregister_percent: function(addresses, characteristic) {
this.log("knx registering PERCENT " + addresses); this.log("knx registering PERCENT " + addresses);
knxd_registerGA(addresses, function(val, src, dest, type){ knxd_registerGA(addresses, function(val, src, dest, type){
this.log("Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName); this.log("[" +this.name + "]: Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName);
if (type !== "DPT5") { if (type !== "DPT5") {
this.log("[ERROR] Received value cannot be a percentage value"); this.log("[ERROR] Received value cannot be a percentage value");
} else { } else {
if (!characteristic.timeout) { // if (!characteristic.timeout) {
if (characteristic.timeout < Date.now()) { // if (characteristic.timeout < Date.now()) {
characteristic.setValue(Math.round(val/255*100), undefined, 'fromKNXBus'); characteristic.setValue(Math.round(val/255*100), undefined, 'fromKNXBus');
} else { // } else {
this.log("Blackout time"); // this.log("Blackout time");
} // }
} else { // } else {
characteristic.setValue(Math.round(val/255*100), undefined, 'fromKNXBus'); // characteristic.setValue(Math.round(val/255*100), undefined, 'fromKNXBus');
} // todo get the boolean logic right into one OR expresssion // } // todo get the boolean logic right into one OR expresssion
} }
}.bind(this)); }.bind(this));
@@ -199,13 +199,13 @@ KNXDevice.prototype = {
var validValue = true; var validValue = true;
var hk_value = 0.0; var hk_value = 0.0;
this.log("knx registering FLOAT " + addresses); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]:knx registering FLOAT " + addresses);
knxd_registerGA(addresses, function(val, src, dest, type){ knxd_registerGA(addresses, function(val, src, dest, type){
this.log("Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]: Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName);
// make hk_value compliant to properties // make hk_value compliant to properties
if (characteristic.props.minStep) { if (characteristic.props.minStep) {
// quantize // quantize
hk_value = Math.round(val/characteristic.props.minStep)*characteristic.props.minStep; hk_value = Math.round(val/characteristic.props.minStep)/(1/characteristic.props.minStep);
} else { } else {
hk_value = val; hk_value = val;
} }
@@ -220,26 +220,26 @@ KNXDevice.prototype = {
if (validValue) { if (validValue) {
characteristic.setValue(hk_value, undefined, 'fromKNXBus'); // 1 decimal for HomeKit characteristic.setValue(hk_value, undefined, 'fromKNXBus'); // 1 decimal for HomeKit
} else { } else {
this.log("Accessory "+ this.name +":" + characteristic.displayName+ ": Value %s out of bounds %s...%s ",hk_value, characteristic.props.minValue, characteristic.props.maxValue); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]: Value %s out of bounds %s...%s ",hk_value, characteristic.props.minValue, characteristic.props.maxValue);
} }
}.bind(this)); }.bind(this));
}, },
//integer //integer
knxregister_int: function(addresses, characteristic) { knxregister_int: function(addresses, characteristic) {
this.log("knx registering INT " + addresses); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]:knx registering INT " + addresses);
knxd_registerGA(addresses, function(val, src, dest, type){ knxd_registerGA(addresses, function(val, src, dest, type){
this.log("Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]: Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName);
if (val>=(characteristic.props.minValue || 0) && val<=(characteristic.props.maxValue || 255)) { if (val>=(characteristic.props.minValue || 0) && val<=(characteristic.props.maxValue || 255)) {
characteristic.setValue(val, undefined, 'fromKNXBus'); characteristic.setValue(val, undefined, 'fromKNXBus');
} else { } else {
this.log("Accessory "+ this.name +":" + characteristic.displayName+ ": Value %s out of bounds %s...%s ",hk_value, (characteristic.props.minValue || 0), (characteristic.props.maxValue || 255)); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]: Value %s out of bounds %s...%s ",hk_value, (characteristic.props.minValue || 0), (characteristic.props.maxValue || 255));
} }
}.bind(this)); }.bind(this));
}, },
knxregister_HVAC: function(addresses, characteristic) { knxregister_HVAC: function(addresses, characteristic) {
this.log("knx registering HVAC " + addresses); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]:knx registering HVAC " + addresses);
knxd_registerGA(addresses, function(val, src, dest, type){ knxd_registerGA(addresses, function(val, src, dest, type){
this.log("Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]:Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName);
var HAPvalue = 0; var HAPvalue = 0;
switch (val){ switch (val){
case 0: case 0:
@@ -279,9 +279,9 @@ KNXDevice.prototype = {
*/ */
// undefined, has to match! // undefined, has to match!
knxregister: function(addresses, characteristic) { knxregister: function(addresses, characteristic) {
this.log("knx registering " + addresses); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]:knx registering " + addresses);
knxd_registerGA(addresses, function(val, src, dest, type){ knxd_registerGA(addresses, function(val, src, dest, type){
this.log("Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName); this.log("["+ this.name +"]:[" + characteristic.displayName+ "]:Received value from bus:"+val+ " for " +dest+ " from "+src+" of type "+type+ " for " + characteristic.displayName);
characteristic.setValue(val, undefined, 'fromKNXBus'); characteristic.setValue(val, undefined, 'fromKNXBus');
}.bind(this)); }.bind(this));
}, },
@@ -296,7 +296,7 @@ KNXDevice.prototype = {
*/ */
setBooleanState: function(value, callback, context, gaddress) { setBooleanState: function(value, callback, context, gaddress) {
if (context === 'fromKNXBus') { if (context === 'fromKNXBus') {
this.log(gaddress + " event ping pong, exit!"); // this.log(gaddress + " event ping pong, exit!");
if (callback) { if (callback) {
callback(); callback();
} }
@@ -305,14 +305,14 @@ KNXDevice.prototype = {
if (value) { if (value) {
numericValue = 1; // need 0 or 1, not true or something numericValue = 1; // need 0 or 1, not true or something
} }
this.log("Setting "+gaddress+" Boolean to %s", numericValue); this.log("["+ this.name +"]:Setting "+gaddress+" Boolean to %s", numericValue);
this.knxwrite(callback, gaddress,'DPT1',numericValue); this.knxwrite(callback, gaddress,'DPT1',numericValue);
} }
}, },
setBooleanReverseState: function(value, callback, context, gaddress) { setBooleanReverseState: function(value, callback, context, gaddress) {
if (context === 'fromKNXBus') { if (context === 'fromKNXBus') {
this.log(gaddress + " event ping pong, exit!"); // this.log(gaddress + " event ping pong, exit!");
if (callback) { if (callback) {
callback(); callback();
} }
@@ -321,14 +321,14 @@ KNXDevice.prototype = {
if (!value) { if (!value) {
numericValue = 1; // need 0 or 1, not true or something numericValue = 1; // need 0 or 1, not true or something
} }
this.log("Setting "+gaddress+" Boolean to %s", numericValue); this.log("["+ this.name +"]:Setting "+gaddress+" Boolean to %s", numericValue);
this.knxwrite(callback, gaddress,'DPT1',numericValue); this.knxwrite(callback, gaddress,'DPT1',numericValue);
} }
}, },
setPercentage: function(value, callback, context, gaddress) { setPercentage: function(value, callback, context, gaddress) {
if (context === 'fromKNXBus') { if (context === 'fromKNXBus') {
this.log("event ping pong, exit!"); // this.log(gaddress + "event ping pong, exit!");
if (callback) { if (callback) {
callback(); callback();
} }
@@ -337,13 +337,13 @@ KNXDevice.prototype = {
if (value) { if (value) {
numericValue = Math.round(255*value/100); // convert 1..100 to 1..255 for KNX bus numericValue = Math.round(255*value/100); // convert 1..100 to 1..255 for KNX bus
} }
this.log("Setting "+gaddress+" percentage to %s (%s)", value, numericValue); this.log("["+ this.name +"]:Setting "+gaddress+" percentage to %s (%s)", value, numericValue);
this.knxwrite(callback, gaddress,'DPT5',numericValue); this.knxwrite(callback, gaddress,'DPT5',numericValue);
} }
}, },
setInt: function(value, callback, context, gaddress) { setInt: function(value, callback, context, gaddress) {
if (context === 'fromKNXBus') { if (context === 'fromKNXBus') {
this.log("event ping pong, exit!"); // this.log(gaddress + "event ping pong, exit!");
if (callback) { if (callback) {
callback(); callback();
} }
@@ -352,13 +352,13 @@ KNXDevice.prototype = {
if (value && value>=0 && value<=255) { if (value && value>=0 && value<=255) {
numericValue = value; // assure 1..255 for KNX bus numericValue = value; // assure 1..255 for KNX bus
} }
this.log("Setting "+gaddress+" int to %s (%s)", value, numericValue); this.log("["+ this.name +"]:Setting "+gaddress+" int to %s (%s)", value, numericValue);
this.knxwrite(callback, gaddress,'DPT5',numericValue); this.knxwrite(callback, gaddress,'DPT5',numericValue);
} }
}, },
setFloat: function(value, callback, context, gaddress) { setFloat: function(value, callback, context, gaddress) {
if (context === 'fromKNXBus') { if (context === 'fromKNXBus') {
this.log(gaddress + " event ping pong, exit!"); // this.log(gaddress + " event ping pong, exit!");
if (callback) { if (callback) {
callback(); callback();
} }
@@ -367,13 +367,13 @@ KNXDevice.prototype = {
if (value) { if (value) {
numericValue = value; // homekit expects precision of 1 decimal numericValue = value; // homekit expects precision of 1 decimal
} }
this.log("Setting "+gaddress+" Float to %s", numericValue); this.log("["+ this.name +"]:Setting "+gaddress+" Float to %s", numericValue);
this.knxwrite(callback, gaddress,'DPT9',numericValue); this.knxwrite(callback, gaddress,'DPT9',numericValue);
} }
}, },
setHVACState: function(value, callback, context, gaddress) { setHVACState: function(value, callback, context, gaddress) {
if (context === 'fromKNXBus') { if (context === 'fromKNXBus') {
this.log(gaddress + " event ping pong, exit!"); // this.log(gaddress + " event ping pong, exit!");
if (callback) { if (callback) {
callback(); callback();
} }
@@ -396,7 +396,7 @@ KNXDevice.prototype = {
KNXvalue = 1; KNXvalue = 1;
} }
this.log("Setting "+gaddress+" HVAC to %s", KNXvalue); this.log("["+ this.name +"]:Setting "+gaddress+" HVAC to %s", KNXvalue);
this.knxwrite(callback, gaddress,'DPT5',KNXvalue); this.knxwrite(callback, gaddress,'DPT5',KNXvalue);
} }
@@ -405,7 +405,7 @@ KNXDevice.prototype = {
* *
*/ */
identify: function(callback) { identify: function(callback) {
this.log("Identify requested!"); this.log("["+ this.name +"]:Identify requested!");
callback(); // success callback(); // success
}, },
/** bindCharacteristic /** bindCharacteristic
@@ -479,10 +479,10 @@ KNXDevice.prototype = {
this.knxregister_HVAC([config.Set].concat(config.Listen || []), myCharacteristic); this.knxregister_HVAC([config.Set].concat(config.Listen || []), myCharacteristic);
break; break;
default: default:
this.log("[ERROR] unknown type passed"); this.log("[ERROR] unknown type passed: ["+valueType+"]");
throw new Error("[ERROR] unknown type passed"); throw new Error("[ERROR] unknown type passed");
} }
this.log("Issuing read requests on the KNX bus..."); this.log("["+ this.name +"]:["+myCharacteristic.displayName+"]: Issuing read requests on the KNX bus...");
this.knxreadarray([config.Set].concat(config.Listen || [])); this.knxreadarray([config.Set].concat(config.Listen || []));
} }
return myCharacteristic; // for chaining or whatsoever return myCharacteristic; // for chaining or whatsoever
@@ -512,30 +512,30 @@ KNXDevice.prototype = {
var myService = new Service.ContactSensor(config.name,config.name); var myService = new Service.ContactSensor(config.name,config.name);
if (config.ContactSensorState) { if (config.ContactSensorState) {
this.log("ContactSensor ContactSensorState characteristic enabled"); this.log("["+ this.name +"]:ContactSensor ContactSensorState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.ContactSensorState, "Bool", config.ContactSensorState); this.bindCharacteristic(myService, Characteristic.ContactSensorState, "Bool", config.ContactSensorState);
} else if (config.ContactSensorStateContact1) { } else if (config.ContactSensorStateContact1) {
this.log("ContactSensor ContactSensorStateContact1 characteristic enabled"); this.log("["+ this.name +"]:ContactSensor ContactSensorStateContact1 characteristic enabled");
this.bindCharacteristic(myService, Characteristic.ContactSensorState, "BoolReverse", config.ContactSensorStateContact1); this.bindCharacteristic(myService, Characteristic.ContactSensorState, "BoolReverse", config.ContactSensorStateContact1);
} }
//optionals //optionals
if (config.StatusActive) { if (config.StatusActive) {
this.log("ContactSensor StatusActive characteristic enabled"); this.log("["+ this.name +"]:ContactSensor StatusActive characteristic enabled");
myService.addCharacteristic(Characteristic.StatusActive); myService.addCharacteristic(Characteristic.StatusActive);
this.bindCharacteristic(myService, Characteristic.StatusActive, "Bool", config.StatusActive); this.bindCharacteristic(myService, Characteristic.StatusActive, "Bool", config.StatusActive);
} }
if (config.StatusFault) { if (config.StatusFault) {
this.log("ContactSensor StatusFault characteristic enabled"); this.log("["+ this.name +"]:ContactSensor StatusFault characteristic enabled");
myService.addCharacteristic(Characteristic.StatusFault); myService.addCharacteristic(Characteristic.StatusFault);
this.bindCharacteristic(myService, Characteristic.StatusFault, "Bool", config.StatusFault); this.bindCharacteristic(myService, Characteristic.StatusFault, "Bool", config.StatusFault);
} }
if (config.StatusTampered) { if (config.StatusTampered) {
this.log("ContactSensor StatusTampered characteristic enabled"); this.log("["+ this.name +"]:ContactSensor StatusTampered characteristic enabled");
myService.addCharacteristic(Characteristic.StatusTampered); myService.addCharacteristic(Characteristic.StatusTampered);
this.bindCharacteristic(myService, Characteristic.StatusTampered, "Bool", config.StatusTampered); this.bindCharacteristic(myService, Characteristic.StatusTampered, "Bool", config.StatusTampered);
} }
if (config.StatusLowBattery) { if (config.StatusLowBattery) {
this.log("ContactSensor StatusLowBattery characteristic enabled"); this.log("["+ this.name +"]:ContactSensor StatusLowBattery characteristic enabled");
myService.addCharacteristic(Characteristic.StatusLowBattery); myService.addCharacteristic(Characteristic.StatusLowBattery);
this.bindCharacteristic(myService, Characteristic.StatusLowBattery, "Bool", config.StatusLowBattery); this.bindCharacteristic(myService, Characteristic.StatusLowBattery, "Bool", config.StatusLowBattery);
} }
@@ -573,27 +573,27 @@ KNXDevice.prototype = {
var myService = new Service.GarageDoorOpener(config.name,config.name); var myService = new Service.GarageDoorOpener(config.name,config.name);
if (config.CurrentDoorState) { if (config.CurrentDoorState) {
this.log("GarageDoorOpener CurrentDoorState characteristic enabled"); this.log("["+ this.name +"]:GarageDoorOpener CurrentDoorState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.CurrentDoorState, "Int", config.CurrentDoorState); this.bindCharacteristic(myService, Characteristic.CurrentDoorState, "Int", config.CurrentDoorState);
} }
if (config.TargetDoorState) { if (config.TargetDoorState) {
this.log("GarageDoorOpener TargetDoorState characteristic enabled"); this.log("["+ this.name +"]:GarageDoorOpener TargetDoorState characteristic enabled");
//myService.getCharacteristic(Characteristic.TargetDoorState).minimumValue=0; // //myService.getCharacteristic(Characteristic.TargetDoorState).minimumValue=0; //
//myService.getCharacteristic(Characteristic.TargetDoorState).maximumValue=4; // //myService.getCharacteristic(Characteristic.TargetDoorState).maximumValue=4; //
this.bindCharacteristic(myService, Characteristic.TargetDoorState, "Int", config.TargetDoorState); this.bindCharacteristic(myService, Characteristic.TargetDoorState, "Int", config.TargetDoorState);
} }
if (config.ObstructionDetected) { if (config.ObstructionDetected) {
this.log("GarageDoorOpener ObstructionDetected characteristic enabled"); this.log("["+ this.name +"]:GarageDoorOpener ObstructionDetected characteristic enabled");
this.bindCharacteristic(myService, Characteristic.ObstructionDetected, "Bool", config.ObstructionDetected); this.bindCharacteristic(myService, Characteristic.ObstructionDetected, "Bool", config.ObstructionDetected);
} }
//optionals //optionals
if (config.LockCurrentState) { if (config.LockCurrentState) {
this.log("GarageDoorOpener LockCurrentState characteristic enabled"); this.log("["+ this.name +"]:GarageDoorOpener LockCurrentState characteristic enabled");
myService.addCharacteristic(Characteristic.LockCurrentState); myService.addCharacteristic(Characteristic.LockCurrentState);
this.bindCharacteristic(myService, Characteristic.LockCurrentState, "Int", config.LockCurrentState); this.bindCharacteristic(myService, Characteristic.LockCurrentState, "Int", config.LockCurrentState);
} }
if (config.LockTargetState) { if (config.LockTargetState) {
this.log("GarageDoorOpener LockTargetState characteristic enabled"); this.log("["+ this.name +"]:GarageDoorOpener LockTargetState characteristic enabled");
myService.addCharacteristic(Characteristic.LockTargetState); myService.addCharacteristic(Characteristic.LockTargetState);
this.bindCharacteristic(myService, Characteristic.LockTargetState, "Bool", config.LockTargetState); this.bindCharacteristic(myService, Characteristic.LockTargetState, "Bool", config.LockTargetState);
} }
@@ -614,12 +614,12 @@ KNXDevice.prototype = {
var myService = new Service.Lightbulb(config.name,config.name); var myService = new Service.Lightbulb(config.name,config.name);
// On (and Off) // On (and Off)
if (config.On) { if (config.On) {
this.log("Lightbulb on/off characteristic enabled"); this.log("["+ this.name +"]:Lightbulb on/off characteristic enabled");
this.bindCharacteristic(myService, Characteristic.On, "Bool", config.On); this.bindCharacteristic(myService, Characteristic.On, "Bool", config.On);
} // On characteristic } // On characteristic
// Brightness if available // Brightness if available
if (config.Brightness) { if (config.Brightness) {
this.log("Lightbulb Brightness characteristic enabled"); this.log("["+ this.name +"]:Lightbulb Brightness characteristic enabled");
myService.addCharacteristic(Characteristic.Brightness); // it's an optional myService.addCharacteristic(Characteristic.Brightness); // it's an optional
this.bindCharacteristic(myService, Characteristic.Brightness, "Percent", config.Brightness); this.bindCharacteristic(myService, Characteristic.Brightness, "Percent", config.Brightness);
} }
@@ -641,7 +641,7 @@ KNXDevice.prototype = {
var myService = new Service.LightSensor(config.name,config.name); var myService = new Service.LightSensor(config.name,config.name);
// CurrentTemperature) // CurrentTemperature)
if (config.CurrentAmbientLightLevel) { if (config.CurrentAmbientLightLevel) {
this.log("LightSensor CurrentAmbientLightLevel characteristic enabled"); this.log("["+ this.name +"]:LightSensor CurrentAmbientLightLevel characteristic enabled");
this.bindCharacteristic(myService, Characteristic.CurrentAmbientLightLevel, "Float", config.CurrentAmbientLightLevel); this.bindCharacteristic(myService, Characteristic.CurrentAmbientLightLevel, "Float", config.CurrentAmbientLightLevel);
} }
return myService; return myService;
@@ -666,19 +666,19 @@ KNXDevice.prototype = {
// LockCurrentState // LockCurrentState
if (config.LockCurrentState) { if (config.LockCurrentState) {
// for normal contacts: Secured = 1 // for normal contacts: Secured = 1
this.log("LockMechanism LockCurrentState characteristic enabled"); this.log("["+ this.name +"]:LockMechanism LockCurrentState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.LockCurrentState, "Bool", config.LockCurrentState); this.bindCharacteristic(myService, Characteristic.LockCurrentState, "Bool", config.LockCurrentState);
} else if (config.LockCurrentStateSecured0) { } else if (config.LockCurrentStateSecured0) {
// for reverse contacts Secured = 0 // for reverse contacts Secured = 0
this.log("LockMechanism LockCurrentState characteristic enabled"); this.log("["+ this.name +"]:LockMechanism LockCurrentState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.LockCurrentState, "BoolReverse", config.LockCurrentStateSecured0); this.bindCharacteristic(myService, Characteristic.LockCurrentState, "BoolReverse", config.LockCurrentStateSecured0);
} }
// LockTargetState // LockTargetState
if (config.LockTargetState) { if (config.LockTargetState) {
this.log("LockMechanism LockTargetState characteristic enabled"); this.log("["+ this.name +"]:LockMechanism LockTargetState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.LockTargetState, "Bool", config.LockTargetState); this.bindCharacteristic(myService, Characteristic.LockTargetState, "Bool", config.LockTargetState);
} else if (config.LockTargetStateSecured0) { } else if (config.LockTargetStateSecured0) {
this.log("LockMechanism LockTargetState characteristic enabled"); this.log("["+ this.name +"]:LockMechanism LockTargetState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.LockTargetState, "BoolReverse", config.LockTargetStateSecured0); this.bindCharacteristic(myService, Characteristic.LockTargetState, "BoolReverse", config.LockTargetStateSecured0);
} }
@@ -701,27 +701,27 @@ KNXDevice.prototype = {
var myService = new Service.MotionSensor(config.name,config.name); var myService = new Service.MotionSensor(config.name,config.name);
if (config.MotionDetected) { if (config.MotionDetected) {
this.log("MotionSensor MotionDetected characteristic enabled"); this.log("["+ this.name +"]:MotionSensor MotionDetected characteristic enabled");
this.bindCharacteristic(myService, Characteristic.MotionDetected, "Bool", config.MotionDetected); this.bindCharacteristic(myService, Characteristic.MotionDetected, "Bool", config.MotionDetected);
} }
//optionals //optionals
if (config.StatusActive) { if (config.StatusActive) {
this.log("MotionSensor StatusActive characteristic enabled"); this.log("["+ this.name +"]:MotionSensor StatusActive characteristic enabled");
myService.addCharacteristic(Characteristic.StatusActive); myService.addCharacteristic(Characteristic.StatusActive);
this.bindCharacteristic(myService, Characteristic.StatusActive, "Bool", config.StatusActive); this.bindCharacteristic(myService, Characteristic.StatusActive, "Bool", config.StatusActive);
} }
if (config.StatusFault) { if (config.StatusFault) {
this.log("MotionSensor StatusFault characteristic enabled"); this.log("["+ this.name +"]:MotionSensor StatusFault characteristic enabled");
myService.addCharacteristic(Characteristic.StatusFault); myService.addCharacteristic(Characteristic.StatusFault);
this.bindCharacteristic(myService, Characteristic.StatusFault, "Bool", config.StatusFault); this.bindCharacteristic(myService, Characteristic.StatusFault, "Bool", config.StatusFault);
} }
if (config.StatusTampered) { if (config.StatusTampered) {
this.log("MotionSensor StatusTampered characteristic enabled"); this.log("["+ this.name +"]:MotionSensor StatusTampered characteristic enabled");
myService.addCharacteristic(Characteristic.StatusTampered); myService.addCharacteristic(Characteristic.StatusTampered);
this.bindCharacteristic(myService, Characteristic.StatusTampered, "Bool", config.StatusTampered); this.bindCharacteristic(myService, Characteristic.StatusTampered, "Bool", config.StatusTampered);
} }
if (config.StatusLowBattery) { if (config.StatusLowBattery) {
this.log("MotionSensor StatusLowBattery characteristic enabled"); this.log("["+ this.name +"]:MotionSensor StatusLowBattery characteristic enabled");
myService.addCharacteristic(Characteristic.StatusLowBattery); myService.addCharacteristic(Characteristic.StatusLowBattery);
this.bindCharacteristic(myService, Characteristic.StatusLowBattery, "Bool", config.StatusLowBattery); this.bindCharacteristic(myService, Characteristic.StatusLowBattery, "Bool", config.StatusLowBattery);
} }
@@ -744,11 +744,11 @@ KNXDevice.prototype = {
var myService = new Service.Outlet(config.name,config.name); var myService = new Service.Outlet(config.name,config.name);
// On (and Off) // On (and Off)
if (config.On) { if (config.On) {
this.log("Outlet on/off characteristic enabled"); this.log("["+ this.name +"]:Outlet on/off characteristic enabled");
this.bindCharacteristic(myService, Characteristic.On, "Bool", config.On); this.bindCharacteristic(myService, Characteristic.On, "Bool", config.On);
} // OutletInUse characteristic } // OutletInUse characteristic
if (config.OutletInUse) { if (config.OutletInUse) {
this.log("Outlet on/off characteristic enabled"); this.log("["+ this.name +"]:Outlet on/off characteristic enabled");
this.bindCharacteristic(myService, Characteristic.OutletInUse, "Bool", config.OutletInUse); this.bindCharacteristic(myService, Characteristic.OutletInUse, "Bool", config.OutletInUse);
} }
return myService; return myService;
@@ -766,7 +766,7 @@ KNXDevice.prototype = {
var myService = new Service.Switch(config.name,config.name); var myService = new Service.Switch(config.name,config.name);
// On (and Off) // On (and Off)
if (config.On) { if (config.On) {
this.log("Switch on/off characteristic enabled"); this.log("["+ this.name +"]:Switch on/off characteristic enabled");
this.bindCharacteristic(myService, Characteristic.On, "Bool", config.On); this.bindCharacteristic(myService, Characteristic.On, "Bool", config.On);
} // On characteristic } // On characteristic
@@ -795,7 +795,7 @@ KNXDevice.prototype = {
// CurrentTemperature) // CurrentTemperature)
// props update for https://github.com/KhaosT/HAP-NodeJS/commit/1d84d128d1513beedcafc24d2c07d98185563243#diff-cb84de3a1478a38b2cf8388d709f1c1cR108 // props update for https://github.com/KhaosT/HAP-NodeJS/commit/1d84d128d1513beedcafc24d2c07d98185563243#diff-cb84de3a1478a38b2cf8388d709f1c1cR108
if (config.CurrentTemperature) { if (config.CurrentTemperature) {
this.log("Thermostat CurrentTemperature characteristic enabled"); this.log("["+ this.name +"]:Thermostat CurrentTemperature characteristic enabled");
myService.getCharacteristic(Characteristic.CurrentTemperature).setProps({ myService.getCharacteristic(Characteristic.CurrentTemperature).setProps({
minValue: config.CurrentTemperature.minValue || -40, minValue: config.CurrentTemperature.minValue || -40,
maxValue: config.CurrentTemperature.maxValue || 60 maxValue: config.CurrentTemperature.maxValue || 60
@@ -804,7 +804,7 @@ KNXDevice.prototype = {
} }
// TargetTemperature if available // TargetTemperature if available
if (config.TargetTemperature) { if (config.TargetTemperature) {
this.log("Thermostat TargetTemperature characteristic enabled"); this.log("["+ this.name +"]:Thermostat TargetTemperature characteristic enabled");
// default boundary too narrow for thermostats // default boundary too narrow for thermostats
// props update for https://github.com/KhaosT/HAP-NodeJS/commit/1d84d128d1513beedcafc24d2c07d98185563243#diff-cb84de3a1478a38b2cf8388d709f1c1cR108 // props update for https://github.com/KhaosT/HAP-NodeJS/commit/1d84d128d1513beedcafc24d2c07d98185563243#diff-cb84de3a1478a38b2cf8388d709f1c1cR108
myService.getCharacteristic(Characteristic.TargetTemperature).setProps({ myService.getCharacteristic(Characteristic.TargetTemperature).setProps({
@@ -816,12 +816,12 @@ KNXDevice.prototype = {
} }
// HVAC // HVAC
if (config.CurrentHeatingCoolingState) { if (config.CurrentHeatingCoolingState) {
this.log("Thermostat CurrentHeatingCoolingState characteristic enabled"); this.log("["+ this.name +"]:Thermostat CurrentHeatingCoolingState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.CurrentHeatingCoolingState, "HVAC", config.CurrentHeatingCoolingState); this.bindCharacteristic(myService, Characteristic.CurrentHeatingCoolingState, "HVAC", config.CurrentHeatingCoolingState);
} }
// HVAC // HVAC
if (config.TargetHeatingCoolingState) { if (config.TargetHeatingCoolingState) {
this.log("Thermostat TargetHeatingCoolingState characteristic enabled"); this.log("["+ this.name +"]:Thermostat TargetHeatingCoolingState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.TargetHeatingCoolingState, "HVAC", config.TargetHeatingCoolingState); this.bindCharacteristic(myService, Characteristic.TargetHeatingCoolingState, "HVAC", config.TargetHeatingCoolingState);
} }
return myService; return myService;
@@ -841,7 +841,7 @@ KNXDevice.prototype = {
// CurrentTemperature) // CurrentTemperature)
// props update for https://github.com/KhaosT/HAP-NodeJS/commit/1d84d128d1513beedcafc24d2c07d98185563243#diff-cb84de3a1478a38b2cf8388d709f1c1cR108 // props update for https://github.com/KhaosT/HAP-NodeJS/commit/1d84d128d1513beedcafc24d2c07d98185563243#diff-cb84de3a1478a38b2cf8388d709f1c1cR108
if (config.CurrentTemperature) { if (config.CurrentTemperature) {
this.log("Thermostat CurrentTemperature characteristic enabled"); this.log("["+ this.name +"]:TemperatureSensor CurrentTemperature characteristic enabled");
myService.getCharacteristic(Characteristic.CurrentTemperature).setProps({ myService.getCharacteristic(Characteristic.CurrentTemperature).setProps({
minValue: config.CurrentTemperature.minValue || -40, minValue: config.CurrentTemperature.minValue || -40,
maxValue: config.CurrentTemperature.maxValue || 60 maxValue: config.CurrentTemperature.maxValue || 60
@@ -878,15 +878,15 @@ KNXDevice.prototype = {
var myService = new Service.Window(config.name,config.name); var myService = new Service.Window(config.name,config.name);
if (config.CurrentPosition) { if (config.CurrentPosition) {
this.log("Window CurrentPosition characteristic enabled"); this.log("["+ this.name +"]:Window CurrentPosition characteristic enabled");
this.bindCharacteristic(myService, Characteristic.CurrentPosition, "Percent", config.CurrentPosition); this.bindCharacteristic(myService, Characteristic.CurrentPosition, "Percent", config.CurrentPosition);
} }
if (config.TargetPosition) { if (config.TargetPosition) {
this.log("Window TargetPosition characteristic enabled"); this.log("["+ this.name +"]:Window TargetPosition characteristic enabled");
this.bindCharacteristic(myService, Characteristic.TargetPosition, "Percent", config.TargetPosition); this.bindCharacteristic(myService, Characteristic.TargetPosition, "Percent", config.TargetPosition);
} }
if (config.PositionState) { if (config.PositionState) {
this.log("Window PositionState characteristic enabled"); this.log("["+ this.name +"]:Window PositionState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.PositionState, "Float", config.PositionState); this.bindCharacteristic(myService, Characteristic.PositionState, "Float", config.PositionState);
} }
return myService; return myService;
@@ -913,15 +913,15 @@ KNXDevice.prototype = {
var myService = new Service.WindowCovering(config.name,config.name); var myService = new Service.WindowCovering(config.name,config.name);
if (config.CurrentPosition) { if (config.CurrentPosition) {
this.log("WindowCovering CurrentPosition characteristic enabled"); this.log("["+ this.name +"]:WindowCovering CurrentPosition characteristic enabled");
this.bindCharacteristic(myService, Characteristic.CurrentPosition, "Percent", config.CurrentPosition); this.bindCharacteristic(myService, Characteristic.CurrentPosition, "Percent", config.CurrentPosition);
} }
if (config.TargetPosition) { if (config.TargetPosition) {
this.log("WindowCovering TargetPosition characteristic enabled"); this.log("["+ this.name +"]:WindowCovering TargetPosition characteristic enabled");
this.bindCharacteristic(myService, Characteristic.TargetPosition, "Percent", config.TargetPosition); this.bindCharacteristic(myService, Characteristic.TargetPosition, "Percent", config.TargetPosition);
} }
if (config.PositionState) { if (config.PositionState) {
this.log("WindowCovering PositionState characteristic enabled"); this.log("["+ this.name +"]:WindowCovering PositionState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.PositionState, "Float", config.PositionState); this.bindCharacteristic(myService, Characteristic.PositionState, "Float", config.PositionState);
} }
return myService; return myService;
@@ -943,7 +943,7 @@ KNXDevice.prototype = {
informationService informationService
.setCharacteristic(Characteristic.Manufacturer, "Opensource Community") .setCharacteristic(Characteristic.Manufacturer, "Opensource Community")
.setCharacteristic(Characteristic.Model, "KNX Universal Device") .setCharacteristic(Characteristic.Model, "KNX Universal Device")
.setCharacteristic(Characteristic.SerialNumber, "Version 1.1.2"); .setCharacteristic(Characteristic.SerialNumber, "Version 1.1.4");
accessoryServices.push(informationService); accessoryServices.push(informationService);
@@ -998,8 +998,8 @@ KNXDevice.prototype = {
accessoryServices.push(this.getWindowCoveringService(configService)); accessoryServices.push(this.getWindowCoveringService(configService));
break; break;
default: default:
this.log("[ERROR] unknown 'type' property of '"+configService.type+"' for service "+ configService.name + " in config.json. KNX platform section fault "); this.log("[ERROR] unknown 'type' property of ["+configService.type+"] for service ["+ configService.name + "] in config.json. KNX platform section fault ");
//throw new Error("[ERROR] unknown 'type' property for service "+ configService.name + " in config.json. KNX platform section fault "); throw new Error("[ERROR] unknown 'type' property of ["+configService.type+"] for service '"+ configService.name + "' in config.json. KNX platform section fault ");
} }
} }
// start listening for events on the bus (if not started yet - will prevent itself) // start listening for events on the bus (if not started yet - will prevent itself)

33
platforms/KNX.md
View File

@@ -47,7 +47,7 @@ You have to add services in the following syntax:
{ {
"type": "SERVICENAME", "type": "SERVICENAME",
"description": "This is just for you to remember things", "description": "This is just for you to remember things",
"name": "We need a name for each service, though it usually shows only if multiple services are present in one accessory", "name": "beer tap thermostat",
"CHARACTERISTIC1": { "CHARACTERISTIC1": {
"Set": "1/1/6", "Set": "1/1/6",
"Listen": [ "Listen": [
@@ -68,6 +68,35 @@ Two kinds of addresses are supported: `"Set":"1/2/3"` is a writable group addres
`"Listen":["1/2/3","1/2/4","1/2/5"]` is an array of addresses that are listened to additionally. To these addresses never values get written, but the on startup the service will issue *KNX read requests* to ALL addresses listed in `Set:` and in `Listen:` `"Listen":["1/2/3","1/2/4","1/2/5"]` is an array of addresses that are listened to additionally. To these addresses never values get written, but the on startup the service will issue *KNX read requests* to ALL addresses listed in `Set:` and in `Listen:`
For two characteristics there are additional minValue and maxValue attributes. These are CurrentTemperature and TargetTemperature, and are used in TemperatureSensor and Thermostat.
So the charcteristic section may look like:
````json
{
"type": "Thermostat",
"description": "Sample thermostat",
"name": "We need a name for each service, though it usually shows only if multiple services are present in one accessory",
"CurrentTemperature": {
"Set": "1/1/6",
"Listen": [
"1/1/63"
],
minValue: -18,
maxValue: 30
},
"TargetTemperature": {
"Set": "1/1/62",
"Listen": [
"1/1/64"
],
minValue: -4,
maxValue: 12
}
}
````
# Supported Services and their characteristics # Supported Services and their characteristics
## ContactSensor ## ContactSensor
@@ -139,7 +168,7 @@ Two kinds of addresses are supported: `"Set":"1/2/3"` is a writable group addres
- CurrentTemperature: DPT9.001 in °C [listen only] - CurrentTemperature: DPT9.001 in °C [listen only]
## Thermostat ## Thermostat
- CurrentTemperature: DPT9.001 in °C [listen only] - CurrentTemperature: DPT9.001 in °C [listen only], -40 to 80°C if not overriden as shown above
- TargetTemperature: DPT9.001, values 0..40°C only, all others are ignored - TargetTemperature: DPT9.001, values 0..40°C only, all others are ignored
- CurrentHeatingCoolingState: DPT20.102 HVAC, because of the incompatible mapping only off and heating (=auto) are shown, [listen only] - CurrentHeatingCoolingState: DPT20.102 HVAC, because of the incompatible mapping only off and heating (=auto) are shown, [listen only]
- TargetHeatingCoolingState: DPT20.102 HVAC, as above - TargetHeatingCoolingState: DPT20.102 HVAC, as above