mtan93/homebridge
1
0
Fork 0
mirror of https://github.com/mtan93/homebridge.git synced 2026-04-25 22:05:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #188 from snowdd1/knx-dev

Browse Source 
KNX cleanup
This commit is contained in:
Nick Farina
2015-09-18 09:25:04 -07:00
parent 73148b060d 91f6ccb2d4
commit 1dcfe4a1fb
4 changed files with 327 additions and 307 deletions
Download Patch File Download Diff File Expand all files Collapse all files

366
accessories/knxdevice.js
View File

@@ -1,13 +1,16 @@
/* /**
* This is a KNX universal accessory shim. * This is a KNX universal accessory shim.
* This is NOT the version for dynamic installation * This is NOT the version for dynamic installation
* *
New 2015-09-16: Welcome iOS9.0 New 2015-09-16: Welcome iOS9.0
new features includ: new features include:
services: - services:
Window - Window
WindowCovering - WindowCovering
ContactSensor - ContactSensor
New 2015-0918:
- Services Switch and Outlet
- Code cleanup
* *
*/ */
var Service = require("HAP-NodeJS").Service; var Service = require("HAP-NodeJS").Service;
@@ -102,7 +105,6 @@ KNXDevice.prototype = {
}.bind(this)); }.bind(this));
}.bind(this)); }.bind(this));
}, },
// issues an all purpose read request on the knx bus // issues an all purpose read request on the knx bus
// DOES NOT WAIT for an answer. Please register the address with a callback using registerGA() function // DOES NOT WAIT for an answer. Please register the address with a callback using registerGA() function
knxread: function(groupAddress){ knxread: function(groupAddress){
@@ -132,7 +134,6 @@ KNXDevice.prototype = {
}.bind(this)); }.bind(this));
}.bind(this)); }.bind(this));
}, },
// issuing multiple read requests at once // issuing multiple read requests at once
knxreadarray: function (groupAddresses) { knxreadarray: function (groupAddresses) {
if (groupAddresses.constructor.toString().indexOf("Array") > -1) { if (groupAddresses.constructor.toString().indexOf("Array") > -1) {
@@ -147,7 +148,9 @@ KNXDevice.prototype = {
this.knxread (groupAddresses); this.knxread (groupAddresses);
} }
}, },
/** Write special type routines
*
*/
// special types // special types
knxwrite_percent: function(callback, groupAddress, value) { knxwrite_percent: function(callback, groupAddress, value) {
var numericValue = 0; var numericValue = 0;
@@ -159,10 +162,9 @@ KNXDevice.prototype = {
} }
this.knxwrite(callback, groupAddress,'DPT5',numericValue); this.knxwrite(callback, groupAddress,'DPT5',numericValue);
}, },
/** Registering routines
*
// need to spit registers into types */
// boolean: get 0 or 1 from the bus, write boolean // boolean: get 0 or 1 from the bus, write boolean
knxregister_bool: function(addresses, characteristic) { knxregister_bool: function(addresses, characteristic) {
this.log("knx registering BOOLEAN " + addresses); this.log("knx registering BOOLEAN " + addresses);
@@ -201,7 +203,6 @@ KNXDevice.prototype = {
} }
}.bind(this)); }.bind(this));
}, },
// float // float
knxregister_float: function(addresses, characteristic) { knxregister_float: function(addresses, characteristic) {
this.log("knx registering FLOAT " + addresses); this.log("knx registering FLOAT " + addresses);
@@ -216,8 +217,6 @@ KNXDevice.prototype = {
}.bind(this)); }.bind(this));
}, },
// what about HVAC heating cooling types?
knxregister_HVAC: function(addresses, characteristic) { knxregister_HVAC: function(addresses, characteristic) {
this.log("knx registering HVAC " + addresses); this.log("knx registering HVAC " + addresses);
knxd_registerGA(addresses, function(val, src, dest, type){ knxd_registerGA(addresses, function(val, src, dest, type){
@@ -245,7 +244,7 @@ KNXDevice.prototype = {
characteristic.setValue(HAPvalue, undefined, 'fromKNXBus'); characteristic.setValue(HAPvalue, undefined, 'fromKNXBus');
}.bind(this)); }.bind(this));
}, },
// to do! KNX: DPT 20.102 = One Byte like DPT5 /** KNX HVAC (heating, ventilation, and air conditioning) types do not really match to homekit types:
// 0 = Auto // 0 = Auto
// 1 = Comfort // 1 = Comfort
// 2 = Standby // 2 = Standby
@@ -257,8 +256,8 @@ KNXDevice.prototype = {
// Characteristic.TargetHeatingCoolingState.HEAT = 1; // Characteristic.TargetHeatingCoolingState.HEAT = 1;
// Characteristic.TargetHeatingCoolingState.COOL = 2; // Characteristic.TargetHeatingCoolingState.COOL = 2;
// Characteristic.TargetHeatingCoolingState.AUTO = 3; // Characteristic.TargetHeatingCoolingState.AUTO = 3;
AUTO (3) is not allowed as return type from devices!
*/
// undefined, has to match! // undefined, has to match!
knxregister: function(addresses, characteristic) { knxregister: function(addresses, characteristic) {
this.log("knx registering " + addresses); this.log("knx registering " + addresses);
@@ -268,14 +267,14 @@ KNXDevice.prototype = {
}.bind(this)); }.bind(this));
}, },
/* /** set methods used for creating callbacks
* set methods used for creating callbacks, such as * such as
* var Characteristic = myService.addCharacteristic(new Characteristic.Brightness()) * var Characteristic = myService.addCharacteristic(new Characteristic.Brightness())
* .on('set', function(value, callback, context) { * .on('set', function(value, callback, context) {
* this.setPercentage(value, callback, context, this.config[index].Set) * this.setPercentage(value, callback, context, this.config[index].Set)
* }.bind(this)); * }.bind(this));
* *
*/ */
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!");
@@ -308,7 +307,6 @@ KNXDevice.prototype = {
} }
}, },
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("event ping pong, exit!");
@@ -324,7 +322,6 @@ KNXDevice.prototype = {
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!");
@@ -340,7 +337,6 @@ KNXDevice.prototype = {
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!");
@@ -371,21 +367,16 @@ KNXDevice.prototype = {
} }
}, },
/** identify dummy
*
*/
identify: function(callback) { identify: function(callback) {
this.log("Identify requested!"); this.log("Identify requested!");
callback(); // success callback(); // success
}, },
/** bindCharacteristic
* initializes callbacks for 'set' events (from HK) and for KNX bus reads (to HK)
/* */
* function getXXXXXXXService(config)
*
* returns a configured service object to the caller (accessory/device)
*
*/
bindCharacteristic: function(myService, characteristicType, valueType, config) { bindCharacteristic: function(myService, characteristicType, valueType, config) {
var myCharacteristic = myService.getCharacteristic(characteristicType); var myCharacteristic = myService.getCharacteristic(characteristicType);
if (myCharacteristic === undefined) { if (myCharacteristic === undefined) {
@@ -453,7 +444,60 @@ KNXDevice.prototype = {
} }
return myCharacteristic; // for chaining or whatsoever return myCharacteristic; // for chaining or whatsoever
}, },
/**
* function getXXXXXXXService(config)
* returns a configured service object to the caller (accessory/device)
*
* @param config
* pass a configuration array parsed from config.json
* specifically for this service
*
*/
getContactSenserService: function(config) {
// Characteristic.ContactSensorState.CONTACT_DETECTED = 0;
// Characteristic.ContactSensorState.CONTACT_NOT_DETECTED = 1;
// some sanity checks
if (config.type !== "ContactSensor") {
this.log("[ERROR] ContactSensor Service for non 'ContactSensor' service called");
return undefined;
}
if (!config.name) {
this.log("[ERROR] ContactSensor Service without 'name' property called");
return undefined;
}
var myService = new Service.ContactSensor(config.name,config.name);
if (config.ContactSensorState) {
this.log("ContactSensor ContactSensorState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.ContactSensorState, "Bool", config.ContactSensorState);
} else if (config.ContactSensorStateContact1) {
this.log("ContactSensor ContactSensorStateContact1 characteristic enabled");
this.bindCharacteristic(myService, Characteristic.ContactSensorState, "BoolReverse", config.ContactSensorStateContact1);
}
//optionals
if (config.StatusActive) {
this.log("ContactSensor StatusActive characteristic enabled");
myService.addCharacteristic(Characteristic.StatusActive);
this.bindCharacteristic(myService, Characteristic.StatusActive, "Bool", config.StatusActive);
}
if (config.StatusFault) {
this.log("ContactSensor StatusFault characteristic enabled");
myService.addCharacteristic(Characteristic.StatusFault);
this.bindCharacteristic(myService, Characteristic.StatusFault, "Bool", config.StatusFault);
}
if (config.StatusTampered) {
this.log("ContactSensor StatusTampered characteristic enabled");
myService.addCharacteristic(Characteristic.StatusTampered);
this.bindCharacteristic(myService, Characteristic.StatusTampered, "Bool", config.StatusTampered);
}
if (config.StatusLowBattery) {
this.log("ContactSensor StatusLowBattery characteristic enabled");
myService.addCharacteristic(Characteristic.StatusLowBattery);
this.bindCharacteristic(myService, Characteristic.StatusLowBattery, "Bool", config.StatusLowBattery);
}
return myService;
},
getLightbulbService: function(config) { getLightbulbService: function(config) {
// some sanity checks // some sanity checks
//this.config = config; //this.config = config;
@@ -482,13 +526,32 @@ KNXDevice.prototype = {
//iterate(myService); //iterate(myService);
return myService; return myService;
}, },
getLightSensorService: function(config) {
getLockMechanismService: function(config) {
// some sanity checks // some sanity checks
//this.config = config; if (config.type !== "LightSensor") {
this.log("[ERROR] LightSensor Service for non 'LightSensor' service called");
return undefined;
}
if (!config.name) {
this.log("[ERROR] LightSensor Service without 'name' property called");
return undefined;
}
var myService = new Service.LightSensor(config.name,config.name);
// CurrentTemperature)
if (config.CurrentAmbientLightLevel) {
this.log("LightSensor CurrentAmbientLightLevel characteristic enabled");
this.bindCharacteristic(myService, Characteristic.CurrentAmbientLightLevel, "Float", config.CurrentAmbientLightLevel);
}
return myService;
},
getLockMechanismService: function(config) {
/** //this.config = config;
// Characteristic.LockCurrentState.UNSECURED = 0; // Characteristic.LockCurrentState.UNSECURED = 0;
// Characteristic.LockCurrentState.SECURED = 1; // Characteristic.LockCurrentState.SECURED = 1;
*/
// some sanity checks
if (config.type !== "LockMechanism") { if (config.type !== "LockMechanism") {
this.log("[ERROR] LockMechanism Service for non 'LockMechanism' service called"); this.log("[ERROR] LockMechanism Service for non 'LockMechanism' service called");
return undefined; return undefined;
@@ -497,6 +560,7 @@ KNXDevice.prototype = {
this.log("[ERROR] LockMechanism Service without 'name' property called"); this.log("[ERROR] LockMechanism Service without 'name' property called");
return undefined; return undefined;
} }
var myService = new Service.LockMechanism(config.name,config.name); var myService = new Service.LockMechanism(config.name,config.name);
// LockCurrentState // LockCurrentState
if (config.LockCurrentState) { if (config.LockCurrentState) {
@@ -520,28 +584,61 @@ KNXDevice.prototype = {
//iterate(myService); //iterate(myService);
return myService; return myService;
}, },
getOutletService: function(config) {
/**
* this.addCharacteristic(Characteristic.On);
* this.addCharacteristic(Characteristic.OutletInUse);
*/
// some sanity checks
if (config.type !== "Outlet") {
this.log("[ERROR] Outlet Service for non 'Outlet' service called");
return undefined;
}
if (!config.name) {
this.log("[ERROR] Outlet Service without 'name' property called");
return undefined;
}
var myService = new Service.Outlet(config.name,config.name);
// On (and Off)
if (config.On) {
this.log("Outlet on/off characteristic enabled");
this.bindCharacteristic(myService, Characteristic.On, "Bool", config.On);
} // OutletInUse characteristic
if (config.OutletInUse) {
this.log("Outlet on/off characteristic enabled");
this.bindCharacteristic(myService, Characteristic.OutletInUse, "Bool", config.OutletInUse);
}
return myService;
},
getSwitchService: function(config) {
// some sanity checks
if (config.type !== "Switch") {
this.log("[ERROR] Switch Service for non 'Switch' service called");
return undefined;
}
if (!config.name) {
this.log("[ERROR] Switch Service without 'name' property called");
return undefined;
}
var myService = new Service.Switch(config.name,config.name);
// On (and Off)
if (config.On) {
this.log("Switch on/off characteristic enabled");
this.bindCharacteristic(myService, Characteristic.On, "Bool", config.On);
} // On characteristic
return myService;
},
getThermostatService: function(config) { getThermostatService: function(config) {
/**
// Optional Characteristics
// // Required Characteristics this.addOptionalCharacteristic(Characteristic.CurrentRelativeHumidity);
// this.addCharacteristic(Characteristic.CurrentHeatingCoolingState); this.addOptionalCharacteristic(Characteristic.TargetRelativeHumidity);
// this.addCharacteristic(Characteristic.TargetHeatingCoolingState); this.addOptionalCharacteristic(Characteristic.CoolingThresholdTemperature);
// this.addCharacteristic(Characteristic.CurrentTemperature); //check this.addOptionalCharacteristic(Characteristic.HeatingThresholdTemperature);
// this.addCharacteristic(Characteristic.TargetTemperature); // */
// this.addCharacteristic(Characteristic.TemperatureDisplayUnits);
//
// // Optional Characteristics
// this.addOptionalCharacteristic(Characteristic.CurrentRelativeHumidity);
// this.addOptionalCharacteristic(Characteristic.TargetRelativeHumidity);
// this.addOptionalCharacteristic(Characteristic.CoolingThresholdTemperature);
// this.addOptionalCharacteristic(Characteristic.HeatingThresholdTemperature);
// some sanity checks // some sanity checks
if (config.type !== "Thermostat") { if (config.type !== "Thermostat") {
this.log("[ERROR] Thermostat Service for non 'Thermostat' service called"); this.log("[ERROR] Thermostat Service for non 'Thermostat' service called");
return undefined; return undefined;
@@ -550,6 +647,7 @@ KNXDevice.prototype = {
this.log("[ERROR] Thermostat Service without 'name' property called"); this.log("[ERROR] Thermostat Service without 'name' property called");
return undefined; return undefined;
} }
var myService = new Service.Thermostat(config.name,config.name); var myService = new Service.Thermostat(config.name,config.name);
// CurrentTemperature) // CurrentTemperature)
if (config.CurrentTemperature) { if (config.CurrentTemperature) {
@@ -581,15 +679,9 @@ KNXDevice.prototype = {
} }
return myService; return myService;
}, },
// temperature sensor type (iOS9 assumed)
getTemperatureSensorService: function(config) { getTemperatureSensorService: function(config) {
// some sanity checks // some sanity checks
if (config.type !== "TemperatureSensor") { if (config.type !== "TemperatureSensor") {
this.log("[ERROR] TemperatureSensor Service for non 'TemperatureSensor' service called"); this.log("[ERROR] TemperatureSensor Service for non 'TemperatureSensor' service called");
return undefined; return undefined;
@@ -606,28 +698,18 @@ KNXDevice.prototype = {
} }
return myService; return myService;
}, },
// window type (iOS9 assumed)
getWindowService: function(config) { getWindowService: function(config) {
// Service.Window = function(displayName, subtype) { /**
// Service.call(this, displayName, '0000008B-0000-1000-8000-0026BB765291', subtype); Optional Characteristics
// this.addOptionalCharacteristic(Characteristic.HoldPosition);
// // Required Characteristics this.addOptionalCharacteristic(Characteristic.ObstructionDetected);
// this.addCharacteristic(Characteristic.CurrentPosition); this.addOptionalCharacteristic(Characteristic.Name);
// this.addCharacteristic(Characteristic.TargetPosition);
// this.addCharacteristic(Characteristic.PositionState);
//
// // Optional Characteristics
// this.addOptionalCharacteristic(Characteristic.HoldPosition);
// this.addOptionalCharacteristic(Characteristic.ObstructionDetected);
// this.addOptionalCharacteristic(Characteristic.Name);
// Characteristic.PositionState.DECREASING = 0;
// Characteristic.PositionState.INCREASING = 1;
// Characteristic.PositionState.STOPPED = 2;
PositionState values: The KNX blind actuators I have return only MOVING=1 and STOPPED=0
Characteristic.PositionState.DECREASING = 0;
Characteristic.PositionState.INCREASING = 1;
Characteristic.PositionState.STOPPED = 2;
*/
// some sanity checks // some sanity checks
@@ -656,34 +738,17 @@ KNXDevice.prototype = {
} }
return myService; return myService;
}, },
// /**
// * Service "Window Covering"
// */
//
// Service.WindowCovering = function(displayName, subtype) {
// Service.call(this, displayName, '0000008C-0000-1000-8000-0026BB765291', subtype);
//
// // Required Characteristics
// this.addCharacteristic(Characteristic.CurrentPosition);
// this.addCharacteristic(Characteristic.TargetPosition);
// this.addCharacteristic(Characteristic.PositionState);
//
// // Optional Characteristics
// this.addOptionalCharacteristic(Characteristic.HoldPosition);
// this.addOptionalCharacteristic(Characteristic.TargetHorizontalTiltAngle);
// this.addOptionalCharacteristic(Characteristic.TargetVerticalTiltAngle);
// this.addOptionalCharacteristic(Characteristic.CurrentHorizontalTiltAngle);
// this.addOptionalCharacteristic(Characteristic.CurrentVerticalTiltAngle);
// this.addOptionalCharacteristic(Characteristic.ObstructionDetected);
// this.addOptionalCharacteristic(Characteristic.Name);
// };
getWindowCoveringService: function(config) { getWindowCoveringService: function(config) {
/**
// Optional Characteristics
this.addOptionalCharacteristic(Characteristic.HoldPosition);
this.addOptionalCharacteristic(Characteristic.TargetHorizontalTiltAngle);
this.addOptionalCharacteristic(Characteristic.TargetVerticalTiltAngle);
this.addOptionalCharacteristic(Characteristic.CurrentHorizontalTiltAngle);
this.addOptionalCharacteristic(Characteristic.CurrentVerticalTiltAngle);
this.addOptionalCharacteristic(Characteristic.ObstructionDetected);
*/
// some sanity checks // some sanity checks
if (config.type !== "WindowCovering") { if (config.type !== "WindowCovering") {
this.log("[ERROR] WindowCovering Service for non 'WindowCovering' service called"); this.log("[ERROR] WindowCovering Service for non 'WindowCovering' service called");
return undefined; return undefined;
@@ -692,8 +757,8 @@ KNXDevice.prototype = {
this.log("[ERROR] WindowCovering Service without 'name' property called"); this.log("[ERROR] WindowCovering Service without 'name' property called");
return undefined; return undefined;
} }
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("WindowCovering CurrentPosition characteristic enabled");
this.bindCharacteristic(myService, Characteristic.CurrentPosition, "Percent", config.CurrentPosition); this.bindCharacteristic(myService, Characteristic.CurrentPosition, "Percent", config.CurrentPosition);
@@ -709,69 +774,10 @@ KNXDevice.prototype = {
return myService; return myService;
}, },
// Service.ContactSensor = function(displayName, subtype) {
// Service.call(this, displayName, '00000080-0000-1000-8000-0026BB765291', subtype);
//
// // Required Characteristics
// this.addCharacteristic(Characteristic.ContactSensorState);
//
// // Optional Characteristics
// this.addOptionalCharacteristic(Characteristic.StatusActive);
// this.addOptionalCharacteristic(Characteristic.StatusFault);
// this.addOptionalCharacteristic(Characteristic.StatusTampered);
// this.addOptionalCharacteristic(Characteristic.StatusLowBattery);
// this.addOptionalCharacteristic(Characteristic.Name);
// };
// Characteristic.ContactSensorState.CONTACT_DETECTED = 0;
// Characteristic.ContactSensorState.CONTACT_NOT_DETECTED = 1;
getContactSenserService: function(config) {
// some sanity checks
if (config.type !== "ContactSensor") {
this.log("[ERROR] ContactSensor Service for non 'ContactSensor' service called");
return undefined;
}
if (!config.name) {
this.log("[ERROR] ContactSensor Service without 'name' property called");
return undefined;
}
var myService = new Service.ContactSensor(config.name,config.name);
if (config.ContactSensorState) {
this.log("ContactSensor ContactSensorState characteristic enabled");
this.bindCharacteristic(myService, Characteristic.ContactSensorState, "Bool", config.ContactSensorState);
} else if (config.ContactSensorStateContact1) {
this.log("ContactSensor ContactSensorStateContact1 characteristic enabled");
this.bindCharacteristic(myService, Characteristic.ContactSensorState, "BoolReverse", config.ContactSensorStateContact1);
}
//optionals
if (config.StatusActive) {
this.log("ContactSensor StatusActive characteristic enabled");
myService.addCharacteristic(Characteristic.StatusActive);
this.bindCharacteristic(myService, Characteristic.StatusActive, "Bool", config.StatusActive);
}
if (config.StatusFault) {
this.log("ContactSensor StatusFault characteristic enabled");
myService.addCharacteristic(Characteristic.StatusFault);
this.bindCharacteristic(myService, Characteristic.StatusFault, "Bool", config.StatusFault);
}
if (config.StatusTampered) {
this.log("ContactSensor StatusTampered characteristic enabled");
myService.addCharacteristic(Characteristic.StatusTampered);
this.bindCharacteristic(myService, Characteristic.StatusTampered, "Bool", config.StatusTampered);
}
if (config.StatusLowBattery) {
this.log("ContactSensor StatusLowBattery characteristic enabled");
myService.addCharacteristic(Characteristic.StatusLowBattery);
this.bindCharacteristic(myService, Characteristic.StatusLowBattery, "Bool", config.StatusLowBattery);
}
return myService;
},
/* assemble the device ***************************************************************************************************/ /* assemble the device ***************************************************************************************************/
getServices: function() { getServices: function() {
// you can OPTIONALLY create an information service if you wish to override // you can OPTIONALLY create an information service if you wish to override
@@ -788,8 +794,8 @@ KNXDevice.prototype = {
accessoryServices.push(informationService); accessoryServices.push(informationService);
iterate(this.config); //iterate(this.config);
// throw new Error("STOP");
if (!this.config.services){ if (!this.config.services){
this.log("No services found in accessory?!") this.log("No services found in accessory?!")
} }
@@ -811,9 +817,15 @@ KNXDevice.prototype = {
case "Lightbulb": case "Lightbulb":
accessoryServices.push(this.getLightbulbService(configService)); accessoryServices.push(this.getLightbulbService(configService));
break; break;
case "LightSensor":
accessoryServices.push(this.getLightSensorService(configService));
break;
case "LockMechanism": case "LockMechanism":
accessoryServices.push(this.getLockMechanismService(configService)); accessoryServices.push(this.getLockMechanismService(configService));
break; break;
case "Switch":
accessoryServices.push(this.getSwitchService(configService));
break;
case "TemperatureSensor": case "TemperatureSensor":
accessoryServices.push(this.getTemperatureSensorService(configService)); accessoryServices.push(this.getTemperatureSensorService(configService));
break; break;

126
accessories/knxdevice.md
View File

@@ -1,126 +0,0 @@
# Syntax of the config.json
In the platforms section, you can insert a KNX type platform.
You need to configure all devices directly in the config.json.
"platforms": [
{
"platform": "KNX",
"name": "KNX",
"knxd_ip": "192.168.178.205",
"knxd_port": 6720,
"accessories": [
{
"accessory_type": "knxdevice",
"name": "Living Room North Lamp",
"services": [
{
"type": "Lightbulb",
"description": "iOS8 Lightbulb type, supports On (Switch) and Brightness",
"name": "Living Room North Lamp",
"On": {
"Set": "1/1/6",
"Listen": [
"1/1/63"
]
},
"Brightness": {
"Set": "1/1/62",
"Listen": [
"1/1/64"
]
}
}
]
}
}
In the accessories section (the array within the brackets [ ]) you can insert as many objects as you like in the following form
{
"accessory_type": "knxdevice",
"name": "Here goes your display name, this will be shown in HomeKit apps",
"services": [
{
}
]
}
You have to add services in the following syntax:
{
"type": "SERVICENAME",
"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",
"CHARACTERISTIC1": {
"Set": "1/1/6",
"Listen": [
"1/1/63"
]
},
"CHARACTERISTIC2": {
"Set": "1/1/62",
"Listen": [
"1/1/64"
]
}
}
CHARACTERISTIC are properties that are dependent on the service type, so they are listed below.
Two kinds of addresses are supported: "Set":"1/2/3" is a writable group address, to which changes are sent if the service supports changing values. Changes on the bus are listened to, too.
"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 read requests to ALL addresses listed in Set: and in Listen:
# Supported Services and their characteristics
## Lightbulb
On: DPT 1, 1 as on, 0 as off
Brightness: DPT5 percentage, 100% (=255) the brightest
## LockMechanism
LockCurrentState: DPT 1, 1 as secured
OR (but not both:)
LockCurrentStateSecured0: DPT 1, 0 as secured
LockTargetState: DPT 1, 1 as secured
LockTargetStateSecured0: DPT 1, 0 as secured
## Thermostat
CurrentTemperature: DPT9 in °C [listen only]
TargetTemperature: DPT9, values 0..40°C only, all others are ignored
CurrentHeatingCoolingState: DPT5 HVAC, because of the incompatible mapping only off and heating (=auto) are shown, [listen only]
TargetHeatingCoolingState: as above
## TemperatureSensor
CurrentTemperature: DPT9 in °C [listen only]
## Window
CurrentPosition: DPT5 percentage
TargetPosition: DPT5 percentage
PositionState: DPT5 value [listen only]
## WindowCovering
CurrentPosition: DPT5 percentage
TargetPosition: DPT5 percentage
PositionState: DPT5 value [listen only]
### not yet supported
HoldPosition
TargetHorizontalTiltAngle
TargetVerticalTiltAngle
CurrentHorizontalTiltAngle
CurrentVerticalTiltAngle
ObstructionDetected
## ContactSensor
ContactSensorState: DPT 1, 0 as contact
OR
ContactSensorStateContact1: DPT 1, 1 as contact
StatusActive: DPT 1, 1 as true
StatusFault: DPT 1, 1 as true
StatusTampered: DPT 1, 1 as true
StatusLowBattery: DPT 1, 1 as true
# DISCLAIMER
This is work in progress!

0
platforms/config-sample-knx.json → platforms/KNX-sample-config.json
View File

134
platforms/KNX.md Normal file
View File

@@ -0,0 +1,134 @@
# Syntax of the config.json
In the platforms section, you can insert a KNX type platform.
You need to configure all devices directly in the config.json.
````json
"platforms": [
{
"platform": "KNX",
"name": "KNX",
"knxd_ip": "192.168.178.205",
"knxd_port": 6720,
"accessories": [
{
"accessory_type": "knxdevice",
"name": "Living Room North Lamp",
"services": [
{
"type": "Lightbulb",
"description": "iOS8 Lightbulb type, supports On (Switch) and Brightness",
"name": "Living Room North Lamp",
"On": {
"Set": "1/1/6",
"Listen": ["1/1/63"]
},
"Brightness": {
"Set": "1/1/62",
"Listen": ["1/1/64"]
}
}
]
}
]
}
````
In the accessories section (the array within the brackets [ ]) you can insert as many objects as you like in the following form
````json
{
"accessory_type": "knxdevice",
"name": "Here goes your display name, this will be shown in HomeKit apps",
"services": [
{
}
]
}
````
You have to add services in the following syntax:
````json
{
"type": "SERVICENAME",
"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",
"CHARACTERISTIC1": {
"Set": "1/1/6",
"Listen": [
"1/1/63"
]
},
"CHARACTERISTIC2": {
"Set": "1/1/62",
"Listen": [
"1/1/64"
]
}
}
````
`CHARACTERISTICx` are properties that are dependent on the service type, so they are listed below.
Two kinds of addresses are supported: `"Set":"1/2/3"` is a writable group address, to which changes are sent if the service supports changing values. Changes on the bus are listened to, too.
`"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:`
# Supported Services and their characteristics
## ContactSensor
- ContactSensorState: DPT 1, 0 as contact **OR**
- ContactSensorStateContact1: DPT 1, 1 as contact
- StatusActive: DPT 1, 1 as true
- StatusFault: DPT 1, 1 as true
- StatusTampered: DPT 1, 1 as true
- StatusLowBattery: DPT 1, 1 as true
## Lightbulb
- On: DPT 1, 1 as on, 0 as off
- Brightness: DPT5 percentage, 100% (=255) the brightest
## LightSensor
- CurrentAmbientLightLevel: DPT 9, 0 to 100000 Lux
## LockMechanism
- LockCurrentState: DPT 1, 1 as secured **OR (but not both:)**
- LockCurrentStateSecured0: DPT 1, 0 as secured
- LockTargetState: DPT 1, 1 as secured **OR**
- LockTargetStateSecured0: DPT 1, 0 as secured
## Outlet
- On: DPT 1, 1 as on, 0 as off
- OutletInUse: DPT 1, 1 as on, 0 as off
## Switch
- On: DPT 1, 1 as on, 0 as off
## TemperatureSensor
- CurrentTemperature: DPT9 in °C [listen only]
## Thermostat
- CurrentTemperature: DPT9 in °C [listen only]
- TargetTemperature: DPT9, values 0..40°C only, all others are ignored
- CurrentHeatingCoolingState: DPT5 HVAC, because of the incompatible mapping only off and heating (=auto) are shown, [listen only]
- TargetHeatingCoolingState: as above
## Window
- CurrentPosition: DPT5 percentage
- TargetPosition: DPT5 percentage
- PositionState: DPT5 value [listen only]
## WindowCovering
- CurrentPosition: DPT5 percentage
- TargetPosition: DPT5 percentage
- PositionState: DPT5 value [listen only]
### not yet supported
- HoldPosition
- TargetHorizontalTiltAngle
- TargetVerticalTiltAngle
- CurrentHorizontalTiltAngle
- CurrentVerticalTiltAngle
- ObstructionDetected
# DISCLAIMER
**This is work in progress!**