zigbee2mqtt/lib/extension/devicePublish.js

const settings = require('../util/settings');
const zigbeeShepherdConverters = require('zigbee-shepherd-converters');
const logger = require('../util/logger');
const utils = require('../util/utils');

const topicRegex = new RegExp(`^${settings.get().mqtt.base_topic}/.+/(set|get)$`);
const postfixes = utils.getPostfixes();

const maxDepth = 20;

const groupConverters = [
    {
        from: (converted) => {
            if (converted.cid === 'genOnOff') {
                return {state: converted.cmd.toUpperCase()};
            } else if (converted.cid === 'genLevelCtrl') {
                return {state: 'ON', brightness: Number(converted.zclData.level)};
            }
        },
        to: zigbeeShepherdConverters.toZigbeeConverters.light_onoff_brightness,
    },
    {
        from: (converted) => {
            return {color_temp: Number(converted.zclData.colortemp)};
        },
        to: zigbeeShepherdConverters.toZigbeeConverters.light_colortemp,
    },
    {
        from: (converted) => {
            if (converted.zclData.hasOwnProperty('colorx') && converted.zclData.hasOwnProperty('colory')) {
                return {
                    color: {
                        x: converted.zclData.colorx / 65535,
                        y: converted.zclData.colory / 65535,
                    },
                };
            }
        },
        to: zigbeeShepherdConverters.toZigbeeConverters.light_color,
    },
    {
        from: () => null,
        to: zigbeeShepherdConverters.toZigbeeConverters.ignore_transition,
    },
];

class DevicePublish {
    constructor(zigbee, mqtt, state, publishEntityState) {
        this.zigbee = zigbee;
        this.mqtt = mqtt;
        this.state = state;
        this.publishEntityState = publishEntityState;
    }

    onMQTTConnected() {
        // Subscribe to topics.
        for (let step = 1; step < maxDepth; step++) {
            const topic = `${settings.get().mqtt.base_topic}/${'+/'.repeat(step)}`;
            this.mqtt.subscribe(`${topic}set`);
            this.mqtt.subscribe(`${topic}get`);
        }
    }

    parseTopic(topic) {
        if (!topic.match(topicRegex)) {
            return null;
        }

        // Remove base from topic
        topic = topic.replace(`${settings.get().mqtt.base_topic}/`, '');
        if (topic.match(/bridge\/config/)) {
            return null;
        }
        // Parse type from topic
        const type = topic.substr(topic.lastIndexOf('/') + 1, topic.length);

        // Remove type from topic
        topic = topic.replace(`/${type}`, '');

        // Check if we have to deal with a postfix.
        let postfix = '';
        if (postfixes.find((p) => topic.endsWith(`/${p}`))) {
            postfix = topic.substr(topic.lastIndexOf('/') + 1, topic.length);

            // Remove postfix from topic
            topic = topic.replace(`/${postfix}`, '');
        }

        const ID = topic;

        return {type, ID, postfix};
    }

    handlePublishError(entity, message, error) {
        const meta = {
            entity,
            message: message.toString(),
        };

        this.mqtt.log('zigbee_publish_error', error.toString(), meta);
    }

    handlePublished(entity, topic, converter, converted, key, value) {
        if (entity.type === 'device' && topic.type === 'set') {
            // Devices do not report when they go off, this ensures state (on/off) is always in sync.
            // Brightness onoff converters also control the state. (do a moveToLevelWithOnOff)
            const msg = {};
            const _key = topic.postfix ? `state_${topic.postfix}` : 'state';

            if (converted.cid === 'genOnOff') {
                const state = converted.cmd.toUpperCase();
                msg[_key] = state;

                // Turn of through brightness.
                if (state === 'OFF' && key.startsWith('brightness') && value === 0) {
                    msg['brightness'] = 0;
                }
            } else if (converted.cid === 'genLevelCtrl' && converted.cmd === 'moveToLevelWithOnOff') {
                const brightness = Number(converted.zclData.level);
                msg[_key] = brightness === 0 ? 'OFF' : 'ON';
                msg['brightness'] = brightness;
            } else if (converted.cid === 'genLevelCtrl' && converted.cmd === 'moveToLevel') {
                msg['brightness'] = Number(converted.zclData.level);
            }

            if (Object.keys(msg).length > 0) {
                this.publishEntityState(entity.ID, msg);
            }
        } else if (entity.type === 'group' && topic.type === 'set') {
            // As a group doesn't confirm it's state, we mock the state here.
            const payload = groupConverters.find((g) => g.to === converter).from(converted);
            if (payload) {
                this.publishEntityState(entity.ID, payload);
            }
        }
    }

