zigbee2mqtt/lib/controller.js

const MQTT = require('./mqtt');
const Zigbee = require('./zigbee');
const State = require('./state');
const logger = require('./util/logger');
const settings = require('./util/settings');
const ExtensionNetworkMap = require('./extension/networkMap');
const zigbeeShepherdConverters = require('zigbee-shepherd-converters');
const homeassistant = require('./homeassistant');
const objectAssignDeep = require('object-assign-deep');

const mqttConfigRegex = new RegExp(`${settings.get().mqtt.base_topic}/bridge/config/\\w+`, 'g');
const mqttDeviceRegex = new RegExp(`${settings.get().mqtt.base_topic}/[\\w\\s\\d.-]+/set`, 'g');
const mqttDevicePrefixRegex = new RegExp(`${settings.get().mqtt.base_topic}/[\\w\\s\\d.-]+/[\\w\\s\\d.-]+/set`, 'g');

const pollInterval = 60 * 1000; // seconds * 1000.
const softResetTimeout = 3600 * 1000; // seconds * 1000.

const allowedLogLevels = ['error', 'warn', 'info', 'debug'];

/**
 * Home Assistant requires ALL attributes to be present in ALL MQTT messages send by the device.
 * https://community.home-assistant.io/t/missing-value-with-mqtt-only-last-data-set-is-shown/47070/9
 *
 * Therefore zigbee2mqtt BY DEFAULT caches all values and resend it with every message.
 * advanced.cache_state in configuration.yaml allows to configure this.
 * https://github.com/Koenkk/zigbee2mqtt/wiki/Configuration
 */
const cacheState = settings.get().advanced && settings.get().advanced.cache_state === false ? false : true;
if (settings.get().homeassistant && !cacheState) {
    logger.warn('In order for Home Assistant integration to work properly set `cache_state: true');
}

class Controller {
    constructor() {
        this.zigbee = new Zigbee();
        this.mqtt = new MQTT();
        this.state = new State();
        this.configured = [];
        this.handleZigbeeMessage = this.handleZigbeeMessage.bind(this);
        this.handleMQTTMessage = this.handleMQTTMessage.bind(this);
    }

    start() {
        this.startupLogVersion(() => {
            this.zigbee.start(this.handleZigbeeMessage, (error) => {
                if (error) {
                    logger.error('Failed to start', error);
                } else {
                    // Log zigbee clients on startup and configure.
                    const devices = this.zigbee.getAllClients();
                    logger.info(`Currently ${devices.length} devices are joined:`);
                    devices.forEach((device) => {
                        logger.info(this.getDeviceStartupLogMessage(device));
                        this.configureDevice(device);
                    });

                    // Enable zigbee join.
                    if (settings.get().permit_join) {
                        logger.warn('`permit_join` set to  `true` in configuration.yaml.');
                        logger.warn('Allowing new devices to join.');
                        logger.warn('Set `permit_join` to `false` once you joined all devices.');
                    }

                    this.zigbee.permitJoin(settings.get().permit_join);

                    // Start timers.
                    this.pollTimer(true);
                    this.softResetTimeout(true);

                    // Connect to MQTT broker
                    const subscriptions = [
                        `${settings.get().mqtt.base_topic}/+/set`,
                        `${settings.get().mqtt.base_topic}/+/+/set`,
                        `${settings.get().mqtt.base_topic}/bridge/config/+`,
                    ];

                    if (settings.get().homeassistant) {
                        subscriptions.push('hass/status');
                    }

                    this.mqtt.connect(this.handleMQTTMessage, subscriptions, () => this.handleMQTTConnected());
                }
            });
        });
    }

    handleMQTTConnected() {
        // Home Assistant MQTT discovery on MQTT connected.
        if (settings.get().homeassistant) {
            // MQTT discovery of all paired devices on startup.
            this.zigbee.getAllClients().forEach((device) => {
                const mappedModel = zigbeeShepherdConverters.findByZigbeeModel(device.modelId);
                if (mappedModel) {
                    homeassistant.discover(device.ieeeAddr, mappedModel.model, this.mqtt, true);
                }
            });
        }

        // Initialize extensions.
        this.extensions = [
            new ExtensionNetworkMap(this.zigbee, this.mqtt, this.state),
        ];

        // Resend all cached states.
        this.sendAllCachedStates();
    }

