isy-nodejs 0.5.0-beta.9 → 1.0.1-alpha.1

package/lib/Categories.js

@@ -1,21 +0,0 @@
-Object.defineProperty(exports, "__esModule", { value: true });
-var Categories;
-(function (Categories) {
-    Categories[Categories["Controller"] = 0] = "Controller";
-    Categories[Categories["DimmableControl"] = 1] = "DimmableControl";
-    Categories[Categories["RelayControl"] = 2] = "RelayControl";
-    Categories[Categories["NetworkBridge"] = 3] = "NetworkBridge";
-    Categories[Categories["IrrigationControl"] = 4] = "IrrigationControl";
-    Categories[Categories["ClimateControl"] = 5] = "ClimateControl";
-    Categories[Categories["PoolControl"] = 6] = "PoolControl";
-    Categories[Categories["SensorActuator"] = 7] = "SensorActuator";
-    Categories[Categories["HomeEntertainment"] = 8] = "HomeEntertainment";
-    Categories[Categories["EnergyManagement"] = 9] = "EnergyManagement";
-    Categories[Categories["ApplianceControl"] = 10] = "ApplianceControl";
-    Categories[Categories["WindowShadeControl"] = 14] = "WindowShadeControl";
-    Categories[Categories["AccessControl"] = 15] = "AccessControl";
-    Categories[Categories["SecurityHealthSafety"] = 16] = "SecurityHealthSafety";
-    Categories[Categories["A10X10"] = 113] = "A10X10";
-    Categories[Categories["Virtual"] = 127] = "Virtual";
-    Categories[Categories["Unknown"] = 254] = "Unknown";
-})(Categories = exports.Categories || (exports.Categories = {}));

package/lib/DeviceFactory.d.ts

@@ -1,37 +0,0 @@
-import { ISYDevice } from './ISY';
-export declare class DeviceFactory {
-    static createDevice(nodeDef: any): {
-        name: string;
-        modelNumber: string;
-        version: string;
-        class: typeof ISYDevice;
-    };
-    static getDeviceDetails(family: number, typeCode: string): {
-        name: string;
-        modelNumber: string;
-        version: string;
-        class: typeof ISYDevice;
-    };
-    static getInsteonDeviceDetails(typeCode: string): {
-        name: string;
-        modelNumber: string;
-        version: string;
-        class: typeof ISYDevice;
-    };
-    static getNLSNetworkBridgeInfo(device: number): any;
-    static getNLSIrrigationControlInfo(device: number): string;
-    static getNLSSwitchLightInfo(device: number): {
-        name: string;
-        modelNumber: string;
-        version: string;
-        class: typeof ISYDevice;
-    };
-    private static getNLSDimLightInfo;
-    private static getNLSControllerInfo;
-    private static getNLSIOControlInfo;
-    private static getNLSSHS;
-    private static getNLSClimateControlInfo;
-    private static getNLSAccessControlInfo;
-    private static getNLSEnergyManagement;
-    private static getNLSWindowsCovering;
-}

package/lib/Devices/Elk/ElkAlarmPanelDevice.d.ts

