const ZigbeeHerdsman = require('zigbee-herdsman'); const logger = require('./util/logger'); const settings = require('./util/settings'); const data = require('./util/data'); const assert = require('assert'); const utils = require('./util/utils'); const events = require('events'); const objectAssignDeep = require('object-assign-deep'); const zigbeeHerdsmanConverters = require('zigbee-herdsman-converters'); const stringify = require('json-stable-stringify-without-jsonify'); const endpointNames = utils.getEndpointNames(); const keyEndpointByNumber = new RegExp(`.*/([0-9]*)$`); class Zigbee extends events.EventEmitter { constructor() { super(); this.acceptJoiningDeviceHandler = this.acceptJoiningDeviceHandler.bind(this); } async start() { const infoHerdsman = await utils.getDependencyVersion('zigbee-herdsman'); logger.info(`Starting zigbee-herdsman (${infoHerdsman.version})`); const herdsmanSettings = { network: { panID: settings.get().advanced.pan_id, extendedPanID: settings.get().advanced.ext_pan_id, channelList: [settings.get().advanced.channel], networkKey: settings.get().advanced.network_key, }, databasePath: data.joinPath('database.db'), databaseBackupPath: data.joinPath('database.db.backup'), backupPath: data.joinPath('coordinator_backup.json'), serialPort: { baudRate: settings.get().advanced.baudrate, rtscts: settings.get().advanced.rtscts, path: settings.get().serial.port, adapter: settings.get().serial.adapter, }, adapter: { concurrent: settings.get().advanced.adapter_concurrent, delay: settings.get().advanced.adapter_delay, disableLED: settings.get().serial.disable_led, }, }; const herdsmanSettingsLog = objectAssignDeep.noMutate(herdsmanSettings); herdsmanSettingsLog.network.networkKey = 'HIDDEN'; logger.debug(`Using zigbee-herdsman with settings: '${stringify(herdsmanSettingsLog)}'`); if (herdsmanSettings.network.networkKey === 'GENERATE') { const newKey = Array.from({length: 16}, () => Math.floor(Math.random() * 255)); settings.set(['advanced', 'network_key'], newKey); herdsmanSettings.network.networkKey = newKey; } if (herdsmanSettings.network.panID === 'GENERATE') { const newPanID = Math.floor(Math.random() * (0xFFFF - 2)) + 1; settings.set(['advanced', 'pan_id'], newPanID); herdsmanSettings.network.panID = newPanID; } let startResult; try { herdsmanSettings.acceptJoiningDeviceHandler = this.acceptJoiningDeviceHandler; this.herdsman = new ZigbeeHerdsman.Controller(herdsmanSettings, logger); startResult = await this.herdsman.start(); } catch (error) { logger.error(`Error while starting zigbee-herdsman`); throw error; } this.herdsman.on('adapterDisconnected', () => this.emit('adapterDisconnected')); this.herdsman.on('deviceNetworkAddressChanged', (data) => this.emit('event', 'deviceNetworkAddressChanged', data)); this.herdsman.on('deviceAnnounce', (data) => this.emit('event', 'deviceAnnounce', data)); this.herdsman.on('deviceInterview', (data) => this.emit('event', 'deviceInterview', data)); this.herdsman.on('deviceJoined', (data) => this.emit('event', 'deviceJoined', data)); this.herdsman.on('deviceLeave', (data) => this.emit('event', 'deviceLeave', data)); this.herdsman.on('message', (data) => this.emit('event', 'message', data)); this.herdsman.on('permitJoinChanged', (data) => this.emit('permitJoinChanged', data)); logger.info(`zigbee-herdsman started (${startResult})`); logger.info(`Coordinator firmware version: '${stringify(await this.getCoordinatorVersion())}'`); logger.debug(`Zigbee network parameters: ${stringify(await this.herdsman.getNetworkParameters())}`); for (const device of this.getClients()) { // If a passlist is used, all other device will be removed from the network. const passlist = settings.get().passlist.concat(settings.get().whitelist); const blocklist = settings.get().blocklist.concat(settings.get().ban); if (passlist.length > 0) { if (!passlist.includes(device.ieeeAddr)) { logger.warn(`Device which is not on passlist connected (${device.ieeeAddr}), removing...`); device.removeFromNetwork(); } } else if (blocklist.includes(device.ieeeAddr)) { logger.warn(`Device on blocklist is connected (${device.ieeeAddr}), removing...`); device.removeFromNetwork(); } } // Check if we have to turn off the led if (settings.get().serial.disable_led) { await this.herdsman.setLED(false); } // Check if we have to set a transmit power if (settings.get().experimental.hasOwnProperty('transmit_power')) { const transmitPower = settings.get().experimental.transmit_power; await this.herdsman.setTransmitPower(transmitPower); logger.info(`Set transmit power to '${transmitPower}'`); } return startResult; } async getCoordinatorVersion() { return this.herdsman.getCoordinatorVersion(); } isStopping() { return this.herdsman.isStopping(); } async getNetworkParameters() { return this.herdsman.getNetworkParameters(); } async reset(type) { await this.herdsman.reset(type); } async stop() { logger.info('Stopping zigbee-herdsman...'); await this.herdsman.stop(); logger.info('Stopped zigbee-herdsman'); } async permitJoin(permit, resolvedEntity, time=undefined) { permit ? logger.info(`Zigbee: allowing new devices to join${resolvedEntity ? ` via ${resolvedEntity.name}` : ''}.`) : logger.info('Zigbee: disabling joining new devices.'); if (resolvedEntity && permit) { await this.herdsman.permitJoin(permit, resolvedEntity.device, time); } else { await this.herdsman.permitJoin(permit, undefined, time); } } getPermitJoin() { return this.herdsman.getPermitJoin(); } getPermitJoinTimeout() { return this.herdsman.getPermitJoinTimeout(); } getClients() { return this.herdsman.getDevices().filter((device) => device.type !== 'Coordinator'); } getDevices() { return this.herdsman.getDevices(); } getDeviceByIeeeAddr(ieeeAddr) { return this.herdsman.getDeviceByIeeeAddr(ieeeAddr); } getDeviceByNetworkAddress(networkAddress) { return this.herdsman.getDeviceByNetworkAddress(networkAddress); } getDevicesByType(type) { return this.herdsman.getDevicesByType(type); } /** * @param {string} key * @return {object} { * type: device | coordinator * device|group: zigbee-herdsman entity * endpoint: selected endpoint (only if type === device) * settings: from configuration.yaml * name: name of the entity * definition: zigbee-herdsman-converters definition (only if type === device) * } */ resolveEntity(key) { assert( typeof key === 'string' || typeof key === 'number' || key.constructor.name === 'Device' || key.constructor.name === 'Group' || key.constructor.name === 'Endpoint', `Wrong type '${typeof key}'`, ); const getEndpointName = (endpointNames, endpoint) => { return endpoint ? utils.getKey(endpointNames, endpoint.ID, null, ((v) => v === 'default' ? null : v)) : null; }; const deviceOptions = settings.get().device_options; if (typeof key === 'string' || typeof key === 'number') { if (typeof key === 'number') { key = key.toString(); } if (typeof key === 'string' && key.toLowerCase() === 'coordinator') { const coordinator = this.getDevicesByType('Coordinator')[0]; return { type: 'device', device: coordinator, endpoint: coordinator.getEndpoint(1), settings: {friendlyName: 'Coordinator'}, name: 'Coordinator', endpointName: null, }; } let endpointKey = endpointNames.find((p) => key.endsWith(`/${p}`)); const endpointByNumber = key.match(keyEndpointByNumber); if (!endpointKey && endpointByNumber) { endpointKey = Number(endpointByNumber[1]); } if (endpointKey) { key = key.replace(`/${endpointKey}`, ''); } const entity = settings.getEntity(key); if (!entity) { return null; } else if (entity.type === 'device') { const device = this.getDeviceByIeeeAddr(entity.ID); if (!device) { return null; } const definition = zigbeeHerdsmanConverters.findByDevice(device); const endpointNames = definition && definition.endpoint ? definition.endpoint(device) : null; let endpoint; if (endpointKey) { if (endpointByNumber) { endpoint = device.getEndpoint(endpointKey); } else { assert(definition != null, `Endpoint name '${endpointKey}' is given but device is unsupported`); assert(endpointNames != null, `Endpoint name '${endpointKey}' is given but no endpoints defined`); const endpointID = endpointNames[endpointKey]; assert(endpointID, `Endpoint name '${endpointKey}' is given but device has no such endpoint`); endpoint = device.getEndpoint(endpointID); } } else if (endpointNames && endpointNames['default']) { endpoint = device.getEndpoint(endpointNames['default']); } else { endpoint = device.endpoints[0]; } return { type: 'device', device, endpoint, settings: {...deviceOptions, ...entity}, name: entity.friendlyName, definition, endpointName: getEndpointName(endpointNames, endpoint), }; } else { let group = this.getGroupByID(entity.ID); if (!group) group = this.createGroup(entity.ID); return {type: 'group', group, settings: {...deviceOptions, ...entity}, name: entity.friendlyName}; } } else if (key.constructor.name === 'Device' || key.constructor.name === 'Endpoint') { const device = key.constructor.name === 'Endpoint' ? key.getDevice() : key; const setting = settings.getEntity(device.ieeeAddr); const definition = zigbeeHerdsmanConverters.findByDevice(device); const name = setting ? setting.friendlyName : (device.type === 'Coordinator' ? 'Coordinator' : device.ieeeAddr); const endpointNames = definition && definition.endpoint ? definition.endpoint(device) : null; let endpoint; if (key.constructor.name === 'Endpoint') endpoint = key; else if (endpointNames && endpointNames['default']) endpoint = device.getEndpoint(endpointNames['default']); else endpoint = device.endpoints[0]; return { type: 'device', definition, name, device, endpoint, settings: {...deviceOptions, ...(setting || {})}, endpointName: getEndpointName(endpointNames, endpoint), }; } else { // Group const setting = settings.getEntity(key.groupID); return { type: 'group', group: key, settings: {...deviceOptions, ...(setting || {})}, name: setting ? setting.friendlyName : key.groupID, }; } } getGroupByID(ID) { return this.herdsman.getGroupByID(ID); } getGroups() { return this.herdsman.getGroups(); } createGroup(groupID) { return this.herdsman.createGroup(groupID); } acceptJoiningDeviceHandler(ieeeAddr) { // If passlist is set, all devices not on passlist will be rejected to join the network const passlist = settings.get().passlist.concat(settings.get().whitelist); const blocklist = settings.get().blocklist.concat(settings.get().ban); if (passlist.length > 0) { if (passlist.includes(ieeeAddr)) { logger.info(`Accepting joining device which is on passlist '${ieeeAddr}'`); return true; } else { logger.info(`Rejecting joining not in passlist device '${ieeeAddr}'`); return false; } } else if (blocklist.length > 0) { if (blocklist.includes(ieeeAddr)) { logger.info(`Rejecting joining device which is on blocklist '${ieeeAddr}'`); return false; } else { logger.info(`Accepting joining not in blocklist device '${ieeeAddr}'`); return true; } } else { return true; } } async touchlinkFactoryResetFirst() { return this.herdsman.touchlinkFactoryResetFirst(); } async touchlinkFactoryReset(ieeeAddr, channel) { return this.herdsman.touchlinkFactoryReset(ieeeAddr, channel); } async touchlinkIdentify(ieeeAddr, channel) { await this.herdsman.touchlinkIdentify(ieeeAddr, channel); } async touchlinkScan() { return this.herdsman.touchlinkScan(); } } module.exports = Zigbee;