mirror of
https://github.com/mtan93/homebridge.git
synced 2026-03-08 05:31:55 +00:00
Merge pull request #299 from KraigM/feature/Harmony
Enhanced and Fixed Logitech Harmony
This commit is contained in:
Nick Farina
@@ -20,7 +20,7 @@
|
||||
"eibd": "^0.3.1",
|
||||
"elkington": "kevinohara80/elkington",
|
||||
"hap-nodejs": "^0.0.2",
|
||||
"harmonyhubjs-client": "^1.1.4",
|
||||
"harmonyhubjs-client": "^1.1.6",
|
||||
"harmonyhubjs-discover": "git+https://github.com/swissmanu/harmonyhubjs-discover.git",
|
||||
"isy-js": "",
|
||||
"komponist": "0.1.0",
|
||||
@@ -31,7 +31,9 @@
|
||||
"node-icontrol": "^0.1.5",
|
||||
"node-milight-promise": "0.0.x",
|
||||
"node-persist": "0.0.x",
|
||||
"node-xmpp-client": "1.0.0-alpha23",
|
||||
"q": "1.4.x",
|
||||
"queue": "^3.1.0",
|
||||
"request": "2.49.x",
|
||||
"sonos": "0.8.x",
|
||||
"telldus-live": "^0.2.1",
|
||||
|
||||
@@ -24,6 +24,13 @@ var harmony = require('harmonyhubjs-client');
|
||||
|
||||
var _harmonyHubPort = 61991;
|
||||
|
||||
var Service = require("hap-nodejs").Service;
|
||||
var Characteristic = require("hap-nodejs").Characteristic;
|
||||
var Accessory = require("hap-nodejs").Accessory;
|
||||
var uuid = require("hap-nodejs").uuid;
|
||||
var inherits = require('util').inherits;
|
||||
var queue = require('queue');
|
||||
|
||||
|
||||
function sortByKey (array, key) {
|
||||
return array.sort(function(a, b) {
|
||||
@@ -41,265 +48,220 @@ function LogitechHarmonyPlatform (log, config) {
|
||||
|
||||
LogitechHarmonyPlatform.prototype = {
|
||||
|
||||
// Find one Harmony remote hub (only support one for now)
|
||||
locateHub: function (callback) {
|
||||
var self = this;
|
||||
|
||||
// Connect to a Harmony hub
|
||||
var createClient = function (ipAddress) {
|
||||
self.log("Connecting to Logitech Harmony remote hub...");
|
||||
|
||||
harmony(ipAddress)
|
||||
.then(function (client) {
|
||||
self.log("Connected to Logitech Harmony remote hub");
|
||||
|
||||
callback(null, client);
|
||||
});
|
||||
};
|
||||
|
||||
// Use the ip address in configuration if available
|
||||
if (this.ip_address) {
|
||||
console.log("Using Logitech Harmony hub ip address from configuration");
|
||||
|
||||
return createClient(this.ip_address)
|
||||
}
|
||||
|
||||
this.log("Searching for Logitech Harmony remote hubs...");
|
||||
|
||||
// Discover the harmony hub with bonjour
|
||||
var discover = new harmonyDiscover(_harmonyHubPort);
|
||||
|
||||
// TODO: Support update event with some way to add accessories
|
||||
// TODO: Have some kind of timeout with an error message. Right now this searches forever until it finds one hub.
|
||||
discover.on('online', function (hubInfo) {
|
||||
self.log("Found Logitech Harmony remote hub: " + hubInfo.ip);
|
||||
|
||||
// Stop looking for hubs once we find the first one
|
||||
// TODO: Support multiple hubs
|
||||
discover.stop();
|
||||
|
||||
createClient(hubInfo.ip);
|
||||
});
|
||||
|
||||
// Start looking for hubs
|
||||
discover.start();
|
||||
},
|
||||
|
||||
accessories: function (callback) {
|
||||
var self = this;
|
||||
var plat = this;
|
||||
var foundAccessories = [];
|
||||
var activityAccessories = [];
|
||||
var hub = null;
|
||||
var hubIP = null;
|
||||
var hubQueue = queue();
|
||||
hubQueue.concurrency = 1;
|
||||
|
||||
// Get the first hub
|
||||
this.locateHub(function (err, hub) {
|
||||
locateHub(function (err, client, clientIP) {
|
||||
if (err) throw err;
|
||||
|
||||
self.log("Fetching Logitech Harmony devices and activites...");
|
||||
plat.log("Fetching Logitech Harmony devices and activites...");
|
||||
|
||||
hub = client;
|
||||
hubIP = clientIP;
|
||||
//getDevices(hub);
|
||||
getActivities(hub);
|
||||
getActivities();
|
||||
});
|
||||
|
||||
// Get Harmony Devices
|
||||
/*
|
||||
var getDevices = function(hub) {
|
||||
self.log("Fetching Logitech Harmony devices...");
|
||||
// Find one Harmony remote hub (only support one for now)
|
||||
function locateHub(callback) {
|
||||
// Use the ip address in configuration if available
|
||||
if (plat.ip_address) {
|
||||
console.log("Using Logitech Harmony hub ip address from configuration");
|
||||
|
||||
hub.getDevices()
|
||||
.then(function (devices) {
|
||||
self.log("Found devices: ", devices);
|
||||
return createClient(plat.ip_address, callback)
|
||||
}
|
||||
|
||||
var sArray = sortByKey(json['result'],"Name");
|
||||
plat.log("Searching for Logitech Harmony remote hubs...");
|
||||
|
||||
sArray.map(function(s) {
|
||||
accessory = new LogitechHarmonyAccessory(self.log, self.server, self.port, false, s.idx, s.Name, s.HaveDimmer, s.MaxDimLevel, (s.SubType=="RGB")||(s.SubType=="RGBW"));
|
||||
foundAccessories.push(accessory);
|
||||
// Discover the harmony hub with bonjour
|
||||
var discover = new harmonyDiscover(_harmonyHubPort);
|
||||
|
||||
// TODO: Support update event with some way to add accessories
|
||||
// TODO: Have some kind of timeout with an error message. Right now this searches forever until it finds one hub.
|
||||
discover.on('online', function (hubInfo) {
|
||||
plat.log("Found Logitech Harmony remote hub: " + hubInfo.ip);
|
||||
|
||||
// Stop looking for hubs once we find the first one
|
||||
// TODO: Support multiple hubs
|
||||
discover.stop();
|
||||
|
||||
createClient(hubInfo.ip, callback);
|
||||
});
|
||||
|
||||
// Start looking for hubs
|
||||
discover.start();
|
||||
}
|
||||
|
||||
// Connect to a Harmony hub
|
||||
function createClient(ipAddress, callback) {
|
||||
plat.log("Connecting to Logitech Harmony remote hub...");
|
||||
harmony(ipAddress)
|
||||
.then(function (client) {
|
||||
plat.log("Connected to Logitech Harmony remote hub");
|
||||
callback(null, client, ipAddress);
|
||||
});
|
||||
|
||||
callback(foundAccessories);
|
||||
});
|
||||
};
|
||||
*/
|
||||
}
|
||||
|
||||
// Get Harmony Activities
|
||||
var getActivities = function(hub) {
|
||||
self.log("Fetching Logitech Harmony activities...");
|
||||
function getActivities() {
|
||||
plat.log("Fetching Logitech Harmony activities...");
|
||||
|
||||
hub.getActivities()
|
||||
.then(function (activities) {
|
||||
self.log("Found activities: \n" + activities.map(function (a) { return "\t" + a.label; }).join("\n"));
|
||||
plat.log("Found activities: \n" + activities.map(function (a) { return "\t" + a.label; }).join("\n"));
|
||||
|
||||
var sArray = sortByKey(activities, "label");
|
||||
|
||||
sArray.map(function(s) {
|
||||
var accessory = new LogitechHarmonyAccessory(self.log, hub, s, true);
|
||||
// TODO: Update the initial power state
|
||||
foundAccessories.push(accessory);
|
||||
hub.getCurrentActivity().then(function (currentActivity) {
|
||||
var actAccessories = [];
|
||||
var sArray = sortByKey(activities, "label");
|
||||
sArray.map(function(s) {
|
||||
var accessory = createActivityAccessory(s);
|
||||
if (accessory.id > 0) {
|
||||
accessory.updateActivityState(currentActivity);
|
||||
actAccessories.push(accessory);
|
||||
foundAccessories.push(accessory);
|
||||
}
|
||||
});
|
||||
activityAccessories = actAccessories;
|
||||
keepAliveRefreshLoop();
|
||||
callback(foundAccessories);
|
||||
}).catch(function (err) {
|
||||
plat.log('Unable to get current activity with error', err);
|
||||
throw err;
|
||||
});
|
||||
|
||||
callback(foundAccessories);
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
function createActivityAccessory(activity) {
|
||||
var accessory = new LogitechHarmonyActivityAccessory(plat.log, activity, changeCurrentActivity.bind(plat), -1);
|
||||
return accessory;
|
||||
}
|
||||
|
||||
var isChangingActivity = false;
|
||||
function changeCurrentActivity(nextActivity, callback) {
|
||||
if (!nextActivity) {
|
||||
nextActivity = -1;
|
||||
}
|
||||
plat.log('Queue activity to ' + nextActivity);
|
||||
executeOnHub(function(h, cb) {
|
||||
plat.log('Set activity to ' + nextActivity);
|
||||
h.startActivity(nextActivity)
|
||||
.then(function () {
|
||||
cb();
|
||||
isChangingActivity = false;
|
||||
plat.log('Finished setting activity to ' + nextActivity);
|
||||
updateCurrentActivity(nextActivity);
|
||||
if (callback) callback(null, nextActivity);
|
||||
})
|
||||
.catch(function (err) {
|
||||
cb();
|
||||
isChangingActivity = false;
|
||||
plat.log('Failed setting activity to ' + nextActivity + ' with error ' + err);
|
||||
if (callback) callback(err);
|
||||
});
|
||||
}, function(){
|
||||
callback(Error("Set activity failed too many times"));
|
||||
});
|
||||
}
|
||||
|
||||
function updateCurrentActivity(currentActivity) {
|
||||
var actAccessories = activityAccessories;
|
||||
if (actAccessories instanceof Array) {
|
||||
actAccessories.map(function(a) { a.updateActivityState(currentActivity); });
|
||||
}
|
||||
}
|
||||
|
||||
// prevent connection from closing
|
||||
function keepAliveRefreshLoop() {
|
||||
setTimeout(function() {
|
||||
setInterval(function() {
|
||||
executeOnHub(function(h, cb) {
|
||||
plat.log("Refresh Status");
|
||||
h.getCurrentActivity()
|
||||
.then(function(currentActivity){
|
||||
cb();
|
||||
updateCurrentActivity(currentActivity);
|
||||
})
|
||||
.catch(cb);
|
||||
});
|
||||
}, 20000);
|
||||
}, 5000);
|
||||
}
|
||||
|
||||
function executeOnHub(func, funcMaxTimeout)
|
||||
{
|
||||
if (!func) return;
|
||||
hubQueue.push(function(cb) {
|
||||
var tout = setTimeout(function(){
|
||||
plat.log("Reconnecting to Hub " + hubIP);
|
||||
createClient(hubIP, function(err, newHub){
|
||||
if (err) throw err;
|
||||
hub = newHub;
|
||||
if (funcMaxTimeout) {
|
||||
funcMaxTimeout();
|
||||
}
|
||||
cb();
|
||||
});
|
||||
}, 30000);
|
||||
func(hub, function(){
|
||||
clearTimeout(tout);
|
||||
cb();
|
||||
});
|
||||
});
|
||||
if (!hubQueue.running){
|
||||
hubQueue.start();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
|
||||
function LogitechHarmonyAccessory (log, hub, details, isActivity) {
|
||||
function LogitechHarmonyActivityAccessory (log, details, changeCurrentActivity) {
|
||||
this.log = log;
|
||||
this.hub = hub;
|
||||
this.details = details;
|
||||
this.id = details.id;
|
||||
this.name = details.label;
|
||||
this.isActivity = isActivity;
|
||||
this.isActivityActive = false;
|
||||
this.isOn = false;
|
||||
this.changeCurrentActivity = changeCurrentActivity;
|
||||
Accessory.call(this, this.name, uuid.generate(this.id));
|
||||
var self = this;
|
||||
|
||||
this.getService(Service.AccessoryInformation)
|
||||
.setCharacteristic(Characteristic.Manufacturer, "Logitech")
|
||||
.setCharacteristic(Characteristic.Model, "Harmony")
|
||||
// TODO: Add hub unique id to this for people with multiple hubs so that it is really a guid.
|
||||
.setCharacteristic(Characteristic.SerialNumber, this.id);
|
||||
|
||||
this.addService(Service.Switch)
|
||||
.getCharacteristic(Characteristic.On)
|
||||
.on('get', function(callback) {
|
||||
// Refreshed automatically by platform
|
||||
callback(null, self.isOn);
|
||||
})
|
||||
.on('set', this.setPowerState.bind(this));
|
||||
|
||||
}
|
||||
inherits(LogitechHarmonyActivityAccessory, Accessory);
|
||||
LogitechHarmonyActivityAccessory.prototype.parent = Accessory.prototype;
|
||||
LogitechHarmonyActivityAccessory.prototype.getServices = function() {
|
||||
return this.services;
|
||||
};
|
||||
|
||||
|
||||
LogitechHarmonyAccessory.prototype = {
|
||||
|
||||
// TODO: Somehow make this event driven so that it tells the user what activity is on
|
||||
getPowerState: function (callback) {
|
||||
var self = this;
|
||||
|
||||
if (this.isActivity) {
|
||||
hub.getCurrentActivity().then(function (currentActivity) {
|
||||
callback(currentActivity.id === self.id);
|
||||
}).except(function (err) {
|
||||
self.log('Unable to get current activity with error', err);
|
||||
callback(false);
|
||||
});
|
||||
} else {
|
||||
// TODO: Support onRead for devices
|
||||
this.log('TODO: Support onRead for devices');
|
||||
}
|
||||
},
|
||||
|
||||
setPowerState: function (state, callback) {
|
||||
var self = this;
|
||||
|
||||
if (this.isActivity) {
|
||||
this.log('Set activity ' + this.name + ' power state to ' + state);
|
||||
|
||||
// Activity id -1 is turn off all devices
|
||||
var id = state ? this.id : -1;
|
||||
|
||||
this.hub.startActivity(id)
|
||||
.then(function () {
|
||||
self.log('Finished setting activity ' + self.name + ' power state to ' + state);
|
||||
callback();
|
||||
})
|
||||
.catch(function (err) {
|
||||
self.log('Failed setting activity ' + self.name + ' power state to ' + state + ' with error ' + err);
|
||||
callback(err);
|
||||
});
|
||||
} else {
|
||||
// TODO: Support setting device power
|
||||
this.log('TODO: Support setting device power');
|
||||
callback();
|
||||
}
|
||||
},
|
||||
|
||||
getServices: function () {
|
||||
var self = this;
|
||||
|
||||
return [
|
||||
{
|
||||
sType: types.ACCESSORY_INFORMATION_STYPE,
|
||||
characteristics: [
|
||||
{
|
||||
cType: types.NAME_CTYPE,
|
||||
onUpdate: null,
|
||||
perms: ["pr"],
|
||||
format: "string",
|
||||
initialValue: self.name,
|
||||
supportEvents: false,
|
||||
supportBonjour: false,
|
||||
manfDescription: "Name of the accessory",
|
||||
designedMaxLength: 255
|
||||
},
|
||||
{
|
||||
cType: types.MANUFACTURER_CTYPE,
|
||||
onUpdate: null,
|
||||
perms: ["pr"],
|
||||
format: "string",
|
||||
initialValue: "Logitech",
|
||||
supportEvents: false,
|
||||
supportBonjour: false,
|
||||
manfDescription: "Manufacturer",
|
||||
designedMaxLength: 255
|
||||
},
|
||||
{
|
||||
cType: types.MODEL_CTYPE,
|
||||
onUpdate: null,
|
||||
perms: ["pr"],
|
||||
format: "string",
|
||||
initialValue: "Harmony",
|
||||
supportEvents: false,
|
||||
supportBonjour: false,
|
||||
manfDescription: "Model",
|
||||
designedMaxLength: 255
|
||||
},
|
||||
{
|
||||
cType: types.SERIAL_NUMBER_CTYPE,
|
||||
onUpdate: null,
|
||||
perms: ["pr"],
|
||||
format: "string",
|
||||
// TODO: Add hub unique id to this for people with multiple hubs so that it is really a guid.
|
||||
initialValue: self.id,
|
||||
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
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
sType: types.SWITCH_STYPE,
|
||||
characteristics: [
|
||||
{
|
||||
cType: types.NAME_CTYPE,
|
||||
onUpdate: null,
|
||||
perms: ["pr"],
|
||||
format: "string",
|
||||
initialValue: self.name,
|
||||
supportEvents: true,
|
||||
supportBonjour: false,
|
||||
manfDescription: "Name of service",
|
||||
designedMaxLength: 255
|
||||
},
|
||||
{
|
||||
cType: types.POWER_STATE_CTYPE,
|
||||
onUpdate: function (value) {
|
||||
self.setPowerState(value)
|
||||
},
|
||||
onRead: self.getPowerState,
|
||||
perms: ["pw","pr","ev"],
|
||||
format: "bool",
|
||||
initialValue: 0,
|
||||
supportEvents: true,
|
||||
supportBonjour: false,
|
||||
manfDescription: "Change the power state",
|
||||
designedMaxLength: 1
|
||||
}
|
||||
]
|
||||
}
|
||||
];
|
||||
}
|
||||
|
||||
LogitechHarmonyActivityAccessory.prototype.updateActivityState = function (currentActivity) {
|
||||
this.isOn = (currentActivity === this.id);
|
||||
// Force get to trigger 'change' if needed
|
||||
this.getService(Service.Switch)
|
||||
.getCharacteristic(Characteristic.On)
|
||||
.getValue();
|
||||
};
|
||||
|
||||
LogitechHarmonyActivityAccessory.prototype.setPowerState = function (state, callback) {
|
||||
this.changeCurrentActivity(state ? this.id : null, callback);
|
||||
};
|
||||
|
||||
module.exports.accessory = LogitechHarmonyAccessory;
|
||||
module.exports.platform = LogitechHarmonyPlatform;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user