@@ -1,56 +0,0 @@
-import { Family } from '../../Families';
-import { ISYDevice } from '../ISYDevice';
-import { ISY } from '../../ISY';
-export declare class ELKAlarmPanelDevice extends ISYDevice<Family.Elk> {
-    alarmTripState: AlarmTripState;
-    alarmState: AlarmState;
-    alarmMode: AlarmMode;
-    constructor(isy: ISY, area: number);
-    sendCommand(command: any): Promise<any>;
-    sendSetAlarmModeCommand(alarmState: any): Promise<any>;
-    clearAllBypasses(): Promise<any>;
-    getAlarmStatusAsText(): string;
-    getAlarmTripState(): AlarmTripState;
-    getAlarmState(): AlarmState;
-    getAlarmMode(): AlarmMode;
-    handleEvent(event: any): boolean;
-}
-export declare enum AlarmPanelProperty {
-    AlarmMode = 3,
-    AlarmState = 2,
-    AlarmTripState = 1
-}
-export declare enum AlarmMode {
-    DISARMED = 0,
-    AWAY = 1,
-    STAY = 2,
-    STAY_INSTANT = 3,
-    NIGHT = 4,
-    NIGHT_INSTANT = 5,
-    VACATION = 6
-}
-export declare enum AlarmTripState {
-    DISARMED = 0,
-    EXIT_DELAY = 1,
-    TRIPPED = 2
-}
-export declare enum AlarmState {
-    NOT_READY_TO_ARM = 0,
-    READY_TO_ARM = 1,
-    READY_TO_ARM_VIOLATION = 2,
-    ARMED_WITH_TIMER = 3,
-    ARMED_FULLY = 4,
-    FORCE_ARMED_VIOLATION = 5,
-    ARMED_WITH_BYPASS = 6
-}
-export declare class ElkAlarmSensorDevice extends ISYDevice<Family.Elk> {
-    constructor(isy: any, name: any, area: any, zone: any);
-    sendBypassToggleCommand(): Promise<any>;
-    getPhysicalState(): any;
-    isBypassed(): boolean;
-    getLogicalState(): any;
-    getCurrentDoorWindowState(): boolean;
-    getSensorStatus(): string;
-    isPresent(): boolean;
-    handleEvent(event: any): boolean;
-}

package/lib/Devices/ISYDevice.d.ts

