watsonb8/homebridge-harmony-control
1
1
Fork 0
Code Issues 2 Pull Requests Actions Projects Releases Wiki Activity

Added device emit option for debugging purposes

Browse Source
This commit is contained in:
watsonb8 2020-01-01 23:29:44 -05:00
parent 588205e507
commit 020a2fc240
10 changed files with 132 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Accessories/ControlUnit.ts
View File

@ -1,5 +1,5 @@
import { IActivity } from '../Models/Activity';
import { IMatrix } from '../Models/Matrix';
import { IActivity } from '../Models/Config/IActivity';
import { IMatrix } from '../Models/Config/IMatrix';
import { IAccessory } from './IAccessory';
import callbackify from '../Util/Callbackify';
import HarmonyDataProvider from '../DataProviders/HarmonyDataProvider';

18
src/Accessories/DeviceButton.ts
View File

@ -1,14 +1,16 @@
import HarmonyDataProvider from "../DataProviders/HarmonyDataProvider";
import { IDeviceButton } from "../Models/DeviceButton";
import { IDeviceButton } from "../Models/Config/IDeviceButton";
import { IAccessory } from "./IAccessory";
import { sleep } from "../Util/Sleep";
import { ICommand } from "../Models/IDevice";
let Service: HAPNodeJS.Service;
let Characteristic: HAPNodeJS.Characteristic;
export interface IDeviceButtonProps {
dataProvider: HarmonyDataProvider,
name: string,
buttonName: string,
displayName: string,
deviceInfo: IDeviceButton,
api: any,
log: any,
@ -28,10 +30,12 @@ export class DeviceButton implements IAccessory {
private _dataProvider: HarmonyDataProvider;
private _deviceCommand: string = "";
private _deviceCommand?: ICommand;
private _buttonState: boolean;
private _buttonName: string;
constructor(props: IDeviceButtonProps) {
//Assign class variables
@ -39,7 +43,8 @@ export class DeviceButton implements IAccessory {
this._api = props.api;
Service = props.api.hap.Service;
Characteristic = props.api.hap.Characteristic;
this.name = props.name;
this._buttonName = props.buttonName;
this.name = props.displayName;
this._homebridge = props.homebridge;
this._buttonInfo = props.deviceInfo;
@ -93,7 +98,10 @@ export class DeviceButton implements IAccessory {
//Get device command if we don't have it
if (!this._deviceCommand) {
this._deviceCommand = this._dataProvider.getCommand(this._buttonInfo.ButtonName, this._buttonInfo.DeviceName);
let cmd = this._dataProvider.getCommand(this._buttonInfo.ButtonName, this._buttonInfo.DeviceName);
if (cmd) {
this._deviceCommand = cmd;
}
}
//Execute command

134
src/DataProviders/HarmonyDataProvider.ts
View File

@ -1,20 +1,14 @@
import { IActivity } from "../Models/Activity";
import { IDeviceSetupItem } from "../Models/DeviceSetupItem";
import { IInput, IMatrix, IOutput } from "../Models/Matrix";
import { IActivity } from "../Models/Config/IActivity";
import { IDeviceSetupItem } from "../Models/Config/IDeviceSetupItem";
import { IInput, IMatrix, IOutput } from "../Models/Config/IMatrix";
import { RemoteKey } from '../Accessories/ControlUnit';
import { sleep } from '../Util/Sleep';
import { EventEmitter } from "events";
import { IDevice, ICommand } from '../Models/IDevice';
let Characteristic: HAPNodeJS.Characteristic;
const Harmony = require("harmony-websocket");
interface IDevice {
id: string,
name: string,
supportsCommand(commandName: string): boolean,
getCommand(commandName: string): string,
commands: { [name: string]: string };
on: boolean;
}
interface IActivityState {
currentActivity: IActivity
@ -26,41 +20,46 @@ interface IHarmonyDataProviderProps {
matrix: IMatrix
}
class HarmonyDataProvider {
private harmony: any;
private log: any;
private hubAddress: string = "";
private connected: boolean = false;
class HarmonyDataProvider extends EventEmitter {
private _harmony: any;
private _log: any;
private _hubAddress: string = "";
private _connected: boolean = false;
private devices: { [name: string]: IDevice; } = {};
private states: { [controlUnitName: string]: (IActivityState | undefined) } = {};
private _devices: { [name: string]: IDevice; } = {};
private _states: { [controlUnitName: string]: (IActivityState | undefined) } = {};
private matrix: IMatrix;
private _matrix: IMatrix;
constructor(props: IHarmonyDataProviderProps) {
this.log = props.log;
this.hubAddress = props.hubAddress;
this.matrix = props.matrix;
super();
this._log = props.log;
this._hubAddress = props.hubAddress;
this._matrix = props.matrix;
this.harmony = new Harmony();
this._harmony = new Harmony();
//Listeners
this.harmony.on('open', () => {
this.connected = true;
this._harmony.on('open', () => {
this._connected = true;
});
this.harmony.on('close', () => {
this.connected = false;
this._harmony.on('close', () => {
this._connected = false;
});
this.connect();
}
public get devices(): { [name: string]: IDevice; } {
return this._devices;
}
/**
* Power on all devices in an activity.
*/
public powerOn = async (controlUnitName: string, activity: IActivity) => {
//Only power on if not alread on
let currentActivity = this.states[controlUnitName] ? this.states[controlUnitName]!.currentActivity : undefined;
let currentActivity = this._states[controlUnitName] ? this._states[controlUnitName]!.currentActivity : undefined;
if (!currentActivity) {
await this.startActivity(controlUnitName, activity);
}
@ -70,11 +69,11 @@ class HarmonyDataProvider {
* Power off all devices in an activity that aren't being used.
*/
public powerOff = async (controlUnitName: string) => {
if (!this.states[controlUnitName]) {
if (!this._states[controlUnitName]) {
return;
}
//Build potential list of devices to turn off
let devicesToTurnOff: Array<IDevice> = this.states[controlUnitName]!.currentActivity.DeviceSetupList
let devicesToTurnOff: Array<IDevice> = this._states[controlUnitName]!.currentActivity.DeviceSetupList
.map((value: IDeviceSetupItem): IDevice => {
return this.getDeviceFromName(value.DeviceName);
});
@ -87,17 +86,17 @@ class HarmonyDataProvider {
this.powerOffDevice(device);
});
this.states[controlUnitName] = undefined;
this._states[controlUnitName] = undefined;
}
/**
* Start an activity
*/
public startActivity = async (controlUnitName: string, activity: IActivity) => {
this.log(`Starting activity ${activity.DisplayName} for controlUnit: ${controlUnitName}`)
this._log(`Starting activity ${activity.DisplayName} for controlUnit: ${controlUnitName}`)
let lastActivity: IActivity | undefined = undefined;
if (this.states[controlUnitName]) {
lastActivity = this.states[controlUnitName]!.currentActivity;
if (this._states[controlUnitName]) {
lastActivity = this._states[controlUnitName]!.currentActivity;
}
//Build potential list of devices to to turn on
@ -110,9 +109,9 @@ class HarmonyDataProvider {
//Turn on devices
await Promise.all(devicesToTurnOn.map(async (device: IDevice) => {
if (device && device.name && this.devices[device.name]) {
if (device && device.name && this._devices[device.name]) {
if (!device.on) {
this.log(`Turning on device ${device.name}`)
this._log(`Turning on device ${device.name}`)
await this.powerOnDevice(device);
}
}
@ -124,7 +123,7 @@ class HarmonyDataProvider {
let device: IDevice = this.getDeviceFromName(value.DeviceName);
if (device && device.supportsCommand(`Input${value.Input}`)) {
let command: string = device.getCommand(`Input${value.Input}`);
let command: ICommand = device.getCommand(`Input${value.Input}`);
await this.sendCommand(command);
}
})
@ -132,13 +131,13 @@ class HarmonyDataProvider {
if (activity.UseMatrix) {
//get input and output
let input: IInput = this.matrix.Inputs.filter(e => e.InputDevice === activity.ControlDevice)[0];
let output: IOutput = this.matrix.Outputs.filter(e => e.OutputDevice === activity.OutputDevice)[0];
let input: IInput = this._matrix.Inputs.filter(e => e.InputDevice === activity.ControlDevice)[0];
let output: IOutput = this._matrix.Outputs.filter(e => e.OutputDevice === activity.OutputDevice)[0];
let inputCommandName: string = `In ${input.InputNumber}`;
let outputCommandName: string = `Out ${output.OutputLetter}`;
let matrixDevice: IDevice = this.getDeviceFromName(this.matrix.DeviceName);
let matrixDevice: IDevice = this.getDeviceFromName(this._matrix.DeviceName);
//Route hdmi
if (matrixDevice.supportsCommand(inputCommandName) && matrixDevice.supportsCommand(outputCommandName)) {
@ -168,14 +167,14 @@ class HarmonyDataProvider {
//Resolve device conflicts with other controlUnits
devicesToTurnOff = this.sanitizeDeviceList(devicesToTurnOff, controlUnitName);
this.log(`Sanatized devices to turn off: ${JSON.stringify(devicesToTurnOff.map(e => e ? e.name : ""))}`);
this._log(`Sanatized devices to turn off: ${JSON.stringify(devicesToTurnOff.map(e => e ? e.name : ""))}`);
await Promise.all(
//Turn off devices
devicesToTurnOff.map(async (device: IDevice) => {
if (device) {
if (device.on) {
this.log(`Turning off device ${device.name}`)
this._log(`Turning off device ${device.name}`)
await this.powerOffDevice(device);
}
}
@ -185,7 +184,7 @@ class HarmonyDataProvider {
}
//Assign current activity
this.states[controlUnitName] = { currentActivity: activity };
this._states[controlUnitName] = { currentActivity: activity };
}
/**
@ -193,8 +192,8 @@ class HarmonyDataProvider {
*/
public volumeUp = async (controlUnitName: string) => {
let volumeUpCommand: string = "Volume Up"
if (this.states[controlUnitName]) {
let volumeDevice: IDevice = this.getDeviceFromName(this.states[controlUnitName]!.currentActivity.VolumeDevice);
if (this._states[controlUnitName]) {
let volumeDevice: IDevice = this.getDeviceFromName(this._states[controlUnitName]!.currentActivity.VolumeDevice);
if (volumeDevice.supportsCommand(volumeUpCommand)) {
this.sendCommand(volumeDevice.getCommand(volumeUpCommand));
}
@ -206,8 +205,8 @@ class HarmonyDataProvider {
*/
public volumeDown = async (controlUnitName: string) => {
let volumeDownCommand: string = "Volume Down"
if (this.states[controlUnitName]) {
let volumeDevice: IDevice = this.getDeviceFromName(this.states[controlUnitName]!.currentActivity.VolumeDevice);
if (this._states[controlUnitName]) {
let volumeDevice: IDevice = this.getDeviceFromName(this._states[controlUnitName]!.currentActivity.VolumeDevice);
if (volumeDevice.supportsCommand(volumeDownCommand)) {
this.sendCommand(volumeDevice.getCommand(volumeDownCommand));
}
@ -221,10 +220,10 @@ class HarmonyDataProvider {
* @param key The key to send.
*/
public sendKeyPress = async (controlUnitName: string, key: any) => {
if (this.states[controlUnitName]) {
if (this._states[controlUnitName]) {
let commandName: string = "";
let device: IDevice = this.getDeviceFromName(this.states[controlUnitName]!.currentActivity.ControlDevice);
let device: IDevice = this.getDeviceFromName(this._states[controlUnitName]!.currentActivity.ControlDevice);
switch (key) {
case RemoteKey.ARROW_UP: {
commandName = "Direction Up";
@ -275,7 +274,7 @@ class HarmonyDataProvider {
* @param controlUnitName
*/
public getIsActive(controlUnitName: string): IActivity | undefined {
return this.states[controlUnitName] ? this.states[controlUnitName]!.currentActivity : undefined;
return this._states[controlUnitName] ? this._states[controlUnitName]!.currentActivity : undefined;
}
/**
@ -283,12 +282,12 @@ class HarmonyDataProvider {
* @param deviceCommandName The device command name
* @param deviceName The device name
*/
public getCommand(deviceCommandName: string, deviceName: string): string {
public getCommand(deviceCommandName: string, deviceName: string): ICommand | undefined {
const device: IDevice = this.getDeviceFromName(deviceName);
if (device && device.supportsCommand(deviceCommandName)) {
return device.getCommand(deviceCommandName);
} else {
return "";
return undefined;
}
}
@ -296,15 +295,15 @@ class HarmonyDataProvider {
* Send a command to the harmony hub.
* @param command The command to send.
*/
public sendCommand = async (command: string) => {
public sendCommand = async (command: ICommand) => {
try {
//Execute command
let response = await this.harmony.sendCommand(JSON.stringify(command));
let response = await this._harmony.sendCommand(JSON.stringify(command));
//Sleep
await sleep(800);
} catch (err) {
this.log(`ERROR - error sending command to harmony: ${err}`);
this._log(`ERROR - error sending command to harmony: ${err}`);
}
}
@ -313,23 +312,23 @@ class HarmonyDataProvider {
* Connect to harmony and receive device info
*/
private connect = async () => {
await this.harmony.connect(this.hubAddress);
await this._harmony.connect(this._hubAddress);
let self = this;
setTimeout(async function () {
if (self.connected) {
let devices: any = await self.harmony.getDevices();
if (self._connected) {
let devices: any = await self._harmony.getDevices();
try {
await Promise.all(
//Add each to dictionary
devices.map(async (dev: any) => {
//get commands
let commands: { [name: string]: string } = {};
let deviceCommands: any = await self.harmony.getDeviceCommands(dev.id);
let commands: { [name: string]: ICommand } = {};
let deviceCommands: any = await self._harmony.getDeviceCommands(dev.id);
deviceCommands.forEach((command: any) => {
commands[command.label] = command.action;
});
self.devices[dev.label] = {
self._devices[dev.label] = {
id: dev.id,
name: dev.label,
commands: commands,
@ -339,15 +338,16 @@ class HarmonyDataProvider {
let command = commands[commandName];
return (command) ? true : false;
},
getCommand(commandName: string): string {
getCommand(commandName: string): ICommand {
return commands[commandName];
}
}
}));
self.log(`Harmony data provider ready`);
self._log(`Harmony data provider ready`);
self.emit("Ready");
} catch (err) {
self.log(`ERROR - error connecting to harmony: ${err}`);
self._log(`ERROR - error connecting to harmony: ${err}`);
}
}
}, 1000);
@ -388,7 +388,7 @@ class HarmonyDataProvider {
* @param deviceName The device to retrieve.
*/
private getDeviceFromName(deviceName: string): IDevice {
return this.devices[deviceName];
return this._devices[deviceName];
}
/**
@ -397,12 +397,12 @@ class HarmonyDataProvider {
* @param controlUnitName The name of the control unit in question.
*/
private sanitizeDeviceList(devicesToTurnOn: Array<IDevice>, controlUnitName: string): Array<IDevice> {
for (let controlUnitKey in this.states) {
for (let controlUnitKey in this._states) {
//Skip self
if (controlUnitKey === controlUnitName) {
continue;
}
let currentOtherState: IActivityState = this.states[controlUnitKey]!;
let currentOtherState: IActivityState = this._states[controlUnitKey]!;
if (currentOtherState) {
currentOtherState.currentActivity.DeviceSetupList.forEach((value: IDeviceSetupItem) => {

2
src/Models/Activity.ts → src/Models/Config/IActivity.ts
View File

@ -1,4 +1,4 @@
import { IDeviceSetupItem } from './DeviceSetupItem';
import { IDeviceSetupItem } from './IDeviceSetupItem';
export interface IActivity {
OutputDevice: string;

7
src/Models/IConfig.ts → src/Models/Config/IConfig.ts
View File

@ -1,6 +1,6 @@
import { IMatrix } from "./Matrix";
import { IActivity } from "./Activity";
import { IDeviceButton } from "./DeviceButton";
import { IMatrix } from "./IMatrix";
import { IActivity } from "./IActivity";
import { IDeviceButton } from "./IDeviceButton";
export interface IControlUnit {
DisplayName: string;
@ -9,6 +9,7 @@ export interface IControlUnit {
export interface IConfig {
hubIp: string;
EmitDevicesOnStartup: boolean,
Matrix: IMatrix
ControlUnits: Array<IControlUnit>
DeviceButtons: Array<IDeviceButton>

1
src/Models/DeviceButton.ts → src/Models/Config/IDeviceButton.ts
View File

@ -1,5 +1,6 @@
export interface IDeviceButton {
DeviceName: string;
ButtonName: string;
DisplayName: string;
IsStateful: boolean;
}

0
src/Models/DeviceSetupItem.ts → src/Models/Config/IDeviceSetupItem.ts
View File

0
src/Models/Matrix.ts → src/Models/Config/IMatrix.ts
View File

14
src/Models/IDevice.ts Normal file
View File

@ -0,0 +1,14 @@
export interface ICommand {
command?: string,
deviceId?: string,
type?: string
}
export interface IDevice {
id: string,
name: string,
supportsCommand(commandName: string): boolean,
getCommand(commandName: string): ICommand,
commands: { [name: string]: ICommand };
on: boolean;
}

42
src/index.ts
View File

@ -1,12 +1,13 @@
import { ControlUnit } from "./Accessories/ControlUnit";
import { DeviceButton } from './Accessories/DeviceButton';
import { IActivity } from "./Models/Activity";
import { IDeviceSetupItem } from "./Models/DeviceSetupItem";
import { IInput, IOutput, IMatrix } from "./Models/Matrix";
import { IActivity } from "./Models/Config/IActivity";
import { IDeviceSetupItem } from "./Models/Config/IDeviceSetupItem";
import { IInput, IOutput, IMatrix } from "./Models/Config/IMatrix";
import HarmonyDataProvider from "./DataProviders/HarmonyDataProvider";
import { IConfig, IControlUnit } from "./Models/IConfig";
import { IDeviceButton } from "./Models/DeviceButton";
import { IConfig, IControlUnit } from "./Models/Config/IConfig";
import { IDeviceButton } from "./Models/Config/IDeviceButton";
import { IAccessory } from "./Accessories/IAccessory";
import { IDevice, ICommand } from "./Models/IDevice";
let Accessory: any;
let Homebridge: any;
@ -41,6 +42,28 @@ class HarmonyMatrixPlatform {
this.api.on('didFinishLaunching', this.didFinishLaunching.bind(this));
this.dataProvider = null;
if (this.config) {
//construct data provider
this.dataProvider = new HarmonyDataProvider({
hubAddress: this.config.hubIp,
matrix: this.config.Matrix,
log: this.log
});
//Emit devices if requested
if (this.config.EmitDevicesOnStartup) {
this.dataProvider.on("Ready", () => {
const devices: { [name: string]: IDevice } = this.dataProvider!.devices;
Object.values(devices).forEach((device: IDevice) => {
this.log(`${device.name} : ${device.id}`);
Object.keys(device.commands).forEach((command: string) => {
this.log(` ${command}`);
});
});
});
}
}
}
/**
@ -63,12 +86,6 @@ class HarmonyMatrixPlatform {
* @param callback
*/
accessories(callback: (accessories: Array<IAccessory>) => void) {
//construct data provider
this.dataProvider = new HarmonyDataProvider({
hubAddress: this.config.hubIp,
matrix: this.config.Matrix,
log: this.log
});
//Add control units
this.config.ControlUnits.forEach((unit: IControlUnit) => {
@ -86,7 +103,8 @@ class HarmonyMatrixPlatform {
this.config.DeviceButtons.forEach((button: IDeviceButton) => {
this.accessoryList.push(new DeviceButton({
dataProvider: this.dataProvider!,
name: button.ButtonName,
buttonName: button.ButtonName,
displayName: button.DisplayName,
deviceInfo: button,
api: this.api,
log: this.log,