    sendAllCachedStates() {
        this.zigbee.getAllClients().forEach((device) => {
            if (this.state.exists(device.ieeeAddr)) {
                this.mqttPublishDeviceState(device, this.state.get(device.ieeeAddr), false);
            }
        });
    }

    softResetTimeout(start) {
        if (this._softResetTimer) {
            clearTimeout(this._softResetTimer);
            this._softResetTimer = null;
        }

        if (start) {
            this._softResetTimer = setTimeout(() => {
                this.zigbee.softReset((error) => {
                    if (error) {
                        logger.warn('Soft reset error', error);
                        this.zigbee.stop((error) => {
                            logger.warn('Zigbee stopped');
                            this.zigbee.start(this.handleZigbeeMessage, (error) => {
                                if (error) {
                                    logger.error('Failed to restart!');
                                }
                            });
                        });
                    } else {
                        logger.warn('Soft resetted zigbee');
                    }

                    this.softResetTimeout(true);
                });
            }, softResetTimeout);
        }
    }

    pollTimer(start) {
        // Some routers need polling to prevent them from sleeping.
        if (start && !this._pollTimer) {
            this._pollTimer = setInterval(() => {
                const devices = this.zigbee.getAllClients().filter((d) => {
                    const power = d.powerSource ? d.powerSource.toLowerCase().split(' ')[0] : 'unknown';
                    return power !== 'battery' && power !== 'unknown' && d.type === 'Router';
                });

                devices.forEach((d) => this.zigbee.ping(d.ieeeAddr));
            }, pollInterval);
        } else if (!start && this._pollTimer) {
            clearTimeout(this._pollTimer);
            this._pollTimer = null;
        }
    }

    stop(callback) {
        this.state.save();
        this.mqtt.disconnect();
        this.pollTimer(false);
        this.softResetTimeout(false);
        this.zigbee.stop(callback);
    }

    configureDevice(device) {
        let friendlyName = 'unknown';
        const ieeeAddr = device.ieeeAddr;
        if (settings.getDevice(ieeeAddr)) {
            friendlyName = settings.getDevice(ieeeAddr).friendly_name;
        }
        if (ieeeAddr && device.modelId && !this.configured.includes(ieeeAddr)) {
            const mappedModel = zigbeeShepherdConverters.findByZigbeeModel(device.modelId);

            // Call configure function of device.
            if (mappedModel && mappedModel.configure) {
                mappedModel.configure(ieeeAddr, this.zigbee.shepherd, this.zigbee.getCoordinator(), (ok, msg) => {
                    if (ok) {
                        logger.info(`Succesfully configured ${friendlyName} ${ieeeAddr}`);
                    } else {
                        logger.error(`Failed to configure ${friendlyName} ${ieeeAddr}`);
                    }
                });
            }

            // Setup an OnAfIncomingMsg handler if needed.
            if (mappedModel && mappedModel.onAfIncomingMsg) {
                mappedModel.onAfIncomingMsg.forEach((ep) => this.zigbee.registerOnAfIncomingMsg(ieeeAddr, ep));
            }

            this.configured.push(ieeeAddr);
        }
    }

    getDeviceStartupLogMessage(device) {
        let friendlyName = 'unknown';
        let type = 'unknown';
        let friendlyDevice = {model: 'unkown', description: 'unknown'};
        const mappedModel = zigbeeShepherdConverters.findByZigbeeModel(device.modelId);
        if (mappedModel) {
            friendlyDevice = mappedModel;
        }

        if (settings.getDevice(device.ieeeAddr)) {
            friendlyName = settings.getDevice(device.ieeeAddr).friendly_name;
        }

        if (device.type) {
            type = device.type;
        }

        return `${friendlyName} (${device.ieeeAddr}): ${friendlyDevice.model} - ` +
            `${friendlyDevice.vendor} ${friendlyDevice.description} (${type})`;
    }

    getDeviceInfoForMqtt(device) {
        const {type, ieeeAddr, nwkAddr, manufId, manufName, powerSource, modelId, status} = device;
        const deviceSettings = settings.getDevice(device.ieeeAddr);

        return {
            ieeeAddr,
            friendlyName: deviceSettings.friendly_name || '',
            type,
            nwkAddr,
            manufId,
            manufName,
            powerSource,
            modelId,
            status,
        };
    }

