Bump rev

Rolling back external accessories specifically for remote because this was causing an unpredictable crash. (Likely an unhandled exception within either apple framework or HAPNodeJS

deploy.sh

@@ -4,9 +4,10 @@ remote_server="192.168.1.31"
 deploy_location="/home/bmw/homebridge-harmony-control"
 homebridge_location="/var/lib/homebridge/"
 
+#build
+tsc --build
 #copy files to remote machine
 scp -r bin $remote_user@$remote_server:$deploy_location
-scp -r src $remote_user@$remote_server:$deploy_location
 scp package.json $remote_user@$remote_server:$deploy_location
 
 #install package

package.json

@@ -1,6 +1,6 @@
 {
     "name": "homebridge-harmony-control",
-    "version": "1.0.0",
+    "version": "1.0.3",
     "description": "Homebridge platform to control smart home equipment by room.",
     "main": "bin/index.js",
     "scripts": {
@@ -39,4 +39,4 @@
         "homebridge": "^0.4.50",
         "request": "^2.88.0"
     }
-}
+}

src/Accessories/ControlUnit.ts

@@ -1,5 +1,4 @@
-import { Activity } from '../Models/Activity';
+import * as Config from "../Models/Config"
-import { Matrix } from '../Models/Matrix';
 import { IAccessory } from './IAccessory';
 import callbackify from '../Util/Callbackify';
 import HarmonyDataProvider from '../DataProviders/HarmonyDataProvider';
