hm-simulator 0.1.1 → 1.0.0

package/sim.js

@@ -1,542 +1,4 @@
-const fs = require('fs');
-const path = require('path');
-const EventEmitter = require('events');
-const express = require('express');
-const bodyParser = require('body-parser');
-const binrpc = require('binrpc');
-const xmlrpc = require('homematic-xmlrpc');
-
-module.exports = class HmSim {
-    constructor(options = {}) {
-        const log = options.log || {
-            debug: () => {},
-            info: () => {},
-            warn: () => {},
-            error: () => {}
-        };
-
-        this.log = log;
-
-        const config = options.config || {};
-
-        const devices = options.devices || {rfd: {devices: []}, hmip: {devices: []}};
-
-        const paramsetDescriptions = require('./data/paramset-descriptions.json');
-
-        const clients = {
-            rfd: {},
-            hmip: {}
-        };
-
-        const values = {
-            rfd: {},
-            hmip: {},
-            sysvars: {},
-            programs: {}
-        };
-
-        setDefaultValues('rfd');
-        setDefaultValues('hmip');
-
-        function setDefaultValues(iface) {
-            devices[iface].devices.forEach(dev => {
-                if (dev.PARENT_TYPE) {
-                    if (dev.PARAMSETS.includes('VALUES')) {
-                        const ps = getParamsetDescription(iface, dev, 'VALUES');
-                        Object.keys(ps).forEach(dp => {
-                            if (!values[iface][dev.ADDRESS]) {
-                                values[iface][dev.ADDRESS] = {
-                                    VALUES: {}
-                                };
-                            }
-
-                            if (ps[dp].type === 'ENUM') {
-                                values[iface][dev.ADDRESS].VALUES[dp] = ps[dp].VALUE_LIST.indexOf(ps[dp].DEFAULT);
-                            } else {
-                                values[iface][dev.ADDRESS].VALUES[dp] = ps[dp].DEFAULT;
-                            }
-                        });
-                    }
-                }
-            });
-        }
-
-        const rfdServer = binrpc.createServer({host: config.listenAddress, port: config.binrpcListenPort});
-        log.info('rfd binrpc server listening on', config.listenAddress, config.binrpcListenPort);
-        this.rfdServer = rfdServer;
-
-        const hmipServer = xmlrpc.createServer({host: config.listenAddress, port: config.xmlrpcListenPort});
-        log.info('hmip xmlrpc server listening on', config.listenAddress, config.xmlrpcListenPort);
-        this.hmipServer = hmipServer;
-
-        const rpcMethods = {
-            'system.listMethods': (err, iface, params, callback) => {
-                callback(null, Object.keys(rpcMethods));
-            },
-            init: (err, iface, params, callback) => {
-                const [url, id] = params;
-                let [protocol, host, port] = url.split(':');
-                host = host.replace(/^\/\//, '');
-                if (protocol === 'xmlrpc_bin') {
-                    protocol = 'binrpc';
-                }
-
-                const clientId = [host, port].join(':');
-
-                if (id === '') {
-                    log.debug('remove', iface, clients[iface][clientId].url);
-                    let client = clients[iface][clientId];
-                    // Todo ...
-                    if (client && typeof client.client.end === 'function') {
-                        client.client.end();
-                    }
-
-                    if (client && typeof client.client.close === 'function') {
-                        client.client.close();
-                    }
-
-                    if (client && typeof client.client.destroy === 'function') {
-                        client.client.destroy();
-                    }
-
-                    client = null;
-                    delete clients[iface][clientId];
-                } else {
-                    clients[iface][clientId] = {
-                        id,
-                        url,
-                        client: (protocol === 'binrpc' ? binrpc : xmlrpc).createClient({host, port}),
-                        methodCall: (methodName, params, callback) => {
-                            log.debug('rpc >', url, methodName, shortenParams(params));
-                            clients[iface][clientId].client.methodCall(methodName, params, (err, res) => {
-                                log.debug('rpc <', url, shortenParams(res));
-                                if (typeof callback === 'function') {
-                                    callback(err, res);
-                                }
-                            });
-                        }
-                    };
-                    startInit(iface, clients[iface][clientId]);
-                }
-
-                callback(null, '');
-            },
-            listDevices: (err, iface, params, callback) => {
-                callback(null, devices[iface].devices);
-            },
-            getParamsetDescription: (err, iface, params, callback) => {
-                const [address, paramset] = params;
-                callback(null, getParamsetDescription(iface, address, paramset));
-            },
-            ping: (err, iface, params, callback) => {
-                if (iface === 'hmip') {
-                    // Todo Remove when https://github.com/eq-3/occu/issues/42 is fixed
-                    return;
-                }
-
-                const [id] = params;
-                event(iface, ['CENTRAL', 'PONG', id]);
-                callback(null, '');
-            },
-            setValue: (err, iface, params, callback) => {
-                const [address, datapoint, value] = params;
-                setValue(iface, address, datapoint, value);
-                callback(null, '');
-            },
-            notFound: (methodName, iface, params) => {
-                log.error('rpc', iface, '< unknown method', methodName, shortenParams(params));
-            }
-        };
-
-        rpcMethods.NotFound = rpcMethods.notFound;
-
-        function event(iface, params) {
-            Object.keys(clients[iface]).forEach(c => {
-                const client = clients[iface][c];
-                params.unshift(client.id);
-                client.methodCall('event', params);
-            });
-        }
-
-        function eventMulticall(iface, events) {
-            Object.keys(clients[iface]).forEach(c => {
-                const multicall = [];
-                const client = clients[iface][c];
-                events.forEach(singleEvent => {
-                    const ev = [client.id, singleEvent[0], singleEvent[1], singleEvent[2]];
-                    multicall.push({methodName: 'event', params: ev});
-                });
-                client.methodCall('system.multicall', [multicall]);
-            });
-        }
-
-        function startInit(iface, client) {
-            client.methodCall('listDevices', [client.id], (err, clientDevices) => {
-                if (err) {
-                    log.error(err.toString());
-                } else {
-                    checkDevices(iface, client, clientDevices);
-                }
-            });
-        }
-
-        function checkDevices(iface, client, clientDevices) {
-            clientDevices = clientDevices || [];
-            log.info(iface, 'client', client.url, 'knows', clientDevices.length, 'devices');
-
-            const clientDeviceAddresses = [];
-            clientDevices.forEach(clientDev => {
-                clientDeviceAddresses.push(clientDev.ADDRESS);
-            });
-            const deviceAddresses = [];
-            devices[iface].devices.forEach(dev => {
-                deviceAddresses.push(dev.ADDRESS);
-            });
-            const newDevices = [];
-            const deleteDevices = [];
-
-            devices[iface].devices.forEach(dev => {
-                const clientDeviceIndex = clientDeviceAddresses.indexOf(dev.ADDRESS);
-                if (clientDeviceIndex === -1) {
-                    log.debug('device unknown by client', dev.ADDRESS);
-                    newDevices.push(dev);
-                } else {
-                    const clientDev = clientDevices[clientDeviceIndex];
-                    if (iface === 'hmip') {
-                        if (
-                        // Todo remove next line when https://github.com/eq-3/occu/issues/45 is fixed
-                            true ||
-                            // Todo is this correct? https://github.com/eq-3/occu/issues/43
-                            clientDev.VERSION !== dev.VERSION ||
-                            clientDev.AES_ACTIVE !== dev.AES_ACTIVE ||
-                            clientDev.CHILDREN !== dev.CHILDREN ||
-                            clientDev.DIRECTION !== dev.DIRECTION ||
-                            clientDev.FIRMWARE !== dev.FIRMWARE ||
-                            clientDev.FLAGS !== dev.FLAGS ||
-                            clientDev.GROUP !== dev.GROUP ||
-                            clientDev.INDEX !== dev.INDEX ||
-                            clientDev.INTERFACE !== dev.INTERFACE ||
-                            clientDev.LINK_SOURCE_ROLES !== dev.LINK_SOURCE_ROLES ||
-                            clientDev.LINK_TARGET_ROLES !== dev.LINK_TARGET_ROLES ||
-                            clientDev.PARAMSETS !== dev.PARAMSETS ||
-                            clientDev.PARENT !== dev.PARENT ||
-                            clientDev.PARENT_TYPE !== dev.PARENT_TYPE ||
-                            clientDev.RF_ADDRESS !== dev.RF_ADDRESS ||
-                            clientDev.ROAMING !== dev.ROAMING ||
-                            clientDev.RX_MODE !== dev.RX_MODE ||
-                            clientDev.TEAM !== dev.TEAM ||
-                            clientDev.TEAM_CHANNELS !== dev.TEAM_CHANNELS ||
-                            clientDev.TEAM_TAG !== dev.TEAM_TAG ||
-                            clientDev.TYPE !== dev.TYPE
-                        ) {
-                            // Todo log.debug('device mismatch', clientDev.ADDRESS);
-                            deleteDevices.push(clientDev.ADDRESS);
-                            newDevices.push(clientDev);
-                        }
-                    } else if (clientDev.VERSION !== dev.VERSION) {
-                        log.debug('device mismatch', clientDev.ADDRESS);
-                        deleteDevices.push(clientDev.ADDRESS);
-                        newDevices.push(clientDev);
-                    }
-                }
-            });
-            clientDevices.forEach(clientDev => {
-                if (!deviceAddresses.includes(clientDev.ADDRESS)) {
-                    log.debug('device unknown', clientDev.ADDRESS);
-                    deleteDevices.push(clientDev.ADDRESS);
-                }
-            });
-            if (deleteDevices.length > 0) {
-                log.info(iface, 'client', client.url, 'should delete', deleteDevices.length, 'devices');
-                client.methodCall('deleteDevices', [client.id, deleteDevices], () => {
-                    if (newDevices.length > 0) {
-                        log.info(iface, 'client', client.url, 'should add', newDevices.length, 'devices');
-                        client.methodCall('newDevices', [client.id, newDevices]);
-                    }
-                });
-            } else if (newDevices.length > 0) {
-                log.info(iface, 'client', client.url, 'should add', newDevices.length, 'devices');
-                client.methodCall('newDevices', [client.id, newDevices]);
-            } else {
-                log.info(iface, 'client', client.url, 'all devices known');
-            }
-        }
-
-        rpcMethods['system.listmethods'] = (err, iface, params, callback) => {
-            callback(null, Object.keys(rpcMethods));
-        };
-
-        Object.keys(rpcMethods).forEach(methodName => {
-            rfdServer.on(methodName, (err, params, callback) => {
-                log.debug('rpc rfd <', methodName, shortenParams(params));
-                rpcMethods[methodName](err, 'rfd', params, callback);
-            });
-            hmipServer.on(methodName, (err, params, callback) => {
-                log.debug('rpc hmip <', methodName, shortenParams(params));
-                rpcMethods[methodName](err, 'hmip', params, callback);
-            });
-        });
-
-        function shortenParams(params) {
-            if (!params) {
-                return;
-            }
-
-            const str = JSON.stringify(params);
-            if (str.length > 77) {
-                return str.slice(0, 77) + '...';
-            }
-
-            return str;
-        }
-
-        function getDevice(iface, address) {
-            const devs = devices[iface].devices;
-            for (const element of devs) {
-                if (element.ADDRESS === address) {
-                    return element;
-                }
-            }
-
-            log.error(iface, 'unknown device', address);
-            return false;
-        }
-
-        function paramsetName(iface, device, paramset) {
-            let cType = '';
-            let d;
-            if (device) {
-                if (device.PARENT) {
-                    // Channel
-                    cType = device.TYPE;
-                    const devs = devices[iface].devices;
-                    for (const element of devs) {
-                        if (element.ADDRESS === device.PARENT) {
-                            d = element;
-                            break;
-                        }
-                    }
-                } else {
-                    // Device
-                    d = device;
-                }
-
-                switch (iface) {
-                    case 'rfd':
-                        iface = 'BidCos-RF';
-                        break;
-                    case 'hmip':
-                        iface = 'HmIP-RF';
-                        break;
-                    default:
-                }
-
-                return [iface, d.TYPE, d.FIRMWARE, d.VERSION, cType, paramset].join('/');
-            }
-        }
-
-        function getParamsetDescription(iface, dev, paramset) {
-            if (typeof dev === 'string') {
-                const devs = devices[iface].devices;
-                for (const element of devs) {
-                    if (element.ADDRESS === dev) {
-                        dev = element;
-                        break;
-                    }
-                }
-            }
-
-            const psName = paramsetName(iface, dev, paramset);
-            return paramsetDescriptions[psName];
-        }
-
-        function setValue(iface, address, datapoint, value) {
-            log.debug('setValue', iface, address, datapoint, value);
-            const dev = getDevice(iface, address);
-            if (dev) {
-                const ps = getParamsetDescription(iface, address, 'VALUES');
-                if (ps && ps[datapoint]) {
-                    switch (ps[datapoint].TYPE) {
-                        case 'ACTION':
-                        case 'BOOL':
-                            if (typeof value !== 'boolean') {
-                                log.error('type mismatch', address, datapoint, ps[datapoint].TYPE);
-                                return;
-                            }
-
-                            break;
-                        case 'INTEGER':
-                        case 'FLOAT':
-                            if (typeof value !== 'number') {
-                                log.error('type mismatch', address, datapoint, ps[datapoint].TYPE);
-                                return;
-                            }
-
-                            if ((value < ps[datapoint].MIN) || (value > ps[datapoint].MAx)) {
-                                log.error('range error', address, datapoint, ps[datapoint].MIN, ps[datapoint].MAX);
-                                return;
-                            }
-
-                            break;
-                        default:
-                    }
-
-                    values[iface][address].VALUES[datapoint] = value;
-
-                    if (ps[datapoint].OPERATIONS & 4) {
-                        const events = [];
-                        if (ps[datapoint].TYPE === 'ACTION') {
-                            events.push([address, datapoint, values[iface][address].VALUES[datapoint]]);
-                        } else {
-                            Object.keys(values[iface][address].VALUES).forEach(dp => {
-                                events.push([address, dp, values[iface][address].VALUES[dp]]);
-                            });
-                        }
-
-                        eventMulticall(iface, events);
-                    }
-                } else {
-                    log.error('unknown params', address, datapoint);
-                }
-            }
-        }
-
-        this.api = new EventEmitter();
-
-        this.api.on('setValue', setValue);
-
-        this.loadBehaviors(options.behaviorPath || path.join(__dirname, 'behaviors'));
-
-        if (options.rega) {
-            this.regaSim = new RegaSim(options.rega, this.log);
-        }
-    }
-
-    loadBehaviors(p) {
-        const files = fs.readdirSync(p);
-        files.forEach(file => {
-            if (file.match(/\.js$/)) {
-                this.log.info('loading behavior', file);
-                require(path.join(p, file))(this.api);
-            }
-        });
-    }
-
-    close() {
-        this.api.removeAllListeners();
-        this.rfdServer.server.close();
-        this.hmipServer.httpServer.close();
-        if (this.regaSim) {
-            this.regaSim.close();
-        }
-    }
-};
-
-class RegaSim {
-    constructor(options, log) {
-        this.variables = options.variables || [];
-        this.devices = options.channels || [];
-        this.programs = options.programs || [];
-        this.rooms = options.rooms || [];
-        this.functions = options.functions || [];
-
-        this.app = express();
-        this.app.use(bodyParser.raw({type: 'application/*'}));
-        this.app.get('/[a-zA-Z_-]+.exe', (req, res) => {
-            console.log('get', req.url, req.queryString);
-            res.send(this.response(''));
-        });
-
-        this.app.post('/[a-zA-Z_-]+.exe', (req, res) => {
-            const script = req.body.toString();
-            const line = script.split('\n')[0];
-            let response;
-            switch (line) {
-                case '!# devices.rega':
-                    response = this.response(this.devices);
-                    break;
-                case '!# variables.rega':
-                    response = this.response(this.variables);
-                    break;
-
-                case '!# programs.rega':
-                    response = this.response(this.programs);
-                    break;
-                case '!# rooms.rega':
-                    response = this.response(this.rooms);
-                    break;
-                case '!# functions.rega':
-                    response = this.response(this.functions);
-                    break;
-
-                default:
-                    let match;
-                    if (match = line.match(/dom\.GetObject\((\d+)\).State\(([^)]*)\)/)) {
-                        let [, id, val] = match;
-                        id = parseInt(id, 10);
-                        val = JSON.parse(val || '');
-                        this.variables.forEach((v, i) => {
-                            if (v.id === id) {
-                                this.variables[i].val = val;
-                                this.variables[i].ts = this.ts();
-                            }
-                        });
-                    } else {
-                        log.warn('unknown script', line);
-                    }
-
-                    response = this.response('');
-            }
-
-            res.set({
-                server: 'ise GmbH HTTP-Server v2.0',
-                'accept-ranges': 'bytes',
-                'cache-control': 'no-store, no-cache',
-                'content-type': 'text/xml; charset=iso-8859-1',
-                'content-length': response.length
-            });
-            res.send(response);
-        });
-
-        this.server = this.app.listen(options.port, () => {
-            // Console.log('RegaSim listening on Port ' + options.port);
-        });
-    }
-
-    close() {
-        this.server.close();
-    }
-
-    response(stdout, vars = []) {
-        if (typeof stdout !== 'string') {
-            stdout = JSON.stringify(stdout);
-        }
-
-        const xml = [
-            ['exec', 'rega.exe'],
-            ['sessionId', ''],
-            ['httpUserAgent', '']
-        ].concat(vars);
-
-        stdout += '<xml>';
-
-        xml.forEach(kv => {
-            const [key, value] = kv;
-            stdout += `<${key}>${value}</${key}>`;
-        });
-        stdout += '</xml>';
-
-        return stdout;
-    }
-
-    ts() {
-        const d = new Date();
-        return d.getFullYear() + '-' +
-            ('0' + (d.getMonth() + 1)).slice(-2) + '-' +
-            ('0' + d.getDate()).slice(-2) + ' ' +
-            ('0' + d.getHours()).slice(-2) + ':' +
-            ('0' + d.getMinutes()).slice(-2) + ':' +
-            ('0' + d.getSeconds()).slice(-2);
-    }
-}
+'use strict';
 
+// kept at the package root because consumers require(hm-simulator/sim) and require(hm-simulator/sim.js)
+module.exports = require('./lib/sim.js');

package/sim.mjs

@@ -0,0 +1,5 @@
+// ESM wrapper. The implementation stays CommonJS because the consumers require() it.
+import HmSim from './sim.js';
+
+export default HmSim;
+export {HmSim};

package/.travis.yml

@@ -1,3 +0,0 @@
-language: node_js
-node_js:
-  - '6'

package/config.js

@@ -1,3 +0,0 @@
-module.exports = {
-
-};