    onMQTTMessage(topic, message) {
        topic = this.parseTopic(topic);

        if (!topic) {
            return false;
        }

        // Resolve the entity
        const entity = settings.resolveEntity(topic.ID);

        // Get entity details
        let endpoint = null;
        let converters = null;
        let device = null;

        if (entity.type === 'device') {
            device = this.zigbee.getDevice(entity.ID);
            if (!device) {
                logger.error(`Failed to find device with ieeAddr: '${entity.ID}'`);
                this.mqtt.log('entity_not_found', entity.ID);
                return;
            }

            // Map device to a model
            const model = zigbeeShepherdConverters.findByZigbeeModel(device.modelId);
            if (!model) {
                logger.warn(`Device with modelID '${device.modelId}' is not supported.`);
                logger.warn(`Please see: https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html`);
                return;
            }

            // Determine endpoint to publish to.
            if (model.hasOwnProperty('ep')) {
                const eps = model.ep(device);
                endpoint = eps.hasOwnProperty(topic.postfix) ? eps[topic.postfix] : null;
                if (endpoint === null && eps.hasOwnProperty('default')) {
                    endpoint = eps['default'];
                }
            }

            converters = model.toZigbee;
        } else if (entity.type === 'group') {
            converters = groupConverters.map((g) => g.to);
        }

        // 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()};
        }

        // Ensure that state and brightness are executed before other commands.
        const keys = Object.keys(json);
        keys.sort((a, b) => (['state', 'brightness'].includes(a) ? -1 : 1));

        // For each key in the JSON message find the matching converter.
        const usedConverters = [];
        keys.forEach((key) => {
            const converter = converters.find((c) => c.key.includes(key));

            if (usedConverters.includes(converter)) {
                // Use a converter only once (e.g. light_onoff_brightness converters can convert state and brightness)
                return;
            }

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

            // Converter didn't return a result, skip
            const converted = converter.convert(key, json[key], json, topic.type, topic.postfix);
            if (!converted) {
                return;
            }

            this.zigbee.publish(
                entity.ID,
                entity.type,
                converted.cid,
                converted.cmd,
                converted.cmdType,
                converted.zclData,
                converted.cfg,
                endpoint,
                (error, rsp) => {
                    if (!error) {
                        this.handlePublished(entity, topic, converter, converted, key, json[key]);
                    } else {
                        this.handlePublishError(entity, message, error);
                    }
                }
            );

            // It's possible for devices to get out of sync when writing an attribute that's not reportable.
            // So here we re-read the value after a specified timeout, this timeout could for example be the
            // transition time of a color change or for forcing a state read for devices that don't
            // automatically report a new state when set.
            // When reporting is requested for a device (report: true in device-specific settings) we won't
            // ever issue a read here, as we assume the device will properly report changes.
            const deviceSettings = settings.getDevice(entity.ID);
            if (topic.type === 'set' && entity.type === 'device'
                && converted.hasOwnProperty('readAfterWriteTime')
                && !(deviceSettings && deviceSettings.report)) {
                const getConverted = converter.convert(key, json[key], json, 'get');
                setTimeout(() => {
                    this.zigbee.publish(
                        entity.ID, entity.type, getConverted.cid, getConverted.cmd, getConverted.cmdType,
                        getConverted.zclData, getConverted.cfg, endpoint, () => {}
                    );
                }, converted.readAfterWriteTime);
            }

            usedConverters.push(converter);
        });

        return true;
    }
}

module.exports = DevicePublish;