@@ -31,11 +30,10 @@ export enum RemoteKey {
 export interface IControlUnitProps {
     dataProvider: HarmonyDataProvider,
     displayName: string,
-    activities: Array<Activity>,
+    activities: Array<Config.IActivity>,
     api: any,
     log: any,
     homebridge: any,
-    isExternal: boolean,
 }
 
 /**
@@ -48,7 +46,6 @@ export class ControlUnit implements IAccessory {
     //fields
     private log: any = {};
     private displayName: string = "";
-    private isExternal: boolean = false;
 
     //Service fields
     private televisionService: HAPNodeJS.Service | undefined;
@@ -57,7 +54,7 @@ export class ControlUnit implements IAccessory {
     private inputServices: Array<HAPNodeJS.Service | undefined> = [];
 
     //Harmony fields
-    private activities: Array<Activity> = [];
+    private activities: Array<Config.IActivity> = [];
     private dataProvider: HarmonyDataProvider;
 
     public platformAccessory: any;
@@ -73,8 +70,7 @@ export class ControlUnit implements IAccessory {
         Service = props.api.hap.Service;
         Characteristic = props.api.hap.Characteristic;
         this.name = props.displayName;
-        this.displayName = props.isExternal ? `${props.displayName}-Remote` : props.displayName;
+        this.displayName = props.displayName;
-        this.isExternal = props.isExternal;
 
         this.activities = props.activities;
 
@@ -134,11 +130,10 @@ export class ControlUnit implements IAccessory {
             .on("get", callbackify(this.onGetAccessoryActive));
 
         //Set remote characteristics if is external
-        if (this.isExternal) {
+        this.televisionService.getCharacteristic(Characteristic.RemoteKey)
-            this.televisionService.getCharacteristic(Characteristic.RemoteKey)
+            //@ts-ignore
-                //@ts-ignore
+            .on("set", callbackify(this.onSetRemoteKey));
-                .on("set", callbackify(this.onSetRemoteKey));
+
-        }
 
         this.televisionService.getCharacteristic(Characteristic.ActiveIdentifier)
             //@ts-ignore
@@ -151,12 +146,10 @@ export class ControlUnit implements IAccessory {
      * Event handler for SET active characteristic
      */
     private onSetAccessoryActive = async (value: any) => {
-        if (!this.isExternal) {
+        switch (value) {
-            switch (value) {
+            case 0: this.dataProvider.powerOff(this.name); break;
-                case 0: this.dataProvider.powerOff(this.name); break;
+            //Turn on with first activity
-                //Turn on with first activity
+            case 1: this.dataProvider.powerOn(this.name, this.activities[0]); break;
-                case 1: this.dataProvider.powerOn(this.name, this.activities[0]); break;
-            }
         }
     }
 
@@ -165,43 +158,31 @@ export class ControlUnit implements IAccessory {
      */
     private onGetAccessoryActive = async () => {
         //@ts-ignore
-        return this.dataProvider.getIsActive() ? Characteristic.Active.Active : Characteristic.Active.Inactive
+        return this.dataProvider.getIsActive(this.name) ? Characteristic.Active.Active : Characteristic.Active.Inactive
     }
 
     /**
      * Event handler for SET remote key
      */
     private onSetRemoteKey = async (key: any) => {
-        if (this.isExternal) {
+        this.dataProvider.sendKeyPress(this.name, key);
-            //Set the active identifier with every key press
-            // let currentActivity: Activity = this.dataProvider.getIsActive(this.name)!;
-            // let identifier: number = 0;
-            // if (currentActivity) {
-            //     identifier = this.activities.findIndex(e => e.displayName === currentActivity.displayName);
-            // }
-            // this.televisionService!.setCharacteristic(Characteristic.ActiveIdentifier, identifier);
-
-            this.dataProvider.sendKeyPress(this.name, key);
-        }
     }
 
     /**
      * Event handler for SET active identifier characteristic
      */
     private onSetActiveIdentifier = async (identifier: any) => {
-        if (!this.isExternal) {
+        this.dataProvider.startActivity(this.name, this.activities[identifier]);
-            this.dataProvider.startActivity(this.name, this.activities[identifier]);
-        }
     }
 
     /**
      * Event handler for GET active identifier characteristic
      */
     private onGetActiveIdentifier = async () => {
-        let currentActivity: Activity = this.dataProvider.getIsActive(this.name)!;
+        let currentActivity: Config.IActivity = this.dataProvider.getIsActive(this.name)!;
         let identifier: number = 0;
         if (currentActivity) {
-            identifier = this.activities.findIndex(e => e.displayName === currentActivity.displayName);
+            identifier = this.activities.findIndex(e => e.DisplayName === currentActivity.DisplayName);
         }
         return identifier;
     }
@@ -241,30 +222,12 @@ export class ControlUnit implements IAccessory {
      * Event handler for SET volume characteristic
      */
     private onSetVolumeSelector = async (value: any) => {
-        if (this.isExternal) {
+        switch (value) {
-            switch (value) {
+            case 0: this.dataProvider.volumeUp(this.name); break;
-                case 0: this.dataProvider.volumeUp(this.name); break;
+            case 1: this.dataProvider.volumeDown(this.name); break;
-                case 1: this.dataProvider.volumeDown(this.name); break;
-            }
         }
     }
 
-    /*********************
-     * 
-     * Information Service
-     * 
-     ********************/
-
-    /**
-     * Configure information service
-     */
-    private configureAccessoryInformation(): void {
-        this.informationService = new Service.AccessoryInformation(this.displayName, 'information');
-        this.informationService
-            .setCharacteristic(Characteristic.Manufacturer, 'Loftux Carwings')
-            .setCharacteristic(Characteristic.Model, 'Heater-Cooler')
-    }
-
     /*****************
      * 
      * Input services
@@ -276,13 +239,13 @@ export class ControlUnit implements IAccessory {
      */
     private configureInputSourceService(): void {
         let inputs: Array<HAPNodeJS.Service> = [];
-        this.activities.forEach((activity: Activity, index: number) => {
+        this.activities.forEach((activity: Config.IActivity, index: number) => {
-            let inputService = new Service.InputSource(activity.displayName, 'activity' + activity.displayName);
+            let inputService = new Service.InputSource(activity.DisplayName, 'activity' + activity.DisplayName);
             inputService
                 .setCharacteristic(Characteristic.Identifier, index)
                 .setCharacteristic(
                     Characteristic.ConfiguredName,
-                    activity.displayName)
+                    activity.DisplayName)
                 .setCharacteristic(
                     Characteristic.IsConfigured,
                     //@ts-ignore

src/Accessories/DeviceButton.ts

@@ -0,0 +1,150 @@
+import HarmonyDataProvider from "../DataProviders/HarmonyDataProvider";
+import { IDeviceButton } from "../Models/Config";
+import { IAccessory } from "./IAccessory";
+import { ICommand } from "../Models";
+
+let Service: HAPNodeJS.Service;
+let Characteristic: HAPNodeJS.Characteristic;
+
+export interface IDeviceButtonProps {
+    dataProvider: HarmonyDataProvider,
+    buttonName: string,
+    displayName: string,
+    deviceInfo: IDeviceButton,
+    api: any,
+    log: any,
+    homebridge: any,
+}
+
+export class DeviceButton implements IAccessory {
+    private _api: any;
+    private _homebridge: any;
+    private _log: any = {};
+
+    //Service fields
+    private _switchService: HAPNodeJS.Service;
+    private _infoService: HAPNodeJS.Service;
+
+    private _buttonInfo: IDeviceButton;
+
+    private _dataProvider: HarmonyDataProvider;
+
+    private _deviceCommand?: ICommand;
+
+    private _buttonState: boolean;
+
+    private _buttonName: string;
+
+
+    constructor(props: IDeviceButtonProps) {
+        //Assign class variables
+        this._log = props.log;
+        this._api = props.api;
+        Service = props.api.hap.Service;
+        Characteristic = props.api.hap.Characteristic;
+        this._buttonName = props.buttonName;
+        this.name = props.displayName;
+        this._homebridge = props.homebridge;
+
+        this._buttonInfo = props.deviceInfo;
+
+        this._dataProvider = props.dataProvider;
+
+        this._buttonState = false;
+
+        this.platformAccessory = new this._homebridge.platformAccessory(this.name, this.generateUUID(), this._homebridge.hap.Accessory.Categories.SWITCH);
+
+        //@ts-ignore
+        this._infoService = new Service.AccessoryInformation();
+        this._infoService.setCharacteristic(Characteristic.Manufacturer, "The Watson Project")
+        this._infoService.setCharacteristic(Characteristic.Model, "Device Button")
+        this._infoService.setCharacteristic(Characteristic.SerialNumber, "123-456-789");
+
+        this._switchService = new Service.Switch(
+            this.name,
+            'switchService'
+        )
+
+        this._switchService.getCharacteristic(Characteristic.On)
+            //@ts-ignore
+            .on("set", this.onSwitchSet)
+            .updateValue(this._buttonState)
+            .on("get", this.onSwitchGet);
+    }
+
+    /**
+     * Required by homebridge.
+     */
+    public name: string;
+
+    public platformAccessory: any;
+
+    /**
+     * Called by homebridge to gather services.
+     */
+    public getServices = (): Array<HAPNodeJS.Service> => {
+        return [this._infoService, this._switchService!];
+    }
+
+    /**
+     * Handler for switch set event
+     * @param callback The callback function to call when complete
+     */
+    private onSwitchSet = async (activeState: boolean, callback: (error?: Error | null | undefined) => void) => {
+        if (!this._buttonInfo.IsStateful && activeState === this._buttonState) {
+            return callback();
+        }
+
+        //Get device command if we don't have it
+        if (!this._deviceCommand) {
+            let cmd = this._dataProvider.getCommand(this._buttonInfo.ButtonName, this._buttonInfo.DeviceName);
+            if (cmd) {
+                this._deviceCommand = cmd;
+            }
+        }
+
+        //Execute command
+        if (this._deviceCommand) {
+            await this._dataProvider.sendCommand(this._deviceCommand);
+
+            //change state if stateful
+            if (this._buttonInfo.IsStateful) {
+                this._buttonState != this._buttonState
+            } else {
+                this._switchService.getCharacteristic(Characteristic.On).updateValue(false);
+                return callback(new Error("Normal Response"));
+            }
+
+        }
+        return callback();
+    }
+
+    /**
+     * Handler for switch get event
+     * @param callback The callback function to call when complete
+     */
+    private onSwitchGet = (callback: (error: Error | null, value: boolean) => void) => {
+        //Only return state if button is stateful
+        if (this._buttonInfo.IsStateful) {
+            return callback(null, this._buttonState);
+        } else {
+            return callback(null, false)
+        }
+
+    }
+
+    /**
+     * Helper function to generate a UUID
+     */
+    private generateUUID(): string { // Public Domain/MIT
+        var d = new Date().getTime();
+        if (typeof performance !== 'undefined' && typeof performance.now === 'function') {
+            d += performance.now(); //use high-precision timer if available
+        }
+        return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+            var r = (d + Math.random() * 16) % 16 | 0;
+            d = Math.floor(d / 16);
+            return (c === 'x' ? r : (r & 0x3 | 0x8)).toString(16);
+        });
+    }
+}

src/Accessories/index.ts

@@ -0,0 +1,3 @@
+export { ControlUnit } from './ControlUnit';
+export { DeviceButton } from './DeviceButton';
+export { IAccessory } from './IAccessory';

src/DataProviders/HarmonyDataProvider.ts

@@ -1,66 +1,65 @@
-import { Activity } from "../Models/Activity";
+import { IActivity } from "../Models/Config/IActivity";
-import { DeviceSetupItem } from "../Models/DeviceSetupItem";
+import { IDeviceSetupItem } from "../Models/Config/IDeviceSetupItem";
-import { Input, Matrix, Output } from "../Models/Matrix";
+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: Activity
+    currentActivity: IActivity
 }
 
 interface IHarmonyDataProviderProps {
     hubAddress: string,
     log: any,
-    matrix: Matrix
+    matrix: IMatrix
 }
 
-class HarmonyDataProvider {
+class HarmonyDataProvider extends EventEmitter {
-    private harmony: any;
+    private _harmony: any;
-    private log: any;
+    private _log: any;
-    private hubAddress: string = "";
+    private _hubAddress: string = "";
-    private connected: boolean = false;
+    private _connected: boolean = false;
 
-    private devices: { [name: string]: IDevice; } = {};
+    private _devices: { [name: string]: IDevice; } = {};
-    private states: { [controlUnitName: string]: (IActivityState | undefined) } = {};
+    private _states: { [controlUnitName: string]: (IActivityState | undefined) } = {};
 
-    private matrix: Matrix;
+    private _matrix: IMatrix;
 
     constructor(props: IHarmonyDataProviderProps) {
-        this.log = props.log;
+        super();
-        this.hubAddress = props.hubAddress;
+        this._log = props.log;
-        this.matrix = props.matrix;
+        this._hubAddress = props.hubAddress;
+        this._matrix = props.matrix;
 
-        this.harmony = new Harmony();
+        this._harmony = new Harmony();
 
         //Listeners
-        this.harmony.on('open', () => {
+        this._harmony.on('open', () => {
-            this.connected = true;
+            this._connected = true;
         });
-        this.harmony.on('close', () => {
+        this._harmony.on('close', () => {
-            this.connected = false;
+            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: 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,13 +69,13 @@ 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.deviceSetupItems
+        let devicesToTurnOff: Array<IDevice> = this._states[controlUnitName]!.currentActivity.DeviceSetupList
-            .map((value: DeviceSetupItem): IDevice => {
+            .map((value: IDeviceSetupItem): IDevice => {
-                return this.getDeviceFromName(value.deviceName);
+                return this.getDeviceFromName(value.DeviceName);
             });
 
         //Resolve device conflicts with other controlUnits
@@ -87,22 +86,22 @@ class HarmonyDataProvider {
             this.powerOffDevice(device);
         });
 
-        this.states[controlUnitName] = undefined;
+        this._states[controlUnitName] = undefined;
     }
 
     /**
      * Start an activity
      */
-    public startActivity = async (controlUnitName: string, activity: 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: Activity | undefined = undefined;
+        let lastActivity: IActivity | undefined = undefined;
-        if (this.states[controlUnitName]) {
+        if (this._states[controlUnitName]) {
-            lastActivity = this.states[controlUnitName]!.currentActivity;
+            lastActivity = this._states[controlUnitName]!.currentActivity;
         }
 
         //Build potential list of devices to to turn on
-        let devicesToTurnOn: Array<IDevice> = activity.deviceSetupItems.map((value: DeviceSetupItem): IDevice => {
+        let devicesToTurnOn: Array<IDevice> = activity.DeviceSetupList.map((value: IDeviceSetupItem): IDevice => {
-            return this.getDeviceFromName(value.deviceName);
+            return this.getDeviceFromName(value.DeviceName);
         });
 
         //Resolve device conflicts with other controlUnits
@@ -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);
                 }
             }
@@ -120,25 +119,25 @@ class HarmonyDataProvider {
 
         //Assign correct input
         await Promise.all(
-            activity.deviceSetupItems.map(async (value: DeviceSetupItem) => {
+            activity.DeviceSetupList.map(async (value: IDeviceSetupItem) => {
-                let device: IDevice = this.getDeviceFromName(value.deviceName);
+                let device: IDevice = this.getDeviceFromName(value.DeviceName);
 
-                if (device && device.supportsCommand(`Input${value.input}`)) {
+                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);
                 }
             })
         );
 
-        if (activity.useMatrix) {
+        if (activity.UseMatrix) {
             //get input and output
-            let input: Input = this.matrix.inputs.filter(e => e.inputDevice === activity.controlDeviceId)[0];
+            let input: IInput = this._matrix.Inputs.filter(e => e.InputDevice === activity.ControlDevice)[0];
-            let output: Output = this.matrix.outputs.filter(e => e.outputDevice === activity.outputDeviceId)[0];
+            let output: IOutput = this._matrix.Outputs.filter(e => e.OutputDevice === activity.OutputDevice)[0];
 
-            let inputCommandName: string = `In ${input.inputNumber}`;
+            let inputCommandName: string = `In ${input.InputNumber}`;
-            let outputCommandName: string = `Out ${output.outputLetter}`;
+            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)) {
@@ -151,15 +150,15 @@ class HarmonyDataProvider {
 
         //Build potential list of devices to turn off
         if (lastActivity) {
-            let devicesToTurnOff: Array<IDevice> = lastActivity.deviceSetupItems.map((value: DeviceSetupItem): IDevice => {
+            let devicesToTurnOff: Array<IDevice> = lastActivity.DeviceSetupList.map((value: IDeviceSetupItem): IDevice => {
-                return this.getDeviceFromName(value.deviceName);
+                return this.getDeviceFromName(value.DeviceName);
             });
 
             //remove devices that will be used for next activity from list
             //delete array[index] is stupid because it just nulls out the index. But now i have to deal with nulls
             devicesToTurnOff.forEach((device: IDevice, index: number) => {
-                if (device && device.name && activity.deviceSetupItems.some(e => {
+                if (device && device.name && activity.DeviceSetupList.some(e => {
-                    return (e && e.deviceName === device.name)
+                    return (e && e.DeviceName === device.name)
                 })) {
                     delete devicesToTurnOff[index];
                 }
@@ -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]) {
+        if (this._states[controlUnitName]) {
-            let volumeDevice: IDevice = this.getDeviceFromName(this.states[controlUnitName]!.currentActivity.volumeDeviceId);
+            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]) {
+        if (this._states[controlUnitName]) {
-            let volumeDevice: IDevice = this.getDeviceFromName(this.states[controlUnitName]!.currentActivity.volumeDeviceId);
+            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.controlDeviceId);
+            let device: IDevice = this.getDeviceFromName(this._states[controlUnitName]!.currentActivity.ControlDevice);
             switch (key) {
                 case RemoteKey.ARROW_UP: {
                     commandName = "Direction Up";
@@ -274,31 +273,62 @@ class HarmonyDataProvider {
      * Return if a control unit is active
      * @param controlUnitName 
      */
-    public getIsActive(controlUnitName: string): Activity | undefined {
+    public getIsActive(controlUnitName: string): IActivity | undefined {
-        return this.states[controlUnitName] ? this.states[controlUnitName]!.currentActivity : undefined;
+        return this._states[controlUnitName] ? this._states[controlUnitName]!.currentActivity : undefined;
+    }
+
+    /**
+     * Gets device button commands
+     * @param deviceCommandName The device command name
+     * @param deviceName The device name
+     */
+    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 undefined;
+        }
+    }
+
+    /**
+     * Send a command to the harmony hub.
+     * @param command The command to send.
+     */
+    public sendCommand = async (command: ICommand) => {
+        try {
+            //Execute 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}`);
+        }
+
     }
 
     /**
      * 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) {
+            if (self._connected) {
-                let devices: any = await self.harmony.getDevices();
+                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 commands: { [name: string]: ICommand } = {};
-                            let deviceCommands: any = await self.harmony.getDeviceCommands(dev.id);
+                            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,
@@ -308,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);
@@ -357,7 +388,7 @@ class HarmonyDataProvider {
      * @param deviceName The device to retrieve.
      */
     private getDeviceFromName(deviceName: string): IDevice {
-        return this.devices[deviceName];
+        return this._devices[deviceName];
     }
 
     /**
@@ -366,18 +397,18 @@ 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.deviceSetupItems.forEach((value: DeviceSetupItem) => {
+                currentOtherState.currentActivity.DeviceSetupList.forEach((value: IDeviceSetupItem) => {
                     //there are devices to remove
-                    if (devicesToTurnOn.some(e => e && e.name === value.deviceName)) {
+                    if (devicesToTurnOn.some(e => e && e.name === value.DeviceName)) {
-                        let deviceToRemove: IDevice = devicesToTurnOn.filter(i => i.name === value.deviceName)[0];
+                        let deviceToRemove: IDevice = devicesToTurnOn.filter(i => i.name === value.DeviceName)[0];
                         delete devicesToTurnOn[devicesToTurnOn.indexOf(deviceToRemove)];
                     }
                 });
@@ -386,23 +417,6 @@ class HarmonyDataProvider {
 
         return devicesToTurnOn;
     }
-
-    /**
-     * Send a command to the harmony hub.
-     * @param command The command to send.
-     */
-    private sendCommand = async (command: string) => {
-        try {
-            //Execute 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}`);
-        }
-
-    }
 }
 
 export default HarmonyDataProvider;

src/Models/Activity.ts

@@ -1,69 +0,0 @@
-import { DeviceSetupItem } from './DeviceSetupItem';
-/**
- * Input properties.
- */
-export interface IActivityProps {
-    deviceList: Array<DeviceSetupItem>,
-    controlDeviceId: string,
-    volumeDeviceId: string,
-    outputDeviceId: string,
-    displayName: string
-    useMatrix: boolean,
-}
-
-/**
- * Data model class to hold activity related information.
- */
-export class Activity {
-    private _volumeDeviceId: string = "";
-    private _outputDeviceId: string = "";
-    private _controlDeviceId: string = "";
-    private _displayName: string = "";
-    private _deviceSetupItems: Array<DeviceSetupItem>;
-    private _useMatrix: boolean = false;
-
-    constructor(props: IActivityProps) {
-        this._controlDeviceId = props.controlDeviceId;
-        this._outputDeviceId = props.outputDeviceId;
-        this._volumeDeviceId = props.volumeDeviceId;
-        this._displayName = props.displayName;
-        this._deviceSetupItems = props.deviceList;
-        this._useMatrix = props.useMatrix
-    }
-
-    /**
-     * The device associated with main control.
-     */
-    public get controlDeviceId(): string {
-        return this._controlDeviceId;
-    };
-
-    /**
-     * The device associated with the volume control.
-     */
-    public get volumeDeviceId(): string {
-        return this._volumeDeviceId
-    };
-
-    /**
-     * The device associated with output.
-     */
-    public get outputDeviceId(): string {
-        return this._outputDeviceId;
-    };
-
-    /**
-     * The display name of the activity.
-     */
-    public get displayName(): string {
-        return this._displayName;
-    }
-
-    public get deviceSetupItems(): Array<DeviceSetupItem> {
-        return this._deviceSetupItems
-    }
-
-    public get useMatrix(): boolean {
-        return this._useMatrix;
-    }
-}

src/Models/Config/IActivity.ts

@@ -0,0 +1,11 @@
+import { IDeviceSetupItem } from './IDeviceSetupItem';
+
+export interface IActivity {
+    OutputDevice: string;
+    VolumeDevice: string;
+    ControlDevice: string;
+    DisplayName: string;
+    DeviceSetupList: Array<IDeviceSetupItem>;
+    UseMatrix: boolean;
+
+}

src/Models/Config/IConfig.ts

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

src/Models/Config/IDeviceButton.ts

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

src/Models/Config/IDeviceSetupItem.ts

@@ -0,0 +1,5 @@
+
+export interface IDeviceSetupItem {
+    DeviceName: string;
+    Input: string;
+}

src/Models/Config/IMatrix.ts

@@ -0,0 +1,15 @@
+export interface IInput {
+    InputNumber: string,
+    InputDevice: string,
+}
+
+export interface IOutput {
+    OutputLetter: string,
+    OutputDevice: string,
+}
+
+export interface IMatrix {
+    Inputs: Array<IInput>;
+    Outputs: Array<IOutput>;
+    DeviceName: string;
+}

src/Models/Config/index.ts

@@ -0,0 +1,5 @@
+export * from './IActivity';
+export * from './IConfig';
+export * from './IDeviceButton';
+export * from './IDeviceSetupItem';
+export * from './IMatrix';

src/Models/DeviceSetupItem.ts

@@ -1,25 +0,0 @@
-
-export interface IDeviceSetupItemProps {
-    deviceName: string,
-    input: string
-}
-
-/**
- * Data model to hold device setup items.
- */
-export class DeviceSetupItem {
-    private _deviceId: string = "";
-    private _input: string = "";
-    constructor(props: IDeviceSetupItemProps) {
-        this._deviceId = props.deviceName;
-        this._input = props.input;
-    }
-
-    public get deviceName() {
-        return this._deviceId;
-    }
-
-    public get input() {
-        return this._input;
-    }
-}

src/Models/IDevice.ts

@@ -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;
+}

src/Models/Matrix.ts

@@ -1,42 +0,0 @@
-export interface IMatrixProps {
-    inputs: Array<Input>,
-    outputs: Array<Output>,
-    deviceName: string,
-}
-
-export interface Input {
-    inputNumber: string,
-    inputDevice: string,
-}
-
-export interface Output {
-    outputLetter: string,
-    outputDevice: string,
-}
-
-/**
- * Data model to hold matrix information.
- */
-export class Matrix {
-    private _inputs: Array<Input> = [];
-    private _outputs: Array<Output> = [];
-    private _deviceName: string;
-
-    constructor(props: IMatrixProps) {
-        this._inputs = props.inputs;
-        this._outputs = props.outputs;
-        this._deviceName = props.deviceName;
-    }
-
-    public get inputs(): Array<Input> {
-        return this._inputs
-    }
-
-    public get outputs(): Array<Output> {
-        return this._outputs;
-    }
-
-    public get deviceName(): string {
-        return this._deviceName;
-    }
-}

src/Models/index.ts

@@ -0,0 +1 @@
+export * from './IDevice';

src/index.ts

@@ -1,8 +1,7 @@
-import { ControlUnit } from "./Accessories/ControlUnit";
+import * as Accessories from "./Accessories";
-import { Activity } from "./Models/Activity";
-import { DeviceSetupItem } from "./Models/DeviceSetupItem";
-import { Input, Output, Matrix } from "./Models/Matrix";
 import HarmonyDataProvider from "./DataProviders/HarmonyDataProvider";
+import * as Config from "./Models/Config";
+import { IDevice } from "./Models";
 
 let Accessory: any;
 let Homebridge: any;
@@ -24,10 +23,10 @@ export default function (homebridge: any) {
 
 class HarmonyMatrixPlatform {
     log: any = {};
-    config: any = {};
+    config: Config.IConfig;
     api: any;
-    externalAccessories: Array<any> = [];
     dataProvider: HarmonyDataProvider | null;
+    accessoryList: Array<Accessories.IAccessory> = [];
 
     constructor(log: any, config: any, api: any) {
         this.log = log;
@@ -37,7 +36,28 @@ class HarmonyMatrixPlatform {
         this.api.on('didFinishLaunching', this.didFinishLaunching.bind(this));
 
         this.dataProvider = null;
-        this.log("This is new");
+
+        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}`);
+                        });
+                    });
+                });
+            }
+        }
     }
 
     /**
@@ -48,129 +68,44 @@ class HarmonyMatrixPlatform {
         this.log(`Publishing external accessories`);
 
         //This is required in order to have multiple tv remotes on one platform
-        this.externalAccessories.forEach((accessory: ControlUnit) => {
+        this.accessoryList.forEach((accessory: Accessories.IAccessory) => {
-            this.api.publishExternalAccessories("HarmonyMatrixPlatform", [accessory.platformAccessory]);
+            if (accessory instanceof Accessories.ControlUnit) {
+                this.api.publishExternalAccessories("HarmonyMatrixPlatform", [accessory.platformAccessory]);
+            }
         })
-
     }
 
     /**
      * Called by homebridge to gather accessories.
      * @param callback 
      */
-    accessories(callback: (accessories: Array<ControlUnit>) => void) {
+    accessories(callback: (accessories: Array<Accessories.IAccessory>) => void) {
-        //Parse ip
-        let hubIp: string = this.config["hubIp"];
 
-        //Parse matrix
+        //Add control units
-        let configInputs: any = this.config["Matrix"]["Inputs"];
+        this.config.ControlUnits.forEach((unit: Config.IControlUnit) => {
-        let configOutputs: any = this.config["Matrix"]["Outputs"];
+            this.accessoryList.push(new Accessories.ControlUnit({
-        let matrixName: string = this.config["Matrix"]["DeviceName"];
-
-        let inputs: Array<Input> = [];
-        let outputs: Array<Output> = [];
-
-        configInputs.forEach((configInput: any) => {
-            let inputDevice: string = configInput["InputDevice"];
-            let inputNumber: string = configInput["InputNumber"];
-
-            this.log(`INFO - Added input to matrix '${inputDevice}'`);
-
-            inputs.push({
-                inputDevice: inputDevice,
-                inputNumber: inputNumber
-            });
-        });
-        configOutputs.forEach((configOutput: any) => {
-            let outputDevice: string = configOutput["OutputDevice"];
-            let outputLetter: string = configOutput["OutputLetter"];
-
-            this.log(`INFO - Added output to matrix '${outputDevice}'`);
-
-            outputs.push({
-                outputDevice: outputDevice,
-                outputLetter: outputLetter
-            });
-
-        });
-
-        let matrix = new Matrix({
-            inputs: inputs,
-            outputs: outputs,
-            deviceName: matrixName,
-        });
-
-        //construct data provider
-        this.dataProvider = new HarmonyDataProvider({
-            hubAddress: hubIp,
-            matrix: matrix,
-            log: this.log
-        });
-
-        //Parse control units
-        let configControlUnits: any = this.config["ControlUnits"];
-        let controlUnits: Array<ControlUnit> = [];
-        configControlUnits.forEach((configControlUnit: any) => {
-            //Parse activities list
-            let configActivities: any = configControlUnit["Activities"];
-            let activities: Array<Activity> = [];
-            configActivities.forEach((configActivity: any) => {
-                //parse devices
-                let configDevices: any = configActivity["DeviceSetupList"];
-                let devices: Array<DeviceSetupItem> = [];
-                configDevices.forEach((configDevice: any) => {
-                    //Add device
-                    devices.push(new DeviceSetupItem({
-                        deviceName: configDevice["DeviceName"],
-                        input: configDevice["Input"]
-                    }));
-                    this.log(`INFO - Added device '${configDevice["DeviceName"]}' for activity '${configActivity["DisplayName"]}'`);
-                });
-
-                //Add activity
-                activities.push(new Activity({
-                    volumeDeviceId: configActivity["VolumeDevice"],
-                    controlDeviceId: configActivity["ControlDevice"],
-                    outputDeviceId: configActivity["OutputDevice"],
-                    displayName: configActivity["DisplayName"],
-                    useMatrix: configActivity["UseMatrix"] === "true" ? true : false,
-                    deviceList: devices
-                }));
-                this.log(`INFO - Added activity '${configActivity["DisplayName"]}'`);
-            });
-
-            let controlUnit: ControlUnit = new ControlUnit({
                 dataProvider: this.dataProvider!,
-                displayName: configControlUnit["DisplayName"],
+                displayName: unit.DisplayName,
                 api: this.api,
                 log: this.log,
-                activities: activities,
+                activities: unit.Activities,
                 homebridge: Homebridge,
-                isExternal: false
+            }));
-            });
+        });
 
-            let controlUnitExternal: ControlUnit = new ControlUnit({
+        //Add device buttons
+        this.config.DeviceButtons.forEach((button: Config.IDeviceButton) => {
+            this.accessoryList.push(new Accessories.DeviceButton({
                 dataProvider: this.dataProvider!,
-                displayName: `${configControlUnit["DisplayName"]}`,
+                buttonName: button.ButtonName,
+                displayName: button.DisplayName,
+                deviceInfo: button,
                 api: this.api,
                 log: this.log,
-                activities: activities,
                 homebridge: Homebridge,
-                isExternal: true
-            });
 
-            //@ts-ignore
+            }))
-            let accessory = controlUnit as homebridge.platformAccessory;
-            //@ts-ignore
-            let externalAccessory = controlUnitExternal as homebridge.platformAccessory;
-
-            //Add control unit
-            controlUnits.push(accessory);
-            //Add to list of remotes
-            this.externalAccessories.push(externalAccessory);
-
-            this.log(`INFO - Added ControlUnit`);
         });
-        callback(controlUnits);
+        callback(this.accessoryList);
     }
 }