gidrolock-guides/Winner/ZigBee/Winner_ZigBee_dev.js

const fz = require('zigbee-herdsman-converters/converters/fromZigbee');
const tz = require('zigbee-herdsman-converters/converters/toZigbee');
const exposes = require('zigbee-herdsman-converters/lib/exposes');
const reporting = require('zigbee-herdsman-converters/lib/reporting');
const modernExtend = require('zigbee-herdsman-converters/lib/modernExtend');
const e = exposes.presets;
const ea = exposes.access;
const tuya = require('zigbee-herdsman-converters/lib/tuya');

//DP value masks
const counterMask = 0b00000111_11111111_11111111_11111111;

const tzDatapoints = {
    ...tuya.tz.datapoints,
    key: ['switch', /*'percent_control',*/ 'fault', 'weather_delay', 'countdown', 'smart_weather', 'minihum_set', 'alarm', 'battery', 'cleaning', 'journal', 
        'sensor_1',     'sensor_name_1', 
        'sensor_2',     'sensor_name_2', 
        'sensor_3',     'sensor_name_3', 
        'sensor_4',     'sensor_name_4', 
        'sensor_5',     'sensor_name_5', 
        'sensor_6',     'sensor_name_6', 
        'sensor_7',     'sensor_name_7', 
        'sensor_8',     'sensor_name_8', 
        'sensor_9',     'sensor_name_9', 
        'sensor_10',    'sensor_name_10', 
        'sensor_11',    'sensor_name_11', 
        'sensor_12',    'sensor_name_12', 
        'sensor_13',    'sensor_name_13', 
        'sensor_14',    'sensor_name_14', 
        'sensor_15',    'sensor_name_15', 
        'sensor_16',    'sensor_name_16',
        'sensor_17',    'sensor_name_17', 
        'sensor_18',    'sensor_name_18', 
        'sensor_19',    'sensor_name_19', 
        'sensor_20',    'sensor_name_20', 
        'sensor_21',    'sensor_name_21', 
        'sensor_22',    'sensor_name_22', 
        'sensor_23',    'sensor_name_23', 
        'sensor_24',    'sensor_name_24', 
        'sensor_25',    'sensor_name_25', 
        'sensor_26',    'sensor_name_26', 
        'sensor_27',    'sensor_name_27', 
        'sensor_28',    'sensor_name_28', 
        'sensor_29',    'sensor_name_29', 
        'sensor_30',    'sensor_name_30', 
        'sensor_31',    'sensor_name_31', 
        'sensor_32',    'sensor_name_32' 
    ]
}
const definition = {
    fingerprint: [
        {
            modelID: 'TS0601',
            manufacturerName: '_TZE200_yltivvzb',
        },
    ],
    model: 'Gidrolock Winner',
    vendor: 'Gidrolock',
    description: 'Gidrolock smart water valve',
    fromZigbee: [tuya.fz.datapoints],
    toZigbee: [tzDatapoints],
    onEvent: tuya.onEventSetTime,
    exposes: [
        exposes.presets.enum('fault', ea.STATE, ['low_battery', 'fault', 'lack_water', 'sensor_fault', 'motor_fault', 'low_temp']).withCategory('diagnostic'),
        exposes.presets.binary('switch', ea.STATE_SET, true, false ).withLabel('Valve status:'),
        exposes.presets.binary('cleaning', ea.STATE_SET, true, false).withLabel('Cleaning Mode:'),
        exposes.presets.binary('alarm', ea.STATE_SET, true, false),
        exposes.presets.enum('battery', ea.STATE, ['10', '20', '30', '40', '50', '60', '70', '80', '90', '100', '101']),
        

        /* WIP
        //exposes.presets.binary('channel_2', ea.SET, true, false), //send-only DP, doesn't get sent by the device and causes errors
        exposes.presets.text('journal', ea.STATE),
        exposes.presets.text('sensor_name_1', ea.ALL),
        exposes.presets.numeric('sensor_1', ea.STATE),
        exposes.presets.text('sensor_name_2', ea.ALL).withLabel('Sensor 2 Name:').withProperty('test'),
        exposes.presets.numeric('sensor_2', ea.STATE_GET),
        */
    ],
    meta: {
        tuyaDatapoints: [
            [1, 'switch', tuya.valueConverter.raw],
            //[2, 'percent_control', tuya.valueConverter.raw], //don't even know what this is
            [4, 'fault', tuya.valueConverter.raw],
            [101, 'alarm', tuya.valueConverter.raw],
            [102, 'battery', tuya.valueConverterBasic.lookup({'10': tuya.enum(0), '20': tuya.enum(1), '30': tuya.enum(2), '40': tuya.enum(3), '50': tuya.enum(4), '60': tuya.enum(5), '70': tuya.enum(6), '80': tuya.enum(7), '90': tuya.enum(8), '100': tuya.enum(9), '101': tuya.enum(10)})],
            [104, 'cleaning', tuya.valueConverter.raw],

            //#region WIP
            
            //[103, 'device_cmd', tuya.valueConverter.raw], // a Number DP used to issue commands to the device 
            //[105, 'journal', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})] // Temporarily publishes string 'sensor name;x' where "x" is any of following characters: A - leak detected; B - Winner's battery charge is low; L - low sensor charge; T - sensor signal lost;
            //[106, 'channel_2', tuya.valueConverter.raw], //send-only boolean DP used for external sensors; doesn't get sent by the device and throws an error in z2mqtt
            
            //#region Water Counters
            /* - Tick Settings: 1 tick per 1 liter | 1 tick per 10 liters; 
            *
            * - Number DPs contain both counter ticks to display the water volume and a bit flag for Smart Life App;
            *   Use counterMask to get the water volume (multiply by ticks):
            let counterWaterValue1 = (counter1 & counterMask) * counterMultiplier1 //or something like that
            */

            //[10, 'weather_delay', tuya.valueConverterBasic.lookup({'1': tuya.enum(0), '10': tuya.enum(1)})],    // counter 1 setting
            //[11, 'countdown', tuya.valueConverter.raw],                                                         // counter 1 Number DP
            //[13, 'smart_weather', tuya.valueConverterBasic.lookup({'1': tuya.enum(0), '10': tuya.enum(1)})],    // counter 2 setting
            //[21, 'minihum_set', tuya.valueConverter.raw],                                                       // counter 2 Number DP
            //#endregion

            //#region Sensors
            /* Each sensor DP has the following structure:
            *
            *   0xAA_BB_CC_DD where:
            *   [AA]    - command bit flags
            *   [BB]    - status bit flags
            *   [CC]    - signal strength
            *   [DD]    - battery charge
            */

            /*
            [107, 'sensor_1', tuya.valueConverter.raw],
            [108, 'sensor_name_1', tuya.valueConverter.raw],
            
            [109, 'sensor_2', tuya.valueConverter.raw],
            [110, 'sensor_name_2', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [111, 'sensor_3', tuya.valueConverter.raw],
            [112, 'sensor_name_3', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],

            [113, 'sensor_4', tuya.valueConverter.raw],
            [114, 'sensor_name_4', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],

            [115, 'sensor_5', tuya.valueConverter.raw],
            [116, 'sensor_name_5', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [117, 'sensor_6', tuya.valueConverter.raw],
            [118, 'sensor_name_6', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [119, 'sensor_7', tuya.valueConverter.raw],
            [120, 'sensor_name_7', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [121, 'sensor_8', tuya.valueConverter.raw],
            [122, 'sensor_name_8', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [123, 'sensor_9', tuya.valueConverter.raw],
            [124, 'sensor_name_9', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [125, 'sensor_10', tuya.valueConverter.raw],
            [126, 'sensor_name_10', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [127, 'sensor_11', tuya.valueConverter.raw],
            [128, 'sensor_name_11', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [129, 'sensor_12', tuya.valueConverter.raw],
            [130, 'sensor_name_12', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [131, 'sensor_13', tuya.valueConverter.raw],
            [132, 'sensor_name_13', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [133, 'sensor_14', tuya.valueConverter.raw],
            [134, 'sensor_name_14', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [135, 'sensor_15', tuya.valueConverter.raw],
            [136, 'sensor_name_15', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [137, 'sensor_16', tuya.valueConverter.raw],
            [138, 'sensor_name_16', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [139, 'sensor_17', tuya.valueConverter.raw],
            [140, 'sensor_name_17', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [141, 'sensor_18', tuya.valueConverter.raw],
            [142, 'sensor_name_18', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [143, 'sensor_19', tuya.valueConverter.raw],
            [144, 'sensor_name_19', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [145, 'sensor_20', tuya.valueConverter.raw],
            [146, 'sensor_name_20', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [147, 'sensor_21', tuya.valueConverter.raw],
            [148, 'sensor_name_21', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [149, 'sensor_22', tuya.valueConverter.raw],
            [150, 'sensor_name_22', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [151, 'sensor_23', tuya.valueConverter.raw],
            [152, 'sensor_name_23', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [153, 'sensor_24', tuya.valueConverter.raw],
            [154, 'sensor_name_24', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [155, 'sensor_25', tuya.valueConverter.raw],
            [156, 'sensor_name_25', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [157, 'sensor_26', tuya.valueConverter.raw],
            [158, 'sensor_name_26', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [159, 'sensor_27', tuya.valueConverter.raw],
            [160, 'sensor_name_27', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [161, 'sensor_28', tuya.valueConverter.raw],
            [162, 'sensor_name_28', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [163, 'sensor_29', tuya.valueConverter.raw],
            [164, 'sensor_name_29', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [165, 'sensor_30', tuya.valueConverter.raw],
            [166, 'sensor_name_30', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [167, 'sensor_31', tuya.valueConverter.raw],
            [168, 'sensor_name_31', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            
            [169, 'sensor_32', tuya.valueConverter.raw],
            [170, 'sensor_name_32', tuya.valueConverterBasic.lookup({'single': 0, 'double': 1, 'hold': 2})],
            */
           //#endregion WIP
            //#endregion
        ],
    },
    extend: [   
       tuya.modernExtend.tuyaMagicPacket(),        
    ],
};

module.exports = definition;