    handleZigbeeMessage(message) {
        // Zigbee message receieved, reset soft reset timeout.
        this.softResetTimeout(true);

        // Log the message.
        let logMessage = `Recieved zigbee message of type '${message.type}' ` +
                         `with data '${JSON.stringify(message.data)}'`;
        if (message.endpoints && message.endpoints[0].device) {
            const device = message.endpoints[0].device;
            logMessage += ` of device '${device.modelId}' (${device.ieeeAddr})`;
        }
        logger.debug(logMessage);

        if (message.type == 'devInterview' && !settings.getDevice(message.data)) {
            logger.info('Connecting with device...');
            this.mqtt.log('pairing', 'connecting with device');
        }

        if (message.type == 'devIncoming') {
            logger.info('Device incoming...');
            this.mqtt.log('pairing', 'device incoming');
        }

        // We dont handle messages without endpoints.
        if (!message.endpoints) {
            return;
        }

        const device = message.endpoints[0].device;

        if (!device) {
            logger.warn('Message without device!');
            return;
        }

        // Check if this is a new device.
        if (!settings.getDevice(device.ieeeAddr)) {
            logger.info(`New device with address ${device.ieeeAddr} connected!`);
            settings.addDevice(device.ieeeAddr);
            this.mqtt.log('device_connected', device.ieeeAddr);
        }

        // We can't handle devices without modelId.
        if (!device.modelId) {
            return;
        }

        // Map Zigbee modelID to vendor modelID.
        const modelID = message.endpoints[0].device.modelId;
        const mappedModel = zigbeeShepherdConverters.findByZigbeeModel(modelID);

        if (!mappedModel) {
            logger.warn(`Device with modelID '${modelID}' is not supported.`);
            logger.warn(`Please see: https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices`);
            return;
        }

        // Configure device.
        this.configureDevice(device);

        // Home Assistant MQTT discovery
        if (settings.get().homeassistant) {
            homeassistant.discover(device.ieeeAddr, mappedModel.model, this.mqtt, false);
        }

        // After this point we cant handle message withoud cid anymore.
        if (!message.data || (!message.data.cid && !message.data.cmdId)) {
            return;
        }

        // Find a conveter for this message.
        const cid = message.data.cid;
        const cmdId = message.data.cmdId;
        const converters = mappedModel.fromZigbee.filter((c) => {
            if (cid) {
                return c.cid === cid && c.type === message.type;
            } else if (cmdId) {
                return c.cmd === cmdId;
            }

            return false;
        });

        if (!converters.length) {
            if (cid) {
                logger.warn(
                    `No converter available for '${mappedModel.model}' with cid '${cid}', ` +
                    `type '${message.type}' and data '${JSON.stringify(message.data)}'`
                );
            } else if (cmdId) {
                logger.warn(
                    `No converter available for '${mappedModel.model}' with cmd '${cmdId}' ` +
                    `and data '${JSON.stringify(message.data)}'`
                );
            }

            logger.warn(`Please see: https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices.`);
            return;
        }

        // Convert this Zigbee message to a MQTT message.
        // Get payload for the message.
        // - If a payload is returned publish it to the MQTT broker
        // - If NO payload is returned do nothing. This is for non-standard behaviour
        //   for e.g. click switches where we need to count number of clicks and detect long presses.
        converters.forEach((converter) => {
            const publish = (payload) => {
                // Don't cache messages with following properties:
                const dontCacheProperties = ['click', 'action', 'button', 'button_left', 'button_right'];
                let cache = true;
                dontCacheProperties.forEach((property) => {
                    if (payload.hasOwnProperty(property)) {
                        cache = false;
                    }
                });

                // Add device linkquality.
                if (message.hasOwnProperty('linkquality')) {
                    payload.linkquality = message.linkquality;
                }

                this.mqttPublishDeviceState(device, payload, cache);
            };

            const payload = converter.convert(mappedModel, message, publish, settings.getDevice(device.ieeeAddr));

            if (payload) {
                publish(payload);
            }
        });
    }

    handleMQTTMessage(topic, message) {
        logger.debug(`Recieved mqtt message on topic '${topic}' with data '${message}'`);

        // Find extensions that could handle this.
        const extensions = this.extensions.filter((e) => e.handleMQTTMessage);

        // Call extensions.
        const extensionResults = extensions.map((e) => e.handleMQTTMessage(topic, message));

        if (topic.match(mqttConfigRegex)) {
            this.handleMQTTMessageConfig(topic, message);
        } else if (topic.match(mqttDeviceRegex) || topic.match(mqttDevicePrefixRegex)) {
            this.handleMQTTMessageDevice(topic, message, topic.match(mqttDevicePrefixRegex));
        } else if (topic === 'hass/status') {
            if (message.toString().toLowerCase() === 'online') {
                const timer = setTimeout(() => {
                    this.sendAllCachedStates();
                    clearTimeout(timer);
                }, 20000);
            }
        } else if (!extensionResults.includes(true)) {
            logger.warn(`Cannot handle MQTT message with topic '${topic}' and message '${message}'`);
        }
    }

