homebridge-tuya-plus 3.1.2

package/bin/cli-find.js

@@ -0,0 +1,207 @@
+#!/usr/bin/env node
+
+const Proxy = require('http-mitm-proxy');
+const EventEmitter = require('events');
+const program = require('commander');
+const QRCode = require('qrcode');
+const path = require('path');
+const os = require('os');
+const JSON5 = require('json5');
+const fs = require('fs-extra');
+
+// Disable debug messages from the proxy
+try {
+    require('debug').disable();
+} catch(ex) {}
+
+const ROOT = path.resolve(__dirname);
+
+const pemFile = path.join(ROOT, 'certs', 'ca.pem');
+
+let localIPs = [];
+const ifaces = os.networkInterfaces();
+Object.keys(ifaces).forEach(name => {
+    ifaces[name].forEach(network => {
+        if (network.family === 'IPv4' && !network.internal) localIPs.push(network.address);
+    });
+});
+
+const proxy = Proxy();
+const emitter = new EventEmitter();
+
+program
+    .name('tuya-lan find')
+    .option('--ip <ip>', 'IP address to listen for requests')
+    .option('-p, --port <port>', 'port the proxy should listen on', 8060)
+    .option('--schema', 'include schema in the output')
+    .parse(process.argv);
+
+
+if (program.ip) {
+    if (localIPs.includes(program.ip)) localIPs = [program.ip];
+    else {
+        console.log(`The requested IP, ${program.ip}, is not a valid external IPv4 address. The valid options are:\n\t${localIPs.join('\n\t')}`);
+        process.exit();
+    }
+}
+if (localIPs.length > 1) {
+    console.log(`You have multiple network interfaces: ${localIPs.join(', ')}\nChoose one by passing it with the --ip parameter.\n\nExample: tuya-lan-find --ip ${localIPs[0]}`);
+    process.exit();
+}
+const localIPPorts = localIPs.map(ip => `${ip}:${program.port}`);
+
+const escapeUnicode = str => str.replace(/[\u00A0-\uffff]/gu, c => "\\u" + ("000" + c.charCodeAt().toString(16)).slice(-4));
+
+proxy.onError(function(ctx, err) {
+    switch (err.code) {
+        case 'ERR_STREAM_DESTROYED':
+        case 'ECONNRESET':
+            return;
+
+        case 'ECONNREFUSED':
+            console.error('Failed to intercept secure communications. This could happen due to bad CA certificate.');
+            return;
+
+        case 'EACCES':
+            console.error(`Permission was denied to use port ${program.port}.`);
+            return;
+
+        default:
+            console.error('Error:', err.code, err);
+    }
+});
+
+proxy.onRequest(function(ctx, callback) {
+    if (ctx.clientToProxyRequest.method === 'GET' && ctx.clientToProxyRequest.url === '/cert' && localIPPorts.includes(ctx.clientToProxyRequest.headers.host)) {
+        ctx.use(Proxy.gunzip);
+        console.log('Intercepted certificate request');
+
+        ctx.proxyToClientResponse.writeHeader(200, {
+            'Accept-Ranges': 'bytes',
+            'Cache-Control': 'public, max-age=0',
+            'Content-Type': 'application/x-x509-ca-cert',
+            'Content-Disposition': 'attachment; filename=cert.pem',
+            'Content-Transfer-Encoding': 'binary',
+            'Content-Length': fs.statSync(pemFile).size,
+            'Connection': 'keep-alive',
+        });
+        //ctx.proxyToClientResponse.end(fs.readFileSync(path.join(ROOT, 'certs', 'ca.pem')));
+        ctx.proxyToClientResponse.write(fs.readFileSync(pemFile));
+        ctx.proxyToClientResponse.end();
+
+        return;
+
+    } else if (ctx.clientToProxyRequest.method === 'POST' && /tuya/.test(ctx.clientToProxyRequest.headers.host)) {
+        ctx.use(Proxy.gunzip);
+
+        ctx.onRequestData(function(ctx, chunk, callback) {
+            return callback(null, chunk);
+        });
+        ctx.onRequestEnd(function(ctx, callback) {
+            callback();
+        });
+
+        let chunks = [];
+        ctx.onResponseData(function(ctx, chunk, callback) {
+            chunks.push(chunk);
+            return callback(null, chunk);
+        });
+        ctx.onResponseEnd(function(ctx, callback) {
+            emitter.emit('tuya-config', Buffer.concat(chunks).toString());
+            callback();
+        });
+    }
+
+    return callback();
+});
+
+emitter.on('tuya-config', body => {
+    if (body.indexOf('tuya.m.my.group.device.list') === -1) return;
+    console.log('Intercepted config from Tuya');
+    let data;
+    const fail = (msg, err) => {
+        console.error(msg, err);
+        process.exit(1);
+    };
+    try {
+        data = JSON.parse(body);
+    } catch (ex) {
+        return fail('There was a problem decoding config:', ex);
+    }
+    if (!Array.isArray(data.result)) return fail('Couldn\'t find a valid result-set.');
+
+    let devices = [];
+    data.result.some(data => {
+        if (data && data.a === 'tuya.m.my.group.device.list') {
+            devices = data.result;
+            return true;
+        }
+        return false;
+    });
+
+    if (!Array.isArray(devices)) return fail('Couldn\'t find a good list of devices.');
+
+    console.log(`\nFound ${devices.length} device${devices.length === 1 ? '' : 's'}:`);
+
+    const foundDevices = devices.map(device => {
+        return {
+            name: device.name,
+            id: device.devId,
+            key: device.localKey,
+            pid: device.productId
+        }
+    });
+
+    if (program.schema) {
+        let schemas = [];
+        data.result.some(data => {
+            if (data && data.a === 'tuya.m.device.ref.info.my.list') {
+                schemas = data.result;
+                return true;
+            }
+            return false;
+        });
+
+        if (Array.isArray(schemas)) {
+            const defs = {};
+            schemas.forEach(schema => {
+                if (schema.id && schema.schemaInfo) {
+                    defs[schema.id] = {};
+                    if (schema.schemaInfo.schema) defs[schema.id].schema = escapeUnicode(schema.schemaInfo.schema);
+                    if (schema.schemaInfo.schemaExt && schema.schemaInfo.schemaExt !== '[]') defs[schema.id].extras = escapeUnicode(schema.schemaInfo.schemaExt);
+                }
+            });
+            foundDevices.forEach(device => {
+                if (defs[device.pid]) device.def = defs[device.pid];
+            });
+        } else console.log('Didn\'t find schema definitions. You will need to identify the data-points manually if this is a new device.');
+    }
+
+    foundDevices.forEach(device => {
+        delete device.pid;
+    });
+
+    console.log(JSON5.stringify(foundDevices, '\n', 2));
+
+    setTimeout(() => {
+        process.exit(0);
+    }, 5000);
+});
+
+proxy.listen({port: program.port, sslCaDir: ROOT}, err => {
+    if (err) {
+        console.error('Error starting proxy: ' + err);
+        return setTimeout(() => {
+            process.exit(0);
+        }, 5000);
+    }
+    let {address, port} = proxy.httpServer.address();
+    if (address === '::' || address === '0.0.0.0') address = localIPs[0];
+
+    QRCode.toString(`http://${address}:${port}/cert`, {type: 'terminal'}, function(err, url) {
+        console.log(url);
+        console.log('\nFollow the instructions on https://github.com/AMoo-Miki/homebridge-tuya-lan/wiki/Setup-Instructions');
+        console.log(`Proxy IP: ${address}`);
+        console.log(`Proxy Port: ${port}\n\n`);
+    })
+});

