mirror of
https://github.com/mtan93/homebridge.git
synced 2026-03-08 05:31:55 +00:00
7f14df0434
LightwaveRF lights could not be dimmed properly as they require a dim level of betwene 0-32. The Domoticz documentation incorrectly states this should be 0-16. Other devices may use different values which is why the MaxDimLevel property should be used rather than hardcoded value. Also refactored the code slightly.
379 lines
11 KiB
JavaScript
379 lines
11 KiB
JavaScript
// Domoticz Platform Shim for HomeBridge
|
|
// Written by Joep Verhaeg (http://www.joepverhaeg.nl)
|
|
//
|
|
// Revisions:
|
|
//
|
|
// 12 June 2015 [GizMoCuz]
|
|
// - Added support for RGB lights
|
|
// - Added support for Scenes
|
|
// - Sorting device names
|
|
//
|
|
// 22 July 2015 [lukeredpath]
|
|
// - Added SSL and basic auth support
|
|
//
|
|
// 26 August 2015 [EddyK69]
|
|
// - Added parameter in config.json: 'loadscenes' for enabling/disabling loading scenes
|
|
// - Fixed issue with dimmer-range; was 0-100, should be 0-16
|
|
//
|
|
// 27 August 2015 [EddyK69]
|
|
// - Fixed issue that 'on/off'-type lights showed as dimmers in HomeKit. Checking now on SwitchType instead of HaveDimmer
|
|
// - Fixed issue that 'on-off'-type lights would not react on Siri 'Switch on/off light'; On/Off types are now handled as Lights instead of Switches
|
|
// (Cannot determine if 'on/off'-type device is a Light or a Switch :( )
|
|
//
|
|
// 14 September 2015 [lukeredpath]
|
|
// - Fixed incorrect dimmer range for LightwaveRF lights (0-32 required, MaxDimLevel should be honored)
|
|
//
|
|
//
|
|
// Domoticz JSON API required
|
|
// https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's#Lights_and_switches
|
|
//
|
|
// Remember to add platform to config.json. Example:
|
|
// "platforms": [
|
|
// {
|
|
// "platform": "Domoticz",
|
|
// "name": "Domoticz",
|
|
// "server": "127.0.0.1",
|
|
// "port": "8080",
|
|
// "roomid": 123, (0=no roomplan)
|
|
// "loadscenes": 1 (0=disable scenes)
|
|
// }
|
|
// ],
|
|
//
|
|
// If your server uses HTTPS, you can specify "ssl": true in your config. If
|
|
// your server uses a self-signed certificate, you'll need to run the following
|
|
// before starting the server or you will get an error:
|
|
//
|
|
// export NODE_TLS_REJECT_UNAUTHORIZED=0
|
|
//
|
|
// For basic auth support, specify the "user" and "password" in your config.
|
|
//
|
|
// When you attempt to add a device, it will ask for a "PIN code".
|
|
// The default code for all HomeBridge accessories is 031-45-154.
|
|
//
|
|
var types = require("HAP-NodeJS/accessories/types.js");
|
|
var request = require("request");
|
|
|
|
function DomoticzPlatform(log, config){
|
|
this.log = log;
|
|
this.user = config["user"];
|
|
this.password = config["password"];
|
|
this.server = config["server"];
|
|
this.port = config["port"];
|
|
this.protocol = config["ssl"] ? "https" : "http";
|
|
this.roomid = 0;
|
|
if (typeof config["roomid"] != 'undefined') {
|
|
this.roomid = config["roomid"];
|
|
}
|
|
this.loadscenes = 1;
|
|
if (typeof config["loadscenes"] != 'undefined') {
|
|
this.loadscenes = config["loadscenes"];
|
|
}
|
|
}
|
|
|
|
function sortByKey(array, key) {
|
|
return array.sort(function(a, b) {
|
|
var x = a[key]; var y = b[key];
|
|
return ((x < y) ? -1 : ((x > y) ? 1 : 0));
|
|
});
|
|
}
|
|
|
|
DomoticzPlatform.prototype = {
|
|
urlForQuery: function(query) {
|
|
var serverString = this.server;
|
|
if (this.user && this.password) {
|
|
serverString = this.user + ":" + this.password + "@" + serverString;
|
|
}
|
|
return this.protocol + "://" + serverString + ":" + this.port + "/json.htm?" + query;
|
|
},
|
|
|
|
accessories: function(callback) {
|
|
this.log("Fetching Domoticz lights and switches...");
|
|
var that = this;
|
|
var foundAccessories = [];
|
|
|
|
// mechanism to ensure callback is only executed once all requests complete
|
|
var asyncCalls = 0;
|
|
function callbackLater() { if (--asyncCalls == 0) callback(foundAccessories); }
|
|
|
|
if (this.roomid == 0) {
|
|
//Get Lights
|
|
asyncCalls++;
|
|
request.get({
|
|
url: this.urlForQuery("type=devices&filter=light&used=true&order=Name"),
|
|
json: true
|
|
}, function(err, response, json) {
|
|
if (!err && response.statusCode == 200) {
|
|
if (json['result'] != undefined) {
|
|
var sArray=sortByKey(json['result'],"Name");
|
|
sArray.map(function(s) {
|
|
var havedimmer = (s.SwitchType == 'Dimmer')
|
|
accessory = new DomoticzAccessory(that.log, that, false, s.idx, s.Name, havedimmer, s.MaxDimLevel, (s.SubType=="RGB")||(s.SubType=="RGBW"));
|
|
foundAccessories.push(accessory);
|
|
})
|
|
}
|
|
callbackLater();
|
|
} else {
|
|
that.log("There was a problem connecting to Domoticz. (" + err + ")");
|
|
}
|
|
});
|
|
}
|
|
else {
|
|
//Get all devices specified in the room
|
|
asyncCalls++;
|
|
request.get({
|
|
url: this.urlForQuery("type=devices&plan=" + this.roomid),
|
|
json: true
|
|
}, function(err, response, json) {
|
|
if (!err && response.statusCode == 200) {
|
|
if (json['result'] != undefined) {
|
|
var sArray=sortByKey(json['result'],"Name");
|
|
sArray.map(function(s) {
|
|
//only accept switches for now
|
|
if (typeof s.SwitchType != 'undefined') {
|
|
var havedimmer = (s.SwitchType == 'Dimmer')
|
|
accessory = new DomoticzAccessory(that.log, that, false, s.idx, s.Name, havedimmer, s.MaxDimLevel, (s.SubType=="RGB")||(s.SubType=="RGBW"));
|
|
foundAccessories.push(accessory);
|
|
}
|
|
})
|
|
}
|
|
callbackLater();
|
|
} else {
|
|
that.log("There was a problem connecting to Domoticz.");
|
|
}
|
|
});
|
|
}
|
|
//Get Scenes
|
|
if (this.loadscenes == 1) {
|
|
asyncCalls++;
|
|
request.get({
|
|
url: this.urlForQuery("type=scenes"),
|
|
json: true
|
|
}, function(err, response, json) {
|
|
if (!err && response.statusCode == 200) {
|
|
if (json['result'] != undefined) {
|
|
var sArray=sortByKey(json['result'],"Name");
|
|
sArray.map(function(s) {
|
|
accessory = new DomoticzAccessory(that.log, that, true, s.idx, s.Name, false, 0, false);
|
|
foundAccessories.push(accessory);
|
|
})
|
|
}
|
|
callbackLater();
|
|
} else {
|
|
that.log("There was a problem connecting to Domoticz.");
|
|
}
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
function DomoticzAccessory(log, platform, IsScene, idx, name, HaveDimmer, MaxDimLevel, HaveRGB) {
|
|
// device info
|
|
this.IsScene = IsScene;
|
|
this.idx = idx;
|
|
this.name = name;
|
|
this.HaveDimmer = HaveDimmer;
|
|
this.MaxDimLevel = MaxDimLevel;
|
|
this.HaveRGB = HaveRGB;
|
|
this.log = log;
|
|
this.platform = platform;
|
|
}
|
|
|
|
DomoticzAccessory.prototype = {
|
|
command: function(c,value) {
|
|
this.log(this.name + " sending command " + c + " with value " + value);
|
|
if (this.IsScene == false) {
|
|
//Lights
|
|
if (c == "On" || c == "Off") {
|
|
url = this.platform.urlForQuery("type=command¶m=switchlight&idx=" + this.idx + "&switchcmd=" + c + "&level=0");
|
|
}
|
|
else if (c == "setHue") {
|
|
url = this.platform.urlForQuery("type=command¶m=setcolbrightnessvalue&idx=" + this.idx + "&hue=" + value + "&brightness=100" + "&iswhite=false");
|
|
}
|
|
else if (c == "setLevel") {
|
|
value = this.dimmerLevelForValue(value)
|
|
url = this.platform.urlForQuery("type=command¶m=switchlight&idx=" + this.idx + "&switchcmd=Set%20Level&level=" + value);
|
|
}
|
|
else if (value != undefined) {
|
|
this.log(this.name + " Unhandled Light command! cmd=" + c + ", value=" + value);
|
|
}
|
|
}
|
|
else {
|
|
//Scenes
|
|
if (c == "On" || c == "Off") {
|
|
url = this.platform.urlForQuery("type=command¶m=switchscene&idx=" + this.idx + "&switchcmd=" + c);
|
|
}
|
|
else if (value != undefined) {
|
|
this.log(this.name + " Unhandled Scene command! cmd=" + c + ", value=" + value);
|
|
}
|
|
}
|
|
|
|
var that = this;
|
|
request.put({ url: url }, function(err, response) {
|
|
if (err) {
|
|
that.log("There was a problem sending command " + c + " to" + that.name);
|
|
that.log(url);
|
|
} else {
|
|
that.log(that.name + " sent command " + c + " (value: " + value + ")");
|
|
}
|
|
})
|
|
},
|
|
|
|
// translates the HomeKit dim level as a percentage to whatever scale the device requires
|
|
dimmerLevelForValue: function(value) {
|
|
if (this.MaxDimLevel == 100) {
|
|
return value;
|
|
}
|
|
return Math.round((value / 100.0) * this.MaxDimLevel)
|
|
},
|
|
|
|
informationCharacteristics: function() {
|
|
return [
|
|
{
|
|
cType: types.NAME_CTYPE,
|
|
onUpdate: null,
|
|
perms: ["pr"],
|
|
format: "string",
|
|
initialValue: this.name,
|
|
supportEvents: false,
|
|
supportBonjour: false,
|
|
manfDescription: "Name of the accessory",
|
|
designedMaxLength: 255
|
|
},{
|
|
cType: types.MANUFACTURER_CTYPE,
|
|
onUpdate: null,
|
|
perms: ["pr"],
|
|
format: "string",
|
|
initialValue: "Domoticz",
|
|
supportEvents: false,
|
|
supportBonjour: false,
|
|
manfDescription: "Manufacturer",
|
|
designedMaxLength: 255
|
|
},{
|
|
cType: types.MODEL_CTYPE,
|
|
onUpdate: null,
|
|
perms: ["pr"],
|
|
format: "string",
|
|
initialValue: "Rev-1",
|
|
supportEvents: false,
|
|
supportBonjour: false,
|
|
manfDescription: "Model",
|
|
designedMaxLength: 255
|
|
},{
|
|
cType: types.SERIAL_NUMBER_CTYPE,
|
|
onUpdate: null,
|
|
perms: ["pr"],
|
|
format: "string",
|
|
initialValue: "A1S2NASF88EW",
|
|
supportEvents: false,
|
|
supportBonjour: false,
|
|
manfDescription: "SN",
|
|
designedMaxLength: 255
|
|
},{
|
|
cType: types.IDENTIFY_CTYPE,
|
|
onUpdate: null,
|
|
perms: ["pw"],
|
|
format: "bool",
|
|
initialValue: false,
|
|
supportEvents: false,
|
|
supportBonjour: false,
|
|
manfDescription: "Identify Accessory",
|
|
designedMaxLength: 1
|
|
}
|
|
]
|
|
},
|
|
|
|
controlCharacteristics: function(that) {
|
|
cTypes = [{
|
|
cType: types.NAME_CTYPE,
|
|
onUpdate: null,
|
|
perms: ["pr"],
|
|
format: "string",
|
|
initialValue: this.name,
|
|
supportEvents: true,
|
|
supportBonjour: false,
|
|
manfDescription: "Name of service",
|
|
designedMaxLength: 255
|
|
}]
|
|
|
|
if (this.idx != undefined) {
|
|
cTypes.push({
|
|
cType: types.POWER_STATE_CTYPE,
|
|
onUpdate: function(value) {
|
|
if (value == 0) {
|
|
that.command("Off")
|
|
} else {
|
|
that.command("On")
|
|
}
|
|
},
|
|
perms: ["pw","pr","ev"],
|
|
format: "bool",
|
|
initialValue: 0,
|
|
supportEvents: true,
|
|
supportBonjour: false,
|
|
manfDescription: "Change the power state",
|
|
designedMaxLength: 1
|
|
})
|
|
}
|
|
|
|
if (this.HaveDimmer == true) {
|
|
cTypes.push({
|
|
cType: types.BRIGHTNESS_CTYPE,
|
|
onUpdate: function(value) { that.command("setLevel", value); },
|
|
perms: ["pw","pr","ev"],
|
|
format: "int",
|
|
initialValue: 0,
|
|
supportEvents: true,
|
|
supportBonjour: false,
|
|
manfDescription: "Adjust Brightness of Light",
|
|
designedMinValue: 0,
|
|
designedMaxValue: this.MaxDimLevel,
|
|
designedMinStep: 1,
|
|
unit: "%"
|
|
})
|
|
}
|
|
if (this.HaveRGB == true) {
|
|
cTypes.push({
|
|
cType: types.HUE_CTYPE,
|
|
onUpdate: function(value) { that.command("setHue", value); },
|
|
perms: ["pw","pr","ev"],
|
|
format: "int",
|
|
initialValue: 0,
|
|
supportEvents: true,
|
|
supportBonjour: false,
|
|
manfDescription: "Adjust Hue of Light",
|
|
designedMinValue: 0,
|
|
designedMaxValue: 360,
|
|
designedMinStep: 1,
|
|
unit: "arcdegrees"
|
|
})
|
|
}
|
|
|
|
return cTypes
|
|
},
|
|
|
|
sType: function() {
|
|
//if (this.HaveDimmer == true) {
|
|
return types.LIGHTBULB_STYPE
|
|
//} else {
|
|
// return types.SWITCH_STYPE
|
|
//}
|
|
},
|
|
|
|
getServices: function() {
|
|
var that = this;
|
|
var services = [{
|
|
sType: types.ACCESSORY_INFORMATION_STYPE,
|
|
characteristics: this.informationCharacteristics(),
|
|
},
|
|
{
|
|
sType: this.sType(),
|
|
characteristics: this.controlCharacteristics(that)
|
|
}];
|
|
this.log("Loaded services for " + this.name)
|
|
return services;
|
|
}
|
|
};
|
|
|
|
module.exports.accessory = DomoticzAccessory;
|
|
module.exports.platform = DomoticzPlatform;
|