    handleMQTTMessageConfig(topic, message) {
        const option = topic.split('/').slice(-1)[0];

        if (option === 'permit_join') {
            const msg = message.toString().toLowerCase();
            let type = 'all';
            let join = msg === 'true';

            if (!['true', 'false'].includes(msg)) {
                join = true;
                type = parseInt(msg);
            }

            this.zigbee.permitJoin(join, type);
        } else if (option === 'log_level') {
            const level = message.toString().toLowerCase();
            if (allowedLogLevels.includes(level)) {
                logger.info(`Switching log level to '${level}'`);
                logger.transports.console.level = level;
                logger.transports.file.level = level;
            } else {
                logger.error(`Could not set log level to '${level}'. Allowed level: '${allowedLogLevels.join(',')}'`);
            }
        } else if (option === 'devices') {
            const devices = this.zigbee.getAllClients().map((device) => {
                const mappedModel = zigbeeShepherdConverters.findByZigbeeModel(device.modelId);
                const friendlyDevice = settings.getDevice(device.ieeeAddr);

                return {
                    ieeeAddr: device.ieeeAddr,
                    type: device.type,
                    model: mappedModel ? mappedModel.model : device.modelId,
                    friendly_name: friendlyDevice ? friendlyDevice.friendly_name : device.ieeeAddr,
                };
            });

            this.mqtt.log('devices', devices);
        } else if (option === 'remove') {
            message = message.toString();
            const IDByFriendlyName = settings.getIDByFriendlyName(message);
            const deviceID = IDByFriendlyName ? IDByFriendlyName : message;
            const device = this.zigbee.getDevice(deviceID);

            const cleanup = () => {
                // Clear Home Assistant MQTT discovery message
                if (settings.get().homeassistant && device) {
                    const mappedModel = zigbeeShepherdConverters.findByZigbeeModel(device.modelId);
                    if (mappedModel) {
                        homeassistant.clear(deviceID, mappedModel.model, this.mqtt);
                    }
                }

                // Remove from configuration.yaml
                settings.removeDevice(deviceID);

                // Remove from state
                this.state.remove(deviceID);

                logger.info(`Successfully removed ${deviceID}`);
                this.mqtt.log('device_removed', message);
            };

            // Remove from zigbee network.
            if (device) {
                this.zigbee.removeDevice(deviceID, (error) => {
                    if (!error) {
                        cleanup();
                    } else {
                        logger.error(`Failed to remove ${deviceID}`);
                    }
                });
            } else {
                cleanup();
            }
        } else if (option === 'rename') {
            const invalid = `Invalid rename message format expected {old: 'friendly_name', new: 'new_name} ` +
                            `got ${message.toString()}`;

            let json = null;
            try {
                json = JSON.parse(message.toString());
            } catch (e) {
                logger.error(invalid);
                return;
            }

            // Validate message
            if (!json.new || !json.old) {
                logger.error(invalid);
                return;
            }

            if (settings.changeFriendlyName(json.old, json.new)) {
                logger.info(`Successfully renamed - ${json.old} to ${json.new} `);
            } else {
                logger.error(`Failed to renamed - ${json.old} to ${json.new}`);
                return;
            }

            // Homeassistant rediscover
            if (settings.get().homeassistant) {
                const ID = settings.getIDByFriendlyName(json.new);
                const device = this.zigbee.getDevice(ID);
                const mappedModel = zigbeeShepherdConverters.findByZigbeeModel(device.modelId);
                if (mappedModel) {
                    homeassistant.discover(device.ieeeAddr, mappedModel.model, this.mqtt, true);
                }
            }
        } else {
            logger.warn(`Cannot handle MQTT config option '${option}' with message '${message}'`);
        }
    }

