zigbee2mqtt/lib/model/device.ts

/* eslint-disable brace-style */
import * as settings from '../util/settings';
// @ts-ignore
import zhc from 'zigbee-herdsman-converters';

// TODO: check all
export default class Device {
    private device: ZHDevice;
    private _definition: Definition;

    get ieeeAddr(): string {return this.device.ieeeAddr;}
    get settings(): DeviceSettings {return settings.getDevice(this.ieeeAddr);}
    get name(): string {return this.settings.friendlyName;}
    get lastSeen(): number {return this.device.lastSeen;}
    get interviewing(): boolean {return this.device.interviewing;}
    get type(): 'Coordinator' | 'Router' | 'EndDevice' | 'Unknown' | 'GreenPower' {return this.device.type;}
    get powerSource(): string {return this.device.powerSource;}
    get definition(): Definition | undefined {
        if (!this._definition && !this.device.interviewing) {
            this._definition = zhc.findByDevice(this.device);
        }
        return this._definition;
    }

    constructor(zhDevice: ZHDevice) {
        this.device = zhDevice;
    }

    async ping(disableRecovery: boolean): Promise<void> {await this.device.ping(disableRecovery);}
    async removeFromNetwork(): Promise<void> {await this.device.removeFromNetwork();}

    endpoint(key: 'default' = 'default'): Endpoint {
        let endpoint: Endpoint;

        /* istanbul ignore next */
        if (this.definition?.endpoint) {
            const ID = this.definition?.endpoint?.(this.device)[key];
            if (ID) endpoint = this.device.getEndpoint(ID);
            else if (key === 'default') endpoint = this.device.endpoints[0];
            else throw new Error(`Device '${this.name}' has no endpoint '${key}'`);
        } else {
            endpoint = this.device.endpoints[0];
        }

        return endpoint;
    }
}