@@ -1,154 +0,0 @@
-/// <reference types="node" />
-import { Family } from '../Families';
-import { ISY } from '../ISY';
-import { ISYNode } from '../ISYNode';
-import { ISYScene } from '../ISYScene';
-export declare class ISYDevice<T extends Family> extends ISYNode {
-    family: T;
-    readonly typeCode: string;
-    readonly deviceClass: any;
-    readonly parentAddress: any;
-    readonly category: number;
-    readonly subCategory: number;
-    readonly type: any;
-    _parentDevice: ISYDevice<T>;
-    readonly children: ISYDevice<T>[];
-    readonly scenes: ISYScene[];
-    readonly formatted: any[string];
-    readonly uom: any[string];
-    readonly pending: any[string];
-    hidden: boolean;
-    location: string;
-    constructor(isy: ISY, node: {
-        family: any;
-        type?: any;
-        enabled: any;
-        deviceClass?: any;
-        pnode?: any;
-        property?: any;
-        flag?: any;
-        nodeDefId?: string;
-        address?: string;
-        name?: string;
-        parent?: any;
-        ELK_ID?: string;
-    });
-    convertTo(value: any, uom: number): any;
-    convertFrom(value: any, uom: number): any;
-    addLink(isyScene: ISYScene): void;
-    addChild(childDevice: ISYDevice<T>): void;
-    get parentDevice(): ISYDevice<T>;
-    refreshProperty(propertyName: string): Promise<any>;
-    refreshNotes(): Promise<void>;
-    getNotes(): Promise<any>;
-    updateProperty(propertyName: string, value: string): Promise<any>;
-    sendCommand(command: any, ...parameters: any[]): Promise<any>;
-    refresh(): Promise<any>;
-    handlePropertyChange(propertyName: string, value: any, formattedValue: string): boolean;
-}
-declare type Constructor<T> = new (...args: any[]) => T;
-export declare const ISYBinaryStateDevice: <T extends Constructor<ISYDevice<any>>>(Base: T) => {
-    new (...args: any[]): {
-        [x: string]: any;
-        readonly state: boolean;
-        updateState(state: boolean): Promise<any>;
-        family: any;
-        readonly typeCode: string;
-        readonly deviceClass: any;
-        readonly parentAddress: any;
-        readonly category: number;
-        readonly subCategory: number;
-        readonly type: any;
-        _parentDevice: ISYDevice<any>;
-        readonly children: ISYDevice<any>[];
-        readonly scenes: ISYScene[];
-        readonly formatted: any;
-        readonly uom: any;
-        readonly pending: any;
-        hidden: boolean;
-        location: string;
-        convertTo(value: any, uom: number): any;
-        convertFrom(value: any, uom: number): any;
-        addLink(isyScene: ISYScene): void;
-        addChild(childDevice: ISYDevice<any>): void;
-        readonly parentDevice: ISYDevice<any>;
-        refreshProperty(propertyName: string): Promise<any>;
-        refreshNotes(): Promise<void>;
-        getNotes(): Promise<any>;
-        updateProperty(propertyName: string, value: string): Promise<any>;
-        sendCommand(command: any, ...parameters: any[]): Promise<any>;
-        refresh(): Promise<any>;
-        handlePropertyChange(propertyName: string, value: any, formattedValue: string): boolean;
-        readonly isy: ISY;
-        readonly flag: any;
-        readonly nodeDefId: string;
-        readonly address: string;
-        name: string;
-        displayName: string;
-        folder: string;
-        parent: any;
-        parentType: import("../ISYConstants").NodeType;
-        readonly elkId: string;
-        nodeType: number;
-        propertyChanged: import("events").EventEmitter;
-        propsInitialized: boolean;
-        logger: (msg: any) => void;
-        lastChanged: Date;
-        enabled: boolean;
-        handleEvent(event: any): boolean;
-        onPropertyChanged(propertyName: any, callback: (...args: any[]) => void): void;
-    };
-} & T;
-export declare const ISYLevelDevice: <T extends Constructor<ISYDevice<any>>>(base: T) => {
-    new (...args: any[]): {
-        [x: string]: any;
-        readonly level: number;
-        updateLevel(level: number): Promise<any>;
-        family: any;
-        readonly typeCode: string;
-        readonly deviceClass: any;
-        readonly parentAddress: any;
-        readonly category: number;
-        readonly subCategory: number;
-        readonly type: any;
-        _parentDevice: ISYDevice<any>;
-        readonly children: ISYDevice<any>[];
-        readonly scenes: ISYScene[];
-        readonly formatted: any;
-        readonly uom: any;
-        readonly pending: any;
-        hidden: boolean;
-        location: string;
-        convertTo(value: any, uom: number): any;
-        convertFrom(value: any, uom: number): any;
-        addLink(isyScene: ISYScene): void;
-        addChild(childDevice: ISYDevice<any>): void;
-        readonly parentDevice: ISYDevice<any>;
-        refreshProperty(propertyName: string): Promise<any>;
-        refreshNotes(): Promise<void>;
-        getNotes(): Promise<any>;
-        updateProperty(propertyName: string, value: string): Promise<any>;
-        sendCommand(command: any, ...parameters: any[]): Promise<any>;
-        refresh(): Promise<any>;
-        handlePropertyChange(propertyName: string, value: any, formattedValue: string): boolean;
-        readonly isy: ISY;
-        readonly flag: any;
-        readonly nodeDefId: string;
-        readonly address: string;
-        name: string;
-        displayName: string;
-        folder: string;
-        parent: any;
-        parentType: import("../ISYConstants").NodeType;
-        readonly elkId: string;
-        nodeType: number;
-        propertyChanged: import("events").EventEmitter;
-        propsInitialized: boolean;
-        logger: (msg: any) => void;
-        lastChanged: Date;
-        enabled: boolean;
-        handleEvent(event: any): boolean;
-        onPropertyChanged(propertyName: any, callback: (...args: any[]) => void): void;
-    };
-} & T;
-export {};

package/lib/Devices/ISYDevice.js

