homebridge-harmony
Version:
Publish your harmony activities as homekit accessories
1,497 lines (1,312 loc) • 62.2 kB
JavaScript
var Service, Characteristic, Accessory, AccessoryType, UUIDGen;
import Harmony from 'harmony-websocket';
import HarmonyConst from './harmonyConst.js';
import HarmonyTools from './harmonyTools.js';
function HarmonyBase(api) {
Service = api.hap.Service;
Characteristic = api.hap.Characteristic;
this.harmony = new Harmony();
this.numberAttemps = 0;
this.numberOfErrors = 0;
this.generalErrorTimer = undefined;
Accessory = api.platformAccessory;
AccessoryType = api.hap.Categories;
UUIDGen = api.hap.uuid;
}
HarmonyBase.prototype = {
//SETUP
configCommonProperties: function (log, config, harmonyPlatform) {
harmonyPlatform.log = log;
harmonyPlatform.hubIP = config['hubIP'];
harmonyPlatform.hubName = config['hubName'];
harmonyPlatform.DELAY_BEFORE_RETRY_AFTER_NETWORK_LOSS = HarmonyTools.checkParameter(
config['DELAY_BEFORE_RETRY_AFTER_NETWORK_LOSS'],
HarmonyConst.DELAY_BEFORE_RETRY_AFTER_NETWORK_LOSS
);
harmonyPlatform.HUB_CONNECT_TIMEOUT = HarmonyTools.checkParameter(
config['HUB_CONNECT_TIMEOUT'],
HarmonyConst.HUB_CONNECT_TIMEOUT
);
harmonyPlatform.HUB_SEND_TIMEOUT = HarmonyTools.checkParameter(
config['HUB_SEND_TIMEOUT'],
HarmonyConst.HUB_SEND_TIMEOUT
);
harmonyPlatform.name = config['name'];
harmonyPlatform.addAllActivitiesToSkippedIfSameStateActivitiesList = HarmonyTools.checkParameter(
config['addAllActivitiesToSkippedIfSameStateActivitiesList'],
false
);
harmonyPlatform.skippedIfSameStateActivities = config['skippedIfSameStateActivities'];
harmonyPlatform.devicesToPublishAsAccessoriesSwitch =
config['devicesToPublishAsAccessoriesSwitch'];
harmonyPlatform.publishDevicesAsIndividualAccessories = HarmonyTools.checkParameter(
config['publishDevicesAsIndividualAccessories'],
true
);
harmonyPlatform.sequencesToPublishAsAccessoriesSwitch =
config['sequencesToPublishAsAccessoriesSwitch'];
harmonyPlatform.publishSequencesAsIndividualAccessories = HarmonyTools.checkParameter(
config['publishSequencesAsIndividualAccessories'],
true
);
harmonyPlatform.homeControlsToPublishAsAccessoriesSwitch =
config['homeControlsToPublishAsAccessoriesSwitch'];
harmonyPlatform.publishHomeControlsAsIndividualAccessories = HarmonyTools.checkParameter(
config['publishHomeControlsAsIndividualAccessories'],
true
);
harmonyPlatform.showCommandsAtStartup = HarmonyTools.checkParameter(
config['showCommandsAtStartup'],
false
);
harmonyPlatform._currentActivity = -9999;
harmonyPlatform._currentActivityLastUpdate = undefined;
harmonyPlatform._currentSetAttemps = 0;
harmonyPlatform._foundAccessories = [];
harmonyPlatform._currentActivity = -1;
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO : following activites controls will be ignored if they are in the same state : ' +
(harmonyPlatform.addAllActivitiesToSkippedIfSameStateActivitiesList
? 'ALL'
: harmonyPlatform.skippedIfSameStateActivities
? harmonyPlatform.skippedIfSameStateActivities
: 'NONE')
);
},
//HUB init
initHub: function (harmonyPlatform) {
this.harmony
.connect(harmonyPlatform.hubIP)
.then(() => this.harmony.getConfig())
.then((response) => {
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'INFO - Hub config : ' + JSON.stringify(response)
);
this.getHomeControlsAccessories(harmonyPlatform).then((responseHome) => {
harmonyPlatform.readAccessories(response, responseHome);
this.numberAttemps = 0;
});
})
.catch((e) => {
this.numberAttemps = this.numberAttemps + 1;
if (this.harmony.isOpened()) {
this.harmony.close().catch((e2) => {
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'Error - Error closing ' + e2.message
);
});
}
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'Error - Error retrieving info from hub : ' +
e.message +
'-(' +
this.numberAttemps +
')'
);
setTimeout(() => {
this.configureAccessories(harmonyPlatform);
}, HarmonyConst.DELAY_BEFORE_RECONNECT);
});
},
//hub discovery events handling
checkHubsFound: function (harmonyPlatform, knownHubsArray) {
if (
knownHubsArray &&
knownHubsArray.length > 1 &&
HarmonyTools.isNil(harmonyPlatform.hubName)
) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'ERROR - Multiple hubs found, you must use hubName or hubIP (only if it is fixed on your router) in your config : ' +
knownHubsArray +
'- platform ' +
harmonyPlatform.name
);
} else if (knownHubsArray) {
for (let hub of knownHubsArray) {
let hubInfo = hub.split('|');
if (HarmonyTools.isNil(harmonyPlatform.hubName) || harmonyPlatform.hubName == hubInfo[1]) {
harmonyPlatform.hubIP = hubInfo[0];
harmonyPlatform.hubRemoteId = hubInfo[2];
this.initHub(harmonyPlatform);
break;
}
}
if (HarmonyTools.isNil(harmonyPlatform.hubRemoteId)) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'ERROR - hub name was not found ' +
harmonyPlatform.hubName +
' is expected, found : ' +
knownHubsArray
);
}
} else {
harmonyPlatform.log('(' + harmonyPlatform.name + ')' + 'ERROR - no hub found ');
}
},
updateHub: function (harmonyPlatform, knownHubsArray) {
var found = false;
for (let hub of knownHubsArray) {
let hubInfo = hub.split('|');
if (harmonyPlatform.hubRemoteId == hubInfo[2]) {
if (harmonyPlatform.hubIP != hubInfo[0]) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - hub IP for ' +
harmonyPlatform.name +
' changed was ' +
harmonyPlatform.hubIP +
' is now : ' +
hubInfo[0]
);
harmonyPlatform.hubIP = hubInfo[0];
this.harmony
.connect(harmonyPlatform.hubIP)
.then(() => {
this.refreshCurrentActivity(harmonyPlatform, () => {});
})
.catch((e3) => {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'Error - Error connecting after IP refreshed ' +
e3.message
);
});
}
found = true;
break;
}
}
if (!found) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'ERROR - hub was not found ' +
harmonyPlatform.name +
' is expected to be found on Id ' +
harmonyPlatform.hubRemoteId +
', found : ' +
knownHubsArray
);
}
},
//Configuration entry point
configureAccessories: function (harmonyPlatform) {
if (HarmonyTools.isPlatformEmpty(harmonyPlatform)) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - platform ' +
harmonyPlatform.name +
' is empty'
);
return;
}
harmonyPlatform.log('(' + harmonyPlatform.name + ')' + 'INFO - Loading activities...');
this.configureHarmonyAPI(harmonyPlatform);
// if it has a fixed ip, won't be autodiscovered
if (HarmonyTools.isNotNil(harmonyPlatform.hubIP)) {
this.initHub(harmonyPlatform);
} else {
harmonyPlatform.mainPlatform.on('discoveredHubs', (knownHubsArray) => {
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'INFO - received discovered hubs ' + knownHubsArray
);
if (HarmonyTools.isNil(harmonyPlatform.hubRemoteId)) {
this.checkHubsFound(harmonyPlatform, knownHubsArray);
} else {
this.harmony.close().catch((e2) => {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'Error - Error closing after hub IP changed ' +
e2.message
);
});
this.updateHub(harmonyPlatform, knownHubsArray);
}
});
}
},
configureHarmonyAPI(harmonyPlatform) {
this.harmony.removeAllListeners();
this.harmony.on('open', () => {
harmonyPlatform.log.debug('(' + harmonyPlatform.name + ')' + 'INFO - socket opened');
});
this.harmony.on('close', () => {
harmonyPlatform.log('(' + harmonyPlatform.name + ')' + 'WARNING - socket closed');
setTimeout(() => {
if (HarmonyTools.isNil(harmonyPlatform.hubRemoteId)) {
this.harmony
.connect(harmonyPlatform.hubIP)
.then(() => {
this.refreshCurrentActivity(harmonyPlatform, () => {});
})
.catch((e3) => {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'Error - Error connecting after socket closed ' +
e3.message
);
});
} else {
harmonyPlatform.mainPlatform.discoverHub();
}
}, HarmonyConst.DELAY_BEFORE_RECONNECT);
});
this.harmony.on('automationState', (message) => {
harmonyPlatform.log.debug(
'INFO - onMessage : Refreshing Home Automation Switch ' + JSON.stringify(message.data)
);
this.refreshHomeSwitch(harmonyPlatform, message.data);
});
this.harmony.on('stateDigest', (message) => {
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO - onMessage : received message : ' +
JSON.stringify(message)
);
if (
(message.data.activityStatus === 2 &&
message.data.activityId === message.data.runningActivityList) ||
(message.data.activityStatus === 0 &&
message.data.activityId === '-1' &&
message.data.runningActivityList === '')
) {
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO - onMessage : Refreshing activity to ' +
message.data.activityId
);
harmonyPlatform.onMessage(message.data.activityId);
}
});
this.harmony.sendTimeout = harmonyPlatform.HUB_SEND_TIMEOUT;
this.harmony.connectTimeout = harmonyPlatform.HUB_CONNECT_TIMEOUT;
},
setupFoundAccessories(harmonyPlatform, accessoriesToAdd, data, homedata) {
this.getGeneralMuteSwitchAccessory(harmonyPlatform, data);
this.getGeneralVolumeSwitchesAccessories(harmonyPlatform, data);
this.getGeneralVolumeSliderAccessory(harmonyPlatform, data);
//creating accessories
for (const accessory of accessoriesToAdd) {
let isTv =
accessory.category === AccessoryType.AUDIO_RECEIVER ||
accessory.category === AccessoryType.TELEVISION;
if (
isTv &&
(harmonyPlatform.mainPlatform._oneTVAdded ||
harmonyPlatform.mainPlatform.publishAllTVAsExternalAccessory)
) {
try {
harmonyPlatform.api.publishExternalAccessories('homebridge-harmony', [accessory]);
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'INFO - setupFoundAccessories - TV accessory added as external accessory'
);
} catch (err) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
"ERROR - readAccessories - Can't publish TV Acccessory as external device, need Homebridge 0.0.47 at least : " +
err
);
}
} else {
if (isTv) {
harmonyPlatform.mainPlatform._oneTVAdded = true;
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - setupFoundAccessories - TV accessory added in your bridge, if another plugin is exposing a TV accessory this one might not be visible in your remote widget'
);
}
this.addAccessories(harmonyPlatform, [accessory]);
}
}
this.getDevicesAccessories(harmonyPlatform, data);
this.getSequencesAccessories(harmonyPlatform, data);
this.handleHomeControls(harmonyPlatform, homedata);
//handling removing
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO - Accessories confirmed after retrieving hub infos : '
);
harmonyPlatform.log.debug(harmonyPlatform._confirmedAccessories);
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'INFO - Services confirmed after retrieving hub infos : '
);
harmonyPlatform.log.debug(harmonyPlatform._confirmedServices);
this.cleanPlatform(harmonyPlatform);
//first refresh
setTimeout(() => {
harmonyPlatform.refreshPlatform();
}, HarmonyConst.DELAY_LAUNCH_REFRESH);
},
//Cleaning methods
cleanPlatform: function (harmonyPlatform) {
this.cleanAccessories(harmonyPlatform);
this.cleanServices(harmonyPlatform);
},
cleanAccessories: function (harmonyPlatform) {
//cleaning accessories
let accstoRemove = [];
for (let acc of harmonyPlatform._foundAccessories) {
if (!harmonyPlatform._confirmedAccessories.find((x) => x.UUID == acc.UUID)) {
accstoRemove.push(acc);
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - Accessory will be Removed ' +
acc.UUID +
'/' +
acc.displayName
);
}
}
if (accstoRemove.length > 0)
harmonyPlatform.api.unregisterPlatformAccessories(
'homebridge-harmony',
'HarmonyHubWebSocket',
accstoRemove
);
},
cleanServices: function (harmonyPlatform) {
//cleaning services
for (let acc of harmonyPlatform._foundAccessories) {
let servicestoRemove = [];
for (let serv of acc.services) {
if (
HarmonyTools.isNotNil(serv.subtype) &&
!harmonyPlatform._confirmedServices.find(
(x) => x.UUID == serv.UUID && x.subtype == serv.subtype
)
) {
servicestoRemove.push(serv);
}
}
for (let servToDel of servicestoRemove) {
harmonyPlatform.log(
'WARNING - Service Removed ' +
servToDel.UUID +
'/' +
servToDel.subtype +
'/' +
servToDel.displayName
);
acc.removeService(servToDel);
}
}
},
//REFRESH
refreshCurrentActivity: function (harmonyPlatform, callback) {
//Infinite loop handling on errors / network loss ?
if (this.numberOfErrors >= HarmonyConst.MAX_SOCKET_ERROR) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - refreshCurrentActivity : NO refresh done since too much socket errors - will retry later'
);
callback();
//we reset the errors only after the delay
if (this.generalErrorTimer) clearTimeout(this.generalErrorTimer);
this.generalErrorTimer = setTimeout(() => {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - refreshCurrentActivity : Resetting counter after network loss, trying to refresh'
);
this.numberOfErrors = 0;
this.refreshCurrentActivity(harmonyPlatform, () => {});
}, harmonyPlatform.DELAY_BEFORE_RETRY_AFTER_NETWORK_LOSS);
} else {
if (
harmonyPlatform._currentActivity > HarmonyConst.CURRENT_ACTIVITY_NOT_SET_VALUE &&
harmonyPlatform._currentActivityLastUpdate &&
Date.now() - harmonyPlatform._currentActivityLastUpdate <
HarmonyConst.TIMEOUT_REFRESH_CURRENT_ACTIVITY
) {
// we don't refresh since status was retrieved not so far away
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO - refreshCurrentActivity : NO refresh needed since last update was on :' +
harmonyPlatform._currentActivity +
' and current Activity is set'
);
callback();
} else {
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO - refreshCurrentActivity : Refresh needed since last update is too old or current Activity is not set : ' +
harmonyPlatform._currentActivity
);
//if we dont have an activity set, we callback immediately
if (this.refreshInprogress) {
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO - refreshCurrentActivity : Cancelling refresh since a refresh is allready in progress ' +
harmonyPlatform._currentActivity
);
callback();
} else {
this.refreshInprogress = true;
this.harmony
.getCurrentActivity()
.then((response) => {
this.numberOfErrors = 0;
if (this.generalErrorTimer) {
clearTimeout(this.generalErrorTimer);
this.generalErrorTimer = undefined;
}
harmonyPlatform.refreshCurrentActivityOnSubPlatform(response);
this.refreshInprogress = false;
callback();
})
.catch((e) => {
this.numberOfErrors = this.numberOfErrors + 1;
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'ERROR (' +
this.numberOfErrors +
')- refreshCurrentActivity ' +
e +
' - Stack : ' +
e.stack
);
harmonyPlatform.refreshCurrentActivityOnSubPlatform(
HarmonyConst.CURRENT_ACTIVITY_NOT_SET_VALUE
);
this.refreshInprogress = false;
callback();
});
}
}
}
},
//HOME SWITCHES
refreshHomeAccessory(harmonyPlatform) {
this.getHomeControlsAccessories(harmonyPlatform).then((responseHome) => {
if (responseHome && responseHome.data) {
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO - got home controls : ' +
JSON.stringify(responseHome)
);
this.refreshHomeSwitch(harmonyPlatform, responseHome.data);
}
});
},
refreshHomeSwitch(harmonyPlatform, data) {
if (!data || typeof data !== 'object') {
return;
}
for (let a = 0; a < harmonyPlatform._foundAccessories.length; a++) {
let myHarmonyAccessory = harmonyPlatform._foundAccessories[a];
for (let s = 0; s < myHarmonyAccessory.services.length; s++) {
let service = myHarmonyAccessory.services[s];
if (service.type == HarmonyConst.HOME_TYPE) {
let newValue = data[service.HomeId];
if (newValue) {
let characteristic = service.getCharacteristic(Characteristic.On);
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO - refreshHomeSwitch - Refreshing home switch ' +
service.displayName +
' to ' +
newValue.on
);
characteristic.updateValue(newValue.on);
}
}
}
}
},
handleHomeControls: function (harmonyPlatform, data) {
if (!data || !data.data || typeof data.data !== 'object') {
return;
}
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'INFO - got Home Control : ' + JSON.stringify(data)
);
var homeControls = data.data;
var accessoriesToAdd = [];
var myHarmonyAccessory;
if (!harmonyPlatform.publishHomeControlsAsIndividualAccessories) {
var name = 'HomeControls';
myHarmonyAccessory = this.checkAccessory(harmonyPlatform, name);
if (!myHarmonyAccessory) {
myHarmonyAccessory = this.createAccessory(harmonyPlatform, name);
accessoriesToAdd.push(myHarmonyAccessory);
}
myHarmonyAccessory.category = AccessoryType.SWITCH;
harmonyPlatform._confirmedAccessories.push(myHarmonyAccessory);
}
for (const key of Object.keys(homeControls)) {
if (!HarmonyTools.isSafeObjectKey(key)) {
continue;
}
var switchName = key;
if (harmonyPlatform.homeControlsToPublishAsAccessoriesSwitch.includes(switchName)) {
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'INFO - Discovered Home Control : ' + switchName
);
if (harmonyPlatform.publishHomeControlsAsIndividualAccessories) {
myHarmonyAccessory = this.checkAccessory(harmonyPlatform, switchName);
if (!myHarmonyAccessory) {
myHarmonyAccessory = this.createAccessory(harmonyPlatform, switchName);
accessoriesToAdd.push(myHarmonyAccessory);
}
myHarmonyAccessory.category = AccessoryType.SWITCH;
harmonyPlatform._confirmedAccessories.push(myHarmonyAccessory);
}
var subType = switchName;
var service = this.getSwitchService(
harmonyPlatform,
myHarmonyAccessory,
switchName,
subType
);
service.HomeId = key;
service.type = HarmonyConst.HOME_TYPE;
harmonyPlatform._confirmedServices.push(service);
this.bindCharacteristicEventsForSwitch(harmonyPlatform, service);
}
}
//creating accessories
this.addAccessories(harmonyPlatform, accessoriesToAdd);
},
getHomeControlsAccessories: function (harmonyPlatform) {
if (
harmonyPlatform.homeControlsToPublishAsAccessoriesSwitch &&
harmonyPlatform.homeControlsToPublishAsAccessoriesSwitch.length > 0
) {
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'INFO - getting home controls ...'
);
return this.harmony.getAutomationCommands();
} else {
var responseHome = {};
return Promise.resolve(responseHome);
}
},
//GENERAL Volume SLIDER
checkVolumeAccessory: function (harmonyPlatform, accessoriesToAdd, name) {
var myHarmonyAccessory;
if (harmonyPlatform.TVFoundAccessory && harmonyPlatform.linkVolumeControlToTV) {
myHarmonyAccessory = harmonyPlatform.TVFoundAccessory;
} else {
myHarmonyAccessory = this.checkAccessory(harmonyPlatform, name);
if (!myHarmonyAccessory) {
myHarmonyAccessory = this.createAccessory(harmonyPlatform, name);
accessoriesToAdd.push(myHarmonyAccessory);
}
myHarmonyAccessory.category = AccessoryType.SWITCH;
harmonyPlatform._confirmedAccessories.push(myHarmonyAccessory);
}
return myHarmonyAccessory;
},
getGeneralVolumeSliderAccessory: function (harmonyPlatform, data) {
if (harmonyPlatform.publishGeneralVolumeSlider) {
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'INFO - Loading general volume Slider...'
);
var accessoriesToAdd = [];
let subType = 'GeneralVolumeSlider';
let name = subType;
var myHarmonyAccessory = this.checkVolumeAccessory(harmonyPlatform, accessoriesToAdd, name);
let service = this.getSliderService(harmonyPlatform, myHarmonyAccessory, name, subType);
service.type = HarmonyConst.GENERALVOLUME_TYPE;
//array of commands
var volumeUpCommandsMap = new Object();
var volumeDownCommandsMap = new Object();
let activities = data.data.activity;
for (let i = 0, len = activities.length; i < len; i++) {
let activity = activities[i];
let controlGroup = activity.controlGroup;
for (let j = 0, len = controlGroup.length; j < len; j++) {
if (controlGroup[j].name == 'Volume') {
let functions = controlGroup[j].function;
for (let k = 0, len = functions.length; k < len; k++) {
if (functions[k].name == 'VolumeUp') {
volumeUpCommandsMap[activity.id] = functions[k].action;
}
if (functions[k].name == 'VolumeDown') {
volumeDownCommandsMap[activity.id] = functions[k].action;
}
}
break;
}
}
}
service.volumeUpCommands = volumeUpCommandsMap;
service.volumeDownCommands = volumeDownCommandsMap;
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'Volume commands for Global Volume Slider : '
);
harmonyPlatform.log.debug(volumeUpCommandsMap);
harmonyPlatform.log.debug(volumeDownCommandsMap);
harmonyPlatform._confirmedServices.push(service);
this.bindCharacteristicEventsForSlider(harmonyPlatform, service);
//creating accessories
this.addAccessories(harmonyPlatform, accessoriesToAdd);
}
},
//GENERAL Volume Up Switches
getGeneralVolumeSwitchesAccessories: function (harmonyPlatform, data) {
if (harmonyPlatform.publishGeneralVolumeSwitches) {
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'INFO - Loading general volume switches...'
);
var accessoriesToAdd = [];
// Accessory Names
var volumeUpSubType = 'GeneralVolumeUp';
var volumeDownSubType = 'GeneralVolumeDown';
var volumeUpName = volumeUpSubType;
var volumeDownName = volumeDownSubType;
// Create the accesories and add them to our array to add below
var volumeUpAccessory = this.checkVolumeAccessory(
harmonyPlatform,
accessoriesToAdd,
volumeUpName
);
var volumeDownAccessory = this.checkVolumeAccessory(
harmonyPlatform,
accessoriesToAdd,
volumeDownName
);
// Create volume up service
var volumeUpService = this.getSwitchService(
harmonyPlatform,
volumeUpAccessory,
volumeUpName,
volumeUpSubType
);
volumeUpService.type = HarmonyConst.GENERALVOLUMEUP_TYPE;
// Create volume down service
var volumeDownService = this.getSwitchService(
harmonyPlatform,
volumeDownAccessory,
volumeDownName,
volumeDownSubType
);
volumeDownService.type = HarmonyConst.GENERALVOLUMEDOWN_TYPE;
//array of commands
var volumeUpCommandsMap = new Object();
var volumeDownCommandsMap = new Object();
var activities = data.data.activity;
for (let i = 0, len = activities.length; i < len; i++) {
var activity = activities[i];
var controlGroup = activity.controlGroup;
for (let j = 0, len = controlGroup.length; j < len; j++) {
if (controlGroup[j].name == 'Volume') {
var functions = controlGroup[j].function;
for (let k = 0, len = functions.length; k < len; k++) {
if (functions[k].name == 'VolumeUp') {
volumeUpCommandsMap[activity.id] = functions[k].action;
}
if (functions[k].name == 'VolumeDown') {
volumeDownCommandsMap[activity.id] = functions[k].action;
}
}
break;
}
}
}
// Add volume up commands to service, bind events
volumeUpService.volumeUpCommands = volumeUpCommandsMap;
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'Volume commands for Global Volume Up : '
);
harmonyPlatform.log.debug(volumeUpCommandsMap);
harmonyPlatform._confirmedServices.push(volumeUpService);
this.bindCharacteristicEventsForSwitch(harmonyPlatform, volumeUpService);
// Add volume down commands to service, bind events
volumeDownService.volumeDownCommands = volumeDownCommandsMap;
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'Volume commands for Global Volume Down : '
);
harmonyPlatform.log.debug(volumeDownCommandsMap);
harmonyPlatform._confirmedServices.push(volumeDownService);
this.bindCharacteristicEventsForSwitch(harmonyPlatform, volumeDownService);
//creating accessories
this.addAccessories(harmonyPlatform, accessoriesToAdd);
}
},
//GENERAL Mute SWITCH
getGeneralMuteSwitchAccessory: function (harmonyPlatform, data) {
if (harmonyPlatform.publishGeneralMuteSwitch) {
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'INFO - Loading general mute Switch...'
);
let subType = 'GeneralMuteSwitch';
let name = subType;
var accessoriesToAdd = [];
var myHarmonyAccessory = this.checkVolumeAccessory(harmonyPlatform, accessoriesToAdd, name);
var service = this.getSwitchService(harmonyPlatform, myHarmonyAccessory, name, subType);
service.type = HarmonyConst.GENERALMUTE_TYPE;
//array of commands
var muteCommandsMap = new Object();
let activities = data.data.activity;
for (let i = 0, len = activities.length; i < len; i++) {
var activity = activities[i];
var controlGroup = activity.controlGroup;
for (let j = 0, len = controlGroup.length; j < len; j++) {
if (controlGroup[j].name == 'Volume') {
var functions = controlGroup[j].function;
for (let k = 0, len = functions.length; k < len; k++) {
if (functions[k].name == 'Mute') {
muteCommandsMap[activity.id] = functions[k].action;
break;
}
}
break;
}
}
}
service.muteCommands = muteCommandsMap;
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'Mute commands for Global Mute Switch : '
);
harmonyPlatform.log.debug(muteCommandsMap);
harmonyPlatform._confirmedServices.push(service);
this.bindCharacteristicEventsForSwitch(harmonyPlatform, service);
//creating accessories
this.addAccessories(harmonyPlatform, accessoriesToAdd);
}
},
//SEQUENCES SWITCHES
getSequencesAccessories: function (harmonyPlatform, data) {
if (
harmonyPlatform.sequencesToPublishAsAccessoriesSwitch &&
harmonyPlatform.sequencesToPublishAsAccessoriesSwitch.length > 0
) {
harmonyPlatform.log('(' + harmonyPlatform.name + ')' + 'INFO - Loading sequences...');
let sequences = data.data.sequence;
var accessoriesToAdd = [];
var myHarmonyAccessory;
if (!harmonyPlatform.publishSequencesAsIndividualAccessories) {
let name = 'Sequences';
myHarmonyAccessory = this.checkAccessory(harmonyPlatform, name);
if (!myHarmonyAccessory) {
myHarmonyAccessory = this.createAccessory(harmonyPlatform, name);
accessoriesToAdd.push(myHarmonyAccessory);
}
myHarmonyAccessory.category = AccessoryType.SWITCH;
harmonyPlatform._confirmedAccessories.push(myHarmonyAccessory);
}
for (let i = 0, len = sequences.length; i < len; i++) {
let switchName = sequences[i].name;
if (harmonyPlatform.sequencesToPublishAsAccessoriesSwitch.includes(switchName)) {
switchName = switchName + '(' + sequences[i].id + ')';
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'INFO - Discovered sequence : ' + switchName
);
if (harmonyPlatform.publishSequencesAsIndividualAccessories) {
myHarmonyAccessory = this.checkAccessory(harmonyPlatform, switchName);
if (!myHarmonyAccessory) {
myHarmonyAccessory = this.createAccessory(harmonyPlatform, switchName);
accessoriesToAdd.push(myHarmonyAccessory);
}
myHarmonyAccessory.category = AccessoryType.SWITCH;
harmonyPlatform._confirmedAccessories.push(myHarmonyAccessory);
}
var subType = switchName + '-Sequence';
var service = this.getSwitchService(
harmonyPlatform,
myHarmonyAccessory,
switchName,
subType
);
service.sequenceId = sequences[i].id;
service.type = HarmonyConst.SEQUENCE_TYPE;
harmonyPlatform._confirmedServices.push(service);
this.bindCharacteristicEventsForSwitch(harmonyPlatform, service);
}
}
//creating accessories
this.addAccessories(harmonyPlatform, accessoriesToAdd);
}
},
//DEVICES SWITCHES
printAndStoreCommands: function (harmonyPlatform, devices) {
this.deviceCommands = {};
for (let i = 0, len = devices.length; i < len; i++) {
let controlGroup = devices[i].controlGroup;
for (let j = 0, len = controlGroup.length; j < len; j++) {
let functions = controlGroup[j].function;
for (let k = 0, len = functions.length; k < len; k++) {
if (harmonyPlatform.showCommandsAtStartup)
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'INFO - Command : ' +
functions[k].name +
' discovered for device : ' +
devices[i].label
);
//Store command
this.deviceCommands[[devices[i].label, functions[k].name]] = functions[k].action;
}
}
}
},
populateCommands: function (harmonyPlatform, controlGroup, switchName) {
let commandFunctions = [];
for (let j = 0, len = controlGroup.length; j < len; j++) {
//if (controlGroup[j].name === 'Power') {
let functions = controlGroup[j].function;
for (let k = 0, len = functions.length; k < len; k++) {
if (functions[k].name === 'PowerOff') {
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'INFO - Activating PowerOff for ' + switchName
);
if (commandFunctions.some((e) => e.key == 'PowerOff')) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - Multiple PowerOff - found for ' +
switchName +
'- not adding one in ' +
controlGroup[j].name
);
} else {
commandFunctions.push({
key: 'PowerOff',
value: functions[k].action,
});
}
} else if (functions[k].name === 'PowerOn') {
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'INFO - Activating PowerOn for ' + switchName
);
if (commandFunctions.some((e) => e.key == 'PowerOn')) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - Multiple PowerOn - found for ' +
switchName +
'- not adding one in ' +
controlGroup[j].name
);
} else {
commandFunctions.push({
key: 'PowerOn',
value: functions[k].action,
});
}
} else if (functions[k].name === 'PowerToggle') {
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'INFO - Activating PowerToggle for ' + switchName
);
if (commandFunctions.some((e) => e.key == 'PowerToggle')) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - Multiple PowerToggle - found for ' +
switchName +
'- not adding one in ' +
controlGroup[j].name
);
} else {
commandFunctions.push({
key: 'PowerToggle',
value: functions[k].action,
});
}
}
}
//}
}
return commandFunctions;
},
handleDefaultCommandMode: function (
myHarmonyAccessory,
harmonyPlatform,
controlGroup,
device,
customSwitchName,
isStateless
) {
let accessoriesToAdd = [];
let switchName = device.label;
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'INFO - Discovered Device : ' + switchName
);
let foundToggle = false;
let foundNonStateless = false;
let commandFunctions = this.populateCommands(harmonyPlatform, controlGroup, switchName);
if (commandFunctions.some((e) => e.key == 'PowerToggle')) {
foundToggle = true;
}
if (
!foundToggle &&
commandFunctions.some((e) => e.key == 'PowerOn') &&
commandFunctions.some((e) => e.key == 'PowerOff') &&
!isStateless
) {
foundNonStateless = true;
}
if (commandFunctions.length == 0) {
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'Error - No function found for ' + switchName
);
} else {
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'Info - Functions found for ' +
switchName +
'-' +
JSON.stringify(commandFunctions)
);
for (let j = 0, len = commandFunctions.length; j < len; j++) {
if ((foundToggle && commandFunctions[j].key === 'PowerToggle') || !foundToggle) {
if (harmonyPlatform.publishDevicesAsIndividualAccessories) {
let name = switchName + ' ' + (foundNonStateless ? 'Power' : commandFunctions[j].key);
myHarmonyAccessory = this.checkAccessory(harmonyPlatform, name);
if (!myHarmonyAccessory) {
myHarmonyAccessory = this.createAccessory(harmonyPlatform, name);
accessoriesToAdd.push(myHarmonyAccessory);
}
myHarmonyAccessory.category = AccessoryType.SWITCH;
harmonyPlatform._confirmedAccessories.push(myHarmonyAccessory);
}
var subType = switchName + ' ' + (foundNonStateless ? 'Power' : commandFunctions[j].key);
var service = this.getSwitchService(
harmonyPlatform,
myHarmonyAccessory,
HarmonyTools.isNil(customSwitchName) ? switchName : customSwitchName,
subType
);
service.deviceId = device.id;
service.type = HarmonyConst.DEVICE_TYPE;
if (!isStateless) {
if (commandFunctions[j].key === 'PowerToggle') {
service.command = commandFunctions[j].value;
service.offCommand = commandFunctions[j].value;
} else if (commandFunctions[j].key === 'PowerOn') {
service.command = commandFunctions[j].value;
} else if (commandFunctions[j].key === 'PowerOff') {
service.offCommand = commandFunctions[j].value;
}
} else {
service.command = commandFunctions[j].value;
}
service.isStateless = isStateless;
harmonyPlatform._confirmedServices.push(service);
this.bindCharacteristicEventsForSwitch(harmonyPlatform, service);
}
}
}
return accessoriesToAdd;
},
handleSpecificCommandMode: function (
myHarmonyAccessory,
harmonyPlatform,
commands,
controlGroup,
device,
customSwitchName
) {
let accessoriesToAdd = [];
let switchName = device.label;
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'INFO - Discovered Device : ' + switchName
);
let functionsForSwitch = [];
let functionsOffForSwitch = [];
let functionsKey = '';
//check stateless
var OnOffcommands = commands.split('§');
for (let a = 0, len = OnOffcommands.length; a < len; a++) {
let commands = OnOffcommands[a].split(';');
for (let l = a == 0 ? 1 : 0, len = commands.length; l < len; l++) {
for (let j = 0, len = controlGroup.length; j < len; j++) {
let functions = controlGroup[j].function;
for (let k = 0, len = functions.length; k < len; k++) {
let commandTosend = commands[l].split('|');
if (functions[k].name === commandTosend[0]) {
harmonyPlatform.log.debug(
'(' +
harmonyPlatform.name +
')' +
'INFO - Activating Macro ' +
commandTosend[0] +
' for ' +
switchName
);
if (commandTosend.length === 2) {
let fctWithDelay = functions[k].action + '|' + commandTosend[1];
a == 0
? functionsForSwitch.push(fctWithDelay)
: functionsOffForSwitch.push(fctWithDelay);
} else {
a == 0
? functionsForSwitch.push(functions[k].action)
: functionsOffForSwitch.push(functions[k].action);
}
functionsKey = functionsKey + commandTosend[0];
}
}
}
}
}
if (functionsForSwitch.length === 0) {
harmonyPlatform.log(
'(' + harmonyPlatform.name + ')' + 'Error - No function list found for ' + switchName
);
} else {
if (harmonyPlatform.publishDevicesAsIndividualAccessories) {
let name = switchName + ' ' + functionsKey;
myHarmonyAccessory = this.checkAccessory(harmonyPlatform, name);
if (!myHarmonyAccessory) {
myHarmonyAccessory = this.createAccessory(harmonyPlatform, name);
accessoriesToAdd.push(myHarmonyAccessory);
}
myHarmonyAccessory.category = AccessoryType.SWITCH;
harmonyPlatform._confirmedAccessories.push(myHarmonyAccessory);
}
var subType = switchName + ' ' + functionsKey;
var service = this.getSwitchService(
harmonyPlatform,
myHarmonyAccessory,
HarmonyTools.isNil(customSwitchName) ? switchName : customSwitchName,
subType
);
service.deviceId = device.id;
service.type = HarmonyConst.DEVICEMACRO_TYPE;
service.command = JSON.stringify(functionsForSwitch);
if (functionsOffForSwitch.length > 0) {
service.offCommand = JSON.stringify(functionsOffForSwitch);
service.isStateless = false;
} else {
service.isStateless = true;
}
harmonyPlatform._confirmedServices.push(service);
this.bindCharacteristicEventsForSwitch(harmonyPlatform, service);
}
return accessoriesToAdd;
},
getDevicesAccessories: function (harmonyPlatform, data) {
let devices = data.data.device;
//printing and storing
this.printAndStoreCommands(harmonyPlatform, devices);
var accessoriesToAdd = [];
var myHarmonyAccessory;
if (
harmonyPlatform.devicesToPublishAsAccessoriesSwitch &&
harmonyPlatform.devicesToPublishAsAccessoriesSwitch.length > 0
) {
harmonyPlatform.log('(' + harmonyPlatform.name + ')' + 'INFO - Loading devices...');
if (!harmonyPlatform.publishDevicesAsIndividualAccessories) {
let name = 'Devices';
myHarmonyAccessory = this.checkAccessory(harmonyPlatform, name);
if (!myHarmonyAccessory) {
myHarmonyAccessory = this.createAccessory(harmonyPlatform, name);
accessoriesToAdd.push(myHarmonyAccessory);
}
myHarmonyAccessory.category = AccessoryType.SWITCH;
harmonyPlatform._confirmedAccessories.push(myHarmonyAccessory);
}
for (
let c = 0, len = harmonyPlatform.devicesToPublishAsAccessoriesSwitch.length;
c < len;
c++
) {
var commands = harmonyPlatform.devicesToPublishAsAccessoriesSwitch[c].split(';');
for (let i = 0, len = devices.length; i < len; i++) {
let nameSwitchArray = commands[0].split('|');
let ServiceName = nameSwitchArray[0];
if (devices[i].label === ServiceName) {
let customSwitchName = nameSwitchArray.length > 1 ? nameSwitchArray[1] : undefined;
//check functions
let controlGroup = devices[i].controlGroup;
//default mode
if (commands.length === 1 || (commands.length === 2 && commands[1] === '§')) {
var isStateless =
harmonyPlatform.devicesToPublishAsAccessoriesSwitch[c].split('§').length == 1;
accessoriesToAdd.push.apply(
accessoriesToAdd,
this.handleDefaultCommandMode(
myHarmonyAccessory,
harmonyPlatform,
controlGroup,
devices[i],
customSwitchName,
isStateless
)
);
}
//specifc command or list mode
else {
var commandsToparse = harmonyPlatform.devicesToPublishAsAccessoriesSwitch[c];
accessoriesToAdd.push.apply(
accessoriesToAdd,
this.handleSpecificCommandMode(
myHarmonyAccessory,
harmonyPlatform,
commandsToparse,
controlGroup,
devices[i],
customSwitchName
)
);
}
break;
}
}
}
//creating accessories
this.addAccessories(harmonyPlatform, accessoriesToAdd);
}
},
//ACCESSORIES, SERVICES AND CHARACERISTICS
handleCharacteristicUpdate: function (harmonyPlatform, characteristic, characteristicValue) {
if (harmonyPlatform._currentActivity !== HarmonyConst.CURRENT_ACTIVITY_NOT_SET_VALUE) {
characteristic.updateValue(characteristicValue);
}
},
checkAccessory(harmonyPlatform, name) {
var fullName = harmonyPlatform.name + (name ? ' ' + name : '');
var uuid = UUIDGen.generate(fullName);
var foundAccessory = harmonyPlatform._foundAccessories.find((x) => x.UUID == uuid);
if (foundAccessory) {
var serialNumber = foundAccessory
.getService(Service.AccessoryInformation)
.getCharacteristic(Characteristic.SerialNumber).value;
if (serialNumber != uuid) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'WARNING - updating serialNumber for ' +
fullName +
' from ' +
serialNumber +
' to ' +
uuid
);
foundAccessory
.getService(Service.AccessoryInformation)
.setCharacteristic(Characteristic.SerialNumber, uuid)
.setCharacteristic(Characteristic.ConfiguredName, name);
}
}
return foundAccessory;
},
createAccessory(harmonyPlatform, name) {
var fullName = harmonyPlatform.name + (name ? ' ' + name : '');
harmonyPlatform.log('(' + harmonyPlatform.name + ')' + 'INFO - Adding Accessory : ' + fullName);
var uuid = UUIDGen.generate(fullName);
harmonyPlatform.log.debug(
'(' + harmonyPlatform.name + ')' + 'INFO - UUID for : *' + fullName + '* is : *' + uuid + '*'
);
var myHarmonyAccessory = new Accessory(fullName, uuid);
myHarmonyAccessory.name = fullName;
myHarmonyAccessory.model = harmonyPlatform.name;
myHarmonyAccessory.manufacturer = 'Logitech';
myHarmonyAccessory.serialNumber = uuid;
myHarmonyAccessory.context.subPlatformName = harmonyPlatform.name;
myHarmonyAccessory
.getService(Service.AccessoryInformation)
.setCharacteristic(Characteristic.Manufacturer, myHarmonyAccessory.manufacturer)
.setCharacteristic(Characteristic.Model, myHarmonyAccessory.model)
.setCharacteristic(Characteristic.SerialNumber, myHarmonyAccessory.serialNumber)
.setCharacteristic(Characteristic.ConfiguredName, myHarmonyAccessory.name);
return myHarmonyAccessory;
},
addAccessories(harmonyPlatform, accessoriesToAdd) {
harmonyPlatform._foundAccessories.push.apply(
harmonyPlatform._foundAccessories,
accessoriesToAdd
);
harmonyPlatform.api.registerPlatformAccessories(
'homebridge-harmony',
'HarmonyHubWebSocket',
accessoriesToAdd
);
},
//SWITCH SERVICE
getSwitchService(harmonyPlatform, accessory, switchName, serviceSubType) {
var service = accessory.getServiceById(switchName, serviceSubType);
if (!service) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'INFO - Creating Switch Service : ' +
switchName +
'/' +
serviceSubType
);
service = new Service.Switch(switchName, serviceSubType);
service.addOptionalCharacteristic(Characteristic.ConfiguredName);
service.setCharacteristic(Characteristic.ConfiguredName, switchName);
accessory.addService(service);
}
return service;
},
setSwitchOnCharacteristic: function (harmonyPlatform, service, value, callback) {
//send command
if (service.type === HarmonyConst.HOME_TYPE) {
if (!HarmonyTools.isSafeObjectKey(service.HomeId)) {
harmonyPlatform.log(
'(' +
harmonyPlatform.name +
')' +
'ERROR - setSwitchOnCharacteristic : invalid home control id'
);
callback();
return;
}
let comm