package/bin/cli.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+const program = require('commander');
+const path = require('path');
+const fs = require('fs-extra');
+
+const ROOT = path.resolve(__dirname);
+
+program
+    .version('v' + fs.readJSONSync(path.join(ROOT, '../package.json')).version, '-v, --version', 'output package version')
+    .command('decode', 'decode a file or packet')
+    .command('find', 'find device id and key combinations', {isDefault: true})
+    .parse(process.argv);

package/config-example.MD

@@ -0,0 +1,43 @@
+## Working Apps:
+> Current apps working to get device ID's:
+- uComen Home
+
+
+
+
+## Configurations
+The configuration parameters to enable your devices would need to be added to `platforms` section of the Homebridge configuration file. Examples of device configs can be found on the [Supported Device Types](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types) page. Check out the [Common Problems](https://github.com/iRayanKhan/homebridge-tuya/wiki/Common-Problems) page for solutions or raise an issue if you face problems.
+```json5
+{
+    ...
+    "platforms": [
+        ...
+        /* The block you need to enable this plugin */
+        {
+            "platform": "TuyaLan",
+            "devices": [
+                /* The block you need for each device */
+                {
+                    "name": "Hallway Light",
+                    "type": "SimpleLight",
+                    "manufacturer": "Cotify",
+                    "model": "Smart Wifi Bulb Socket E26",
+                    "id": "011233455677899abbcd",
+                    "key": "0123456789abcdef"
+                }
+                /* End of the device definition block */ 
+            ]
+        }
+        /* End of the block needed to enable this plugin */
+    ]
+    ...
+}
+```
+#### Parameters
+* `name` (required) is anything you'd like to use to identify this device. You can always change the name from within the Home app.
+* `type` (required) is a case-insensitive identifier that lets the plugin know how to handle your device. Find your device `type` on the [Supported Device Type List](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types) page.
+* `manufacturer` and `model` are anything you like; the purpose of them is to help you identify the device.
+* `id` (required) and `key` (required) are parameters for your device. If you don't have them, follow the steps found on the [Setup Instructions](https://github.com/iRayanKgan/homebridge-tuya/wiki/Setup-Instructions) page.
+* `ip` needs to be added **_only_** if you face discovery issues. See [Common Problems](https://github.com/iRayanKhan/homebridge-tuya/wiki/Common-Problems) for more details.   
+
+> To find out which `id` belongs to which device, open the Tuya Smart app and check the `Device Information` by tapping the configuration icon of your devices; it is almost always a tiny icon on the top-right.