@@ -1,212 +0,0 @@
-Object.defineProperty(exports, "__esModule", { value: true });
-const util_1 = require("util");
-const Families_1 = require("../Families");
-const ISY_1 = require("../ISY");
-const ISYConstants_1 = require("../ISYConstants");
-const ISYNode_1 = require("../ISYNode");
-class ISYDevice extends ISYNode_1.ISYNode {
-    constructor(isy, node) {
-        var _a;
-        super(isy, node);
-        this.children = [];
-        this.scenes = [];
-        this.formatted = {};
-        this.uom = {};
-        this.pending = {};
-        this.hidden = false;
-        this.family = (_a = node.family, (_a !== null && _a !== void 0 ? _a : Families_1.Family.Generic));
-        this.nodeType = 1;
-        this.type = node.type;
-        this._enabled = node.enabled;
-        this.deviceClass = node.deviceClass;
-        this.parentAddress = node.pnode;
-        const s = this.type.split('.');
-        this.category = Number(s[0]);
-        this.subCategory = Number(s[1]);
-        // console.log(nodeDetail);
-        if (this.parentAddress !== this.address &&
-            this.parentAddress !== undefined) {
-            this._parentDevice = isy.getDevice(this.parentAddress);
-            if (!util_1.isNullOrUndefined(this._parentDevice)) {
-                this._parentDevice.addChild(this);
-            }
-        }
-        if (Array.isArray(node.property)) {
-            for (const prop of node.property) {
-                this[prop.id] = this.convertFrom(Number(prop.value), Number(prop.uom));
-                this.formatted[prop.id] = prop.formatted;
-                this.uom[prop.id] = prop.uom;
-                this.logger(`Property ${ISY_1.Controls[prop.id].label} (${prop.id}) initialized to: ${this[prop.id]} (${this.formatted[prop.id]})`);
-            }
-        }
-        else {
-            this[node.property.id] = this.convertFrom(Number(node.property.value), Number(node.property.uom));
-            this.formatted[node.property.id] = node.property.formatted;
-            this.uom[node.property.id] = node.property.uom;
-            this.logger(`Property ${ISY_1.Controls[node.property.id].label} (${node.property.id}) initialized to: ${this[node.property.id]} (${this.formatted[node.property.id]})`);
-        }
-    }
-    convertTo(value, uom) {
-        return value;
-    }
-    convertFrom(value, uom) {
-        return value;
-    }
-    addLink(isyScene) {
-        this.scenes.push(isyScene);
-    }
-    addChild(childDevice) {
-        this.children.push(childDevice);
-    }
-    get parentDevice() {
-        if (this._parentDevice === undefined) {
-            if (this.parentAddress !== this.address &&
-                this.parentAddress !== null &&
-                this.parentAddress !== undefined) {
-                this._parentDevice = this.isy.getDevice(this.parentAddress);
-                if (this._parentDevice !== null) {
-                    this._parentDevice.addChild(this);
-                }
-            }
-            this._parentDevice = null;
-        }
-        return this._parentDevice;
-    }
-    async refreshProperty(propertyName) {
-        return this.isy.callISY(`nodes/${this.address}/status/${propertyName}`);
-    }
-    async refreshNotes() {
-        var _a;
-        const that = this;
-        try {
-            const result = await this.getNotes();
-            if (result !== null && result !== undefined) {
-                that.location = result.location;
-                that.displayName = (_a = that.location, (_a !== null && _a !== void 0 ? _a : that.folder)) + ' ' + result.spoken;
-                that.logger('The friendly name updated to: ' + that.displayName);
-            }
-            else {
-                that.logger('No notes found.');
-            }
-        }
-        catch (e) {
-            that.logger(e);
-        }
-    }
-    async getNotes() {
-        try {
-            let result = await this.isy.callISY(`nodes/${this.address}/notes`);
-            if (result !== null && result !== undefined)
-                return result.NodeProperties;
-            else
-                return null;
-        }
-        catch (e) {
-            return null;
-        }
-    }
-    async updateProperty(propertyName, value) {
-        const val = this.convertTo(Number(value), Number(this.uom[propertyName]));
-        this.logger(`Updating property ${ISY_1.Controls[propertyName].label}. incoming value: ${value} outgoing value: ${val}`);
-        this.pending[propertyName] = value;
-        return this.isy
-            .sendISYCommand(`nodes/${this.address}/set/${propertyName}/${val}`)
-            .then((p) => {
-            this[propertyName] = value;
-            this.pending[propertyName] = null;
-        });
-    }
-    async sendCommand(command, ...parameters) {
-        return this.isy.sendNodeCommand(this, command, ...parameters);
-    }
-    async refresh() {
-        const device = this;
-        const result = await this.isy.callISY(`nodes/${this.address}/status`);
-        const node = result.node;
-        // this.logger(node);
-        if (Array.isArray(node.property)) {
-            for (const prop of node.property) {
-                device[prop.id] = Number(prop.value);
-                device.formatted[prop.id] = prop.formatted;
-                device.uom[prop.id] = prop.uom;
-                device.logger(`Property ${ISY_1.Controls[prop.id].label} (${prop.id}) refreshed to: ${device[prop.id]} (${device.formatted[prop.id]})`);
-            }
-        }
-        else {
-            device[node.property.id] = Number(node.property.value);
-            device.formatted[node.property.id] = node.property.formatted;
-            device.uom[node.property.id] = node.property.uom;
-            device.logger('Property ' + ISY_1.Controls[node.property.id].label + ' (' + node.property.id + ') refreshed to: ' + device[node.property.id] + ' (' + device.formatted[node.property.id] + ')');
-        }
-        return result;
-    }
-    handlePropertyChange(propertyName, value, formattedValue) {
-        let changed = false;
-        try {
-            const val = this.convertFrom(Number(value), Number(this.uom[propertyName]));
-            if (this[propertyName] !== val) {
-                this.logger(`Property ${ISY_1.Controls[propertyName].label} (${propertyName}) updated to: ${val} (${formattedValue})`);
-                this[propertyName] = val;
-                this.formatted[propertyName] = formattedValue;
-                this.lastChanged = new Date();
-                changed = true;
-            }
-            else {
-                this.logger(`Update event triggered, property ${ISY_1.Controls[propertyName].label} (${propertyName}) is unchanged.`);
-            }
-            if (changed) {
-                this.propertyChanged.emit(propertyName, propertyName, val, formattedValue);
-                this.propertyChanged.emit('', propertyName, val, formattedValue);
-                this.scenes.forEach((element) => {
-                    this.logger('Recalulating ' + element.name);
-                    element.recalculateState();
-                });
-            }
-        }
-        finally {
-            return changed;
-        }
-    }
-}
-exports.ISYDevice = ISYDevice;
-exports.ISYBinaryStateDevice = (Base) => {
-    return class extends Base {
-        get state() {
-            return this.ST > 0;
-        }
-        async updateState(state) {
-            if (state !== this.state || this.pending.ST > 0 !== this.state) {
-                this.pending.ST = state ? ISYConstants_1.States.On : ISYConstants_1.States.Off;
-                return this.sendCommand(state ? ISYConstants_1.Commands.On : ISYConstants_1.Commands.Off).then((p) => {
-                    this.ST = this.pending.ST;
-                    this.pending.ST = null;
-                });
-            }
-            return Promise.resolve({});
-        }
-    };
-};
-// tslint:disable-next-line: variable-name
-exports.ISYLevelDevice = (base) => class extends base {
-    get level() {
-        return this.ST;
-    }
-    async updateLevel(level) {
-        if (level !== this.ST || level !== this.pending.ST) {
-            this.pending.ST = level;
-            if (level > 0) {
-                return this.sendCommand(ISYConstants_1.Commands.On, this.convertTo(level, Number(this.uom.ST))).then((p) => {
-                    this.ST = this.pending.ST;
-                    this.pending.ST = null;
-                });
-            }
-            else {
-                return this.sendCommand(ISYConstants_1.Commands.Off).then((p) => {
-                    this.ST = this.pending.ST;
-                    this.pending.ST = null;
-                });
-            }
-        }
-        return Promise.resolve({});
-    }
-};