    handleMQTTMessageDevice(topic, message, withPrefix) {
        const friendlyName = topic.split('/').slice(withPrefix ? -3 : -2)[0];
        const topicPrefix = withPrefix ? topic.split('/').slice(-2)[0] : '';

        // Map friendlyName to deviceID.
        const deviceID = settings.getIDByFriendlyName(friendlyName);

        if (!deviceID) {
            logger.error(`Cannot handle '${topic}' because deviceID of '${friendlyName}' cannot be found`);
            return;
        }

        // Convert the MQTT message to a Zigbee message.
        let json = null;
        try {
            json = JSON.parse(message);
        } catch (e) {
            // Cannot be parsed to JSON, assume state message.
            json = {state: message.toString()};
        }

        // Find ep for this device
        const device = this.zigbee.getDevice(deviceID);
        if (!device) {
            logger.error(`Failed to find device with deviceID ${deviceID}`);
            return;
        }

        const mappedModel = zigbeeShepherdConverters.findByZigbeeModel(device.modelId);
        if (!mappedModel) {
            logger.warn(`Device with modelID '${device.modelId}' is not supported.`);
            logger.warn(`Please see: https://github.com/Koenkk/zigbee2mqtt/wiki/How-to-support-new-devices`);
            return;
        }

        const ep = mappedModel.ep && mappedModel.ep[topicPrefix] ? mappedModel.ep[topicPrefix] : null;
        const published = [];

        Object.keys(json).forEach((key) => {
            // Find converter for this key.
            const converter = mappedModel.toZigbee.find((c) => c.key === key);

            if (!converter) {
                logger.error(`No converter available for '${key}' (${json[key]})`);
                return;
            }

            const message = converter.convert(json[key], json);

            if (!message) {
                return;
            }

            const callback = (error) => {
                // Devices do not report when they go off, this ensures state (on/off) is always in sync.
                if (!error && key.startsWith('state')) {
                    const msg = {};
                    const _key = topicPrefix ? `${key}_${topicPrefix}` : key;
                    msg[_key] = json[key];
                    this.mqttPublishDeviceState(device, msg, true);
                }
            };

            this.zigbee.publish(deviceID, message.cid, message.cmd, message.zclData,
                message.cfg, ep, message.type, callback);

            published.push({message: message, converter: converter});
        });

        /**
         * After publishing a command to a zigbee device we want to monitor the changed attribute(s) so that
         * everything stays in sync.
         */
        published.forEach((p) => {
            let counter = 0;
            let secondsToMonitor = 1;

            // In case of a transition we need to monitor for the whole transition time.
            if (p.message.zclData.hasOwnProperty('transtime')) {
                // Note that: transtime 10 = 0.1 seconds, 100 = 1 seconds, etc.
                secondsToMonitor = (p.message.zclData.transtime / 10) + 1;
            }

            const timer = setInterval(() => {
                counter++;

                // Doing a 'read' will result in the device sending a zigbee message with the current attribute value.
                // which will be handled by this.handleZigbeeMessage.
                p.converter.attr.forEach((attribute) => {
                    this.zigbee.read(deviceID, p.message.cid, attribute, ep, () => null);
                });

                if (counter >= secondsToMonitor) {
                    clearTimeout(timer);
                }
            }, 1000);
        });
    }

    mqttPublishDeviceState(device, payload, cache) {
        const deviceID = device.ieeeAddr;
        const appSettings = settings.get();
        let messagePayload = {...payload};

        if (cacheState) {
            // Add cached state to payload
            if (this.state.exists(deviceID)) {
                messagePayload = objectAssignDeep.noMutate(this.state.get(deviceID), payload);
            }

            // Update state cache with new state.
            if (cache) {
                this.state.set(deviceID, payload);
            }
        }

        const deviceSettings = settings.getDevice(deviceID);
        const options = {
            retain: deviceSettings.retain,
            qos: deviceSettings.qos ? deviceSettings.qos : 0,
        };

        if (appSettings.mqtt.include_device_information) {
            messagePayload.device = this.getDeviceInfoForMqtt(device);
        }

        this.mqtt.publish(deviceSettings.friendly_name, JSON.stringify(messagePayload), options);
    }

    startupLogVersion(callback) {
        const git = require('git-last-commit');
        const packageJSON = require('../package.json');
        const version = packageJSON.version;

        git.getLastCommit((err, commit) => {
            let commitHash = null;

            if (err) {
                try {
                    commitHash = require('../.hash.json').hash;
                } catch (error) {
                    commitHash = 'unknown';
                }
            } else {
                commitHash = commit.shortHash;
            }

            logger.info(`Starting zigbee2mqtt version ${version} (commit #${commitHash})`);

            callback();
        });
    }
}

module.exports = Controller;