zigbee2mqtt/lib/converters/zigbee2mqtt.js

const clickLookup = {
    1: 'single',
    2: 'double',
    3: 'triple',
    4: 'quadruple',
}

const battery = {
    min: 2500,
    max: 3000,
}

const WXKG02LM = {
    1: 'left',
    2: 'right',
    3: 'both',
};

const toPercentage = (value, min, max) => {
    if (value > max) {
        value = max;
    } else if (value < min) {
        value = min;
    }

    const normalised = (value - min) / (max - min);
    return (normalised * 100).toFixed(2);
}

// Global variable store that can be used by devices.
const store = {}

const parsers = [
    {
        devices: ['WXKG01LM', 'RTCGQ01LM', 'WSDCGQ01LM', 'MCCGQ01LM', 'WXKG11LM', 'MCCGQ11LM', 'RTCGQ11LM', 'WSDCGQ11LM'],
        cid: 'genBasic',
        type: 'attReport',
        disablePublish: true,
        convert: (msg) => {
            let voltage = null;

            if (msg.data.data['65281']) {
                voltage = msg.data.data['65281']['1'];
            } else if (msg.data.data['65282']) {
                voltage = msg.data.data['65282']['1'].elmVal;
            }

            if (voltage) {
                return {battery: toPercentage(voltage, battery.min, battery.max)}
            }
        }
    },
    {
        devices: ['WXKG01LM'],
        cid: 'genOnOff',
        type: 'attReport',
        convert: (msg, publish) => {
            const deviceID = msg.endpoints[0].device.ieeeAddr;
            const state = msg.data.data['onOff'];

             // 0 = click down, 1 = click up, else = multiple clicks
            if (state === 0) {
                store[deviceID] = setTimeout(() => {
                    publish({click: 'long'});
                    store[deviceID] = null;
                }, 300); // After 300 milliseconds of not releasing we assume long click.
            } else if (state === 1) {
                if (store[deviceID]) {
                    clearTimeout(store[deviceID]);
                    store[deviceID] = null;
                    publish({click: 'single'});
                }
            } else {
                const clicks = msg.data.data['32768'];
                const payload = clickLookup[clicks] ? clickLookup[clicks] : 'many';
                publish({click: payload});
            }
        }
    },
    {
        devices: ['WSDCGQ01LM', 'WSDCGQ11LM'],
        cid: 'msTemperatureMeasurement',
        type: 'attReport',
        convert: (msg) => {return {temperature: parseFloat(msg.data.data['measuredValue']) / 100.0}}
    },
    {
        devices: ['WSDCGQ01LM', 'WSDCGQ11LM'],
        cid: 'msRelativeHumidity',
        type: 'attReport',
        convert: (msg) => {return {humidity: parseFloat(msg.data.data['measuredValue']) / 100.0}}
    },
    {
        devices: ['RTCGQ01LM', 'RTCGQ11LM'],
        cid: 'msOccupancySensing',
        type: 'attReport',
        convert: (msg, publish) => {
            // The occupancy sensor only sends a message when motion detected.
            // Therefore we need to publish the no_motion detected by ourselves.
            // no_motion is triggered after 3 minutes of no motion.
            const noMotionTimeout = 3; // in minutes
            const deviceID = msg.endpoints[0].device.ieeeAddr;

            // Stop existing timer because motion is detected and set a new one.
            if (store[deviceID]) {
                clearTimeout(store[deviceID]);
                store[deviceID] = null;
            }

            store[deviceID] = setTimeout(() => {
                publish({occupancy: 'no_motion'})
                store[deviceID] = null;
            }, noMotionTimeout * 60 * 1000);
            return {occupancy: 'motion'};
        }
    },
    {
        devices: ['MCCGQ01LM', 'MCCGQ11LM'],
        cid: 'genOnOff',
        type: 'attReport',
        convert: (msg) => {return {state: msg.data.data['onOff'] ? 'open' : 'closed'}}
    },
    {
        devices: ['LED1545G12', '7146060PH', 'LED1537R6'],
        cid: 'genLevelCtrl',
        type: 'devChange',
        convert: (msg) => {return {brightness: msg.data.data['currentLevel']}},
    },
    {
        devices: ['LED1545G12', '7146060PH', 'LED1537R6'],
        cid: 'lightingColorCtrl',
        type: 'devChange',
        convert: (msg) => {return {color_temp: msg.data.data['colorTemperature']}},
    },
    {
        devices: ['WXKG11LM'],
        cid: 'genOnOff',
        type: 'attReport',
        convert: (msg, publish) => {
            const data = msg.data.data;
            let clicks;

            if (data.onOff) {
                clicks = 1;
            } else if (data['32768']) {
                clicks = data['32768'];
            }

            if (clickLookup[clicks]) {
                return {click: clickLookup[clicks]};
            }
        }
    },
    {
        devices: ['RTCGQ11LM'],
        cid: 'msIlluminanceMeasurement',
        type: 'attReport',
        convert: (msg) => {return {illuminance: msg.data.data['measuredValue']}}
    },
    {
        devices: ['WSDCGQ11LM'],
        cid: 'msPressureMeasurement',
        type: 'attReport',
        convert: (msg) => {return {pressure: msg.data.data['measuredValue']}}
    },
    {
        devices: ['WXKG02LM'],
        cid: 'genOnOff',
        type: 'attReport',
        convert: (msg) => {return {click: WXKG02LM[msg.endpoints[0].epId]}}
    },
    {
        devices: ['WXKG03LM'],
        cid: 'genOnOff',
        type: 'attReport',
        convert: (msg) => {return {click: 'single'}}
    },
    {
        devices: ['SJCGQ11LM'],
        cid: 'genBasic',
        type: 'attReport',
        convert: (msg) => {
            return {
                battery: toPercentage(msg.data.data['65281']['1'], battery.min, battery.max),
                water_leak: msg.data.data['65281']['100'] === 1,
            };
        }
    },

    // Ignore parsers (these message dont need parsing).
    {
        devices: ['WXKG11LM', 'MCCGQ11LM'],
        cid: 'genOnOff',
        type: 'devChange',
        convert: () => null
    },
    {
        devices: ['WXKG11LM', 'MCCGQ11LM', 'RTCGQ11LM', 'WSDCGQ11LM', 'SJCGQ11LM'],
        cid: 'genBasic',
        type: 'devChange',
        convert: () => null
    },
    {
        devices: ['RTCGQ11LM'],
        cid: 'msIlluminanceMeasurement',
        type: 'devChange',
        convert: () => null
    },
    {
        devices: ['RTCGQ11LM'],
        cid: 'msOccupancySensing',
        type: 'devChange',
        convert: () => null
    },
    {
        devices: ['WSDCGQ11LM'],
        cid: 'msTemperatureMeasurement',
        type: 'devChange',
        convert: () => null
    },
    {
        devices: ['WSDCGQ11LM'],
        cid: 'msRelativeHumidity',
        type: 'devChange',
        convert: () => null
    },
    {
        devices: ['WSDCGQ11LM'],
        cid: 'msPressureMeasurement',
        type: 'devChange',
        convert: () => null
    },    
];

module.exports = parsers;