package/lib/Devices/Insteon/InsteonBaseDevice.d.ts

@@ -1,9 +0,0 @@
-import { Family } from '../../Families';
-import { ISY } from '../../ISY';
-import { ISYDevice } from '../ISYDevice';
-export declare class InsteonBaseDevice extends ISYDevice<Family.Insteon> {
-    constructor(isy: ISY, node: any);
-    convertFrom(value: any, uom: number): any;
-    convertTo(value: any, uom: number): any;
-    sendBeep(level?: number): Promise<any>;
-}

package/lib/Devices/Insteon/InsteonBaseDevice.js

@@ -1,42 +0,0 @@
-Object.defineProperty(exports, "__esModule", { value: true });
-const Families_1 = require("../../Families");
-const Utils_1 = require("../../Utils");
-const ISYDevice_1 = require("../ISYDevice");
-//import { InsteonNLS } from './insteonfam'
-class InsteonBaseDevice extends ISYDevice_1.ISYDevice {
-    constructor(isy, node) {
-        super(isy, node);
-        this.family = Families_1.Family.Insteon;
-        ////this.productName = InsteonNLS.getDeviceDescription(String.fromCharCode(category,device,version));
-        this.childDevices = {};
-    }
-    convertFrom(value, uom) {
-        switch (uom) {
-            case 101:
-                return Utils_1.byteToDegree(value);
-            case 100:
-                return Utils_1.byteToPct(value);
-            case 17:
-                return value / 10;
-            default:
-                return super.convertFrom(value, uom);
-        }
-    }
-    convertTo(value, uom) {
-        const nuom = super.convertTo(value, uom);
-        switch (uom) {
-            case 101:
-                return nuom * 2;
-            case 100:
-                return Utils_1.pctToByte(nuom);
-            case 17:
-                return Math.round(value * 10);
-            default:
-                return nuom;
-        }
-    }
-    async sendBeep(level = 100) {
-        return this.sendCommand(this, 'BEEP');
-    }
-}
-exports.InsteonBaseDevice = InsteonBaseDevice;

package/lib/Devices/Insteon/InsteonCOSensorDevice.d.ts

@@ -1,62 +0,0 @@
-/// <reference types="node" />
-import { ISY } from '../../ISY';
-import { InsteonBaseDevice } from './InsteonBaseDevice';
-declare const InsteonCOSensorDevice_base: {
-    new (...args: any[]): {
-        [x: string]: any;
-        readonly state: boolean;
-        updateState(state: boolean): Promise<any>;
-        family: any;
-        readonly typeCode: string;
-        readonly deviceClass: any;
-        readonly parentAddress: any;
-        readonly category: number;
-        readonly subCategory: number;
-        readonly type: any;
-        _parentDevice: import("../ISYDevice").ISYDevice<any>;
-        readonly children: import("../ISYDevice").ISYDevice<any>[];
-        readonly scenes: import("../../ISYScene").ISYScene[];
-        readonly formatted: any;
-        readonly uom: any;
-        readonly pending: any;
-        hidden: boolean;
-        location: string;
-        convertTo(value: any, uom: number): any;
-        convertFrom(value: any, uom: number): any;
-        addLink(isyScene: import("../../ISYScene").ISYScene): void;
-        addChild(childDevice: import("../ISYDevice").ISYDevice<any>): void;
-        readonly parentDevice: import("../ISYDevice").ISYDevice<any>;
-        refreshProperty(propertyName: string): Promise<any>;
-        refreshNotes(): Promise<void>;
-        getNotes(): Promise<any>;
-        updateProperty(propertyName: string, value: string): Promise<any>;
-        sendCommand(command: any, ...parameters: any[]): Promise<any>;
-        refresh(): Promise<any>;
-        handlePropertyChange(propertyName: string, value: any, formattedValue: string): boolean;
-        readonly isy: ISY;
-        readonly flag: any;
-        readonly nodeDefId: string;
-        readonly address: string;
-        name: string;
-        displayName: string;
-        folder: string;
-        parent: any;
-        parentType: import("../../ISYConstants").NodeType;
-        readonly elkId: string;
-        nodeType: number;
-        propertyChanged: import("events").EventEmitter;
-        propsInitialized: boolean;
-        logger: (msg: any) => void;
-        lastChanged: Date;
-        enabled: boolean;
-        handleEvent(event: any): boolean;
-        onPropertyChanged(propertyName: any, callback: (...args: any[]) => void): void;
-    };
-} & typeof InsteonBaseDevice;
-export declare class InsteonCOSensorDevice extends InsteonCOSensorDevice_base {
-    constructor(isy: ISY, deviceNode: {
-        type: string;
-    });
-    get monoxideDetected(): boolean;
-}
-export {};

package/lib/Devices/Insteon/InsteonCOSensorDevice.js

@@ -1,12 +0,0 @@
-Object.defineProperty(exports, "__esModule", { value: true });
-const ISYDevice_1 = require("../ISYDevice");
-const InsteonBaseDevice_1 = require("./InsteonBaseDevice");
-class InsteonCOSensorDevice extends ISYDevice_1.ISYBinaryStateDevice(InsteonBaseDevice_1.InsteonBaseDevice) {
-    constructor(isy, deviceNode) {
-        super(isy, deviceNode);
-    }
-    get monoxideDetected() {
-        return this.state;
-    }
-}
-exports.InsteonCOSensorDevice = InsteonCOSensorDevice;