iobroker.zigbee2mqtt 1.0.0 → 2.1.0

package/lib/statesController.js

@@ -1,12 +1,13 @@
 const utils = require('./utils');
 const incStatsQueue = [];
+const timeOutCache = {};
 
 class StatesController {
-	constructor(adapter, deviceCache, groupCache, debugDevices) {
+	constructor(adapter, deviceCache, groupCache, logCustomizations) {
 		this.adapter = adapter;
 		this.groupCache = groupCache;
 		this.deviceCache = deviceCache;
-		this.debugDevices = debugDevices;
+		this.logCustomizations = logCustomizations;
 	}
 
 	async processDeviceMessage(messageObj) {
@@ -22,15 +23,14 @@ class StatesController {
 			} catch (error) {
 				this.adapter.log.error(error);
 			}
-		}
-		else {
+		} else {
 			incStatsQueue[incStatsQueue.length] = messageObj;
 			this.adapter.log.debug(`Device: ${messageObj.topic} not found, queue state in incStatsQueue!`);
 		}
 	}
 
 	async setDeviceState(messageObj, device) {
-		if (this.debugDevices.includes(device.ieee_address)) {
+		if (this.logCustomizations.debugDevices.includes(device.ieee_address)) {
 			this.adapter.log.warn(`--->>> fromZ2M -> ${device.ieee_address} states: ${JSON.stringify(messageObj)}`);
 		}
 
@@ -53,23 +53,19 @@ class StatesController {
 					if (state.isEvent) {
 						if (state.getter) {
 							await this.setStateWithTimeoutAsync(stateName, state.getter(messageObj.payload), 300);
-						}
-						else {
+						} else {
 							await this.setStateWithTimeoutAsync(stateName, value, 300);
 						}
-					}
-					else {
+					} else {
 						if (state.getter) {
-							await this.setStateAsync(stateName, state.getter(messageObj.payload));
-						}
-						else {
-							await this.setStateAsync(stateName, value);
+							await this.setStateChangedAsync(stateName, state.getter(messageObj.payload));
+						} else {
+							await this.setStateChangedAsync(stateName, value);
 						}
 					}
 				} catch (err) {
-					//this.adapter.log.warn(`Can not set ${stateName}`);
 					incStatsQueue[incStatsQueue.length] = messageObj;
-					this.adapter.log.debug(`Can not set ${stateName} for ${messageObj.topic}, queue state in incStatsQueue!`);
+					this.adapter.log.debug(`Can not set ${stateName}, queue state in incStatsQueue!`);
 				}
 			}
 		}
@@ -81,10 +77,19 @@ class StatesController {
 		}
 	}
 
+	async setStateChangedAsync(stateName, value) {
+		if (value !== undefined) {
+			await this.adapter.setStateChangedAsync(stateName, value, true);
+		}
+	}
+
 	async setStateWithTimeoutAsync(stateName, value, timeout) {
 		if (value !== undefined) {
 			await this.adapter.setStateAsync(stateName, value, true);
-			setTimeout(() => {
+			if (timeOutCache[stateName]) {
+				clearTimeout(timeOutCache[stateName]);
+			}
+			timeOutCache[stateName] = setTimeout(() => {
 				this.adapter.setStateAsync(stateName, !value, true);
 			}, timeout);
 		}
@@ -115,13 +120,19 @@ class StatesController {
 		for (const device of this.deviceCache) {
 			for (const state of device.states) {
 				if (state.id == 'available') {
-					await this.adapter.setStateAsync(`${device.ieee_address}.${state.id}`, false, true);
+					await this.adapter.setStateChangedAsync(`${device.ieee_address}.${state.id}`, false, true);
 				}
 			}
 		}
 	}
+
+	async allTimerClear() {
+		for (const timer in timeOutCache) {
+			clearTimeout(timeOutCache[timer]);
+		}
+	}
 }
 
 module.exports = {
 	StatesController
-};
+};

package/lib/utils.js

@@ -106,12 +106,6 @@ function getDeviceIcon(definition) {
 	return icon;
 }
 
-function removeDeviceByIeee(devices, ieee_address) {
-	const idx = devices.findIndex(x => x.ieee_address == ieee_address);
-	if (idx > -1) {
-		devices.splice(idx, 1);
-	}
-}
 function clearArray(array) {
 	while (array.length > 0) {
 		array.pop();
@@ -125,16 +119,15 @@ function moveArray(source, target) {
 }
 
 module.exports = {
-	bulbLevelToAdapterLevel: bulbLevelToAdapterLevel,
-	adapterLevelToBulbLevel: adapterLevelToBulbLevel,
-	bytesArrayToWordArray: bytesArrayToWordArray,
-	toMired: toMired,
-	miredKelvinConversion: miredKelvinConversion,
-	decimalToHex: decimalToHex,
-	getZbId: getZbId,
-	getAdId: getAdId,
-	removeDeviceByIeee: removeDeviceByIeee,
-	getDeviceIcon: getDeviceIcon,
-	clearArray: clearArray,
-	moveArray: moveArray,
-};
+	bulbLevelToAdapterLevel,
+	adapterLevelToBulbLevel,
+	bytesArrayToWordArray,
+	toMired,
+	miredKelvinConversion,
+	decimalToHex,
+	getZbId,
+	getAdId,
+	getDeviceIcon,
+	clearArray,
+	moveArray,
+};

package/lib/websocketController.js

@@ -0,0 +1,84 @@
+const WebSocket = require('ws');
+let wsClient;
+const wsHeartbeatIntervall = 5000;
+const restartTimeout = 1000;
+let ping;
+let pingTimeout;
+let autoRestartTimeout;
+
+class WebsocketController {
+	constructor(adapter) {
+		this.adapter = adapter;
+	}
+
+	async initWsClient(server, port) {
+		try {
+			wsClient = new WebSocket(`ws://${server}:${port}/api`);
+
+			wsClient.on('open', () => {
+				// Send ping to server
+				this.sendPingToServer();
+				// Start Heartbeat
+				this.wsHeartbeat();
+			});
+
+			wsClient.on('pong', () => {
+				this.wsHeartbeat();
+			});
+
+			wsClient.on('close', async () => {
+				clearTimeout(pingTimeout);
+				clearTimeout(ping);
+
+				if (wsClient.readyState === WebSocket.CLOSED) {
+					this.autoRestart();
+				}
+			});
+
+			wsClient.on('message', () => { });
+
+			wsClient.on('error', (err) => { this.adapter.log.debug(err); });
+
+			return wsClient;
+		} catch (err) {
+			this.adapter.log.error(err);
+		}
+	}
+
+	async send(message) {
+		wsClient.send(message);
+	}
+
+	async sendPingToServer() {
+		//this.logDebug('Send ping to server');
+		wsClient.ping();
+		ping = setTimeout(() => {
+			this.sendPingToServer();
+		}, wsHeartbeatIntervall);
+	}
+
+	async wsHeartbeat() {
+		clearTimeout(pingTimeout);
+		pingTimeout = setTimeout(() => {
+			this.adapter.log.warn('Websocked connection timed out');
+			wsClient.terminate();
+		}, wsHeartbeatIntervall + 1000);
+	}
+
+	async autoRestart() {
+		this.adapter.log.warn(`Start try again in ${restartTimeout / 1000} seconds...`);
+		autoRestartTimeout = setTimeout(() => {
+			this.adapter.onReady();
+		}, restartTimeout);
+	}
+
+	async allTimerClear() {
+		clearTimeout(pingTimeout);
+		clearTimeout(ping);
+		clearTimeout(autoRestartTimeout);
+	}
+}
+
+module.exports = {
+	WebsocketController
+};

package/lib/z2mController.js

@@ -1,9 +1,9 @@
 class Z2mController {
-	constructor(adapter, deviceCache, groupCache, logfilter) {
+	constructor(adapter, deviceCache, groupCache, logCustomizations) {
 		this.adapter = adapter;
 		this.groupCache = groupCache;
 		this.deviceCache = deviceCache;
-		this.logfilter = logfilter;
+		this.logCustomizations = logCustomizations;
 	}
 
 	async createZ2MMessage(id, state) {
@@ -57,7 +57,7 @@ class Z2mController {
 
 	async proxyZ2MLogs(messageObj) {
 		const logMessage = messageObj.payload.message;
-		if (this.logfilter.some(x => logMessage.includes(x))) {
+		if (this.logCustomizations.logfilter.some(x => logMessage.includes(x))) {
 			return;
 		}
 

package/main.js

@@ -7,7 +7,6 @@
 // The adapter-core module gives you access to the core ioBroker functions
 // you need to create an adapter
 const core = require('@iobroker/adapter-core');
-const NedbPersistence = require('aedes-persistence-nedb');
 const mqtt = require('mqtt');
 const checkConfig = require('./lib/check').checkConfig;
 const adapterInfo = require('./lib/messages').adapterInfo;
@@ -15,6 +14,8 @@ const zigbee2mqttInfo = require('./lib/messages').zigbee2mqttInfo;
 const Z2mController = require('./lib/z2mController').Z2mController;
 const DeviceController = require('./lib/deviceController').DeviceController;
 const StatesController = require('./lib/statesController').StatesController;
+const WebsocketController = require('./lib/websocketController').WebsocketController;
+const MqttServerController = require('./lib/mqttServerController').MqttServerController;
 
 
 let mqttClient;
@@ -22,16 +23,13 @@ let mqttClient;
 let deviceCache = [];
 // eslint-disable-next-line prefer-const
 let groupCache = [];
-let ping;
-let pingTimeout;
-let autoRestartTimeout;
-let checkAvailableTimout;
-let debugDevices = '';
-let logfilter = [];
+const logCustomizations = { debugDevices: '', logfilter: [] };
 let showInfo = true;
 let statesController;
 let deviceController;
 let z2mController;
+let websocketController;
+let mqttServerController;
 
 class Zigbee2mqtt extends core.Adapter {
 
@@ -46,11 +44,9 @@ class Zigbee2mqtt extends core.Adapter {
 	}
 
 	async onReady() {
-
-
-		statesController = new StatesController(this, deviceCache, groupCache, debugDevices);
-		deviceController = new DeviceController(this, deviceCache, groupCache, this.config.useKelvin);
-		z2mController = new Z2mController(this, deviceCache, groupCache, logfilter);
+		statesController = new StatesController(this, deviceCache, groupCache, logCustomizations);
+		deviceController = new DeviceController(this, deviceCache, groupCache, this.config);
+		z2mController = new Z2mController(this, deviceCache, groupCache, logCustomizations);
 
 		// Initialize your adapter here
 		adapterInfo(this.config, this.log);
@@ -59,39 +55,77 @@ class Zigbee2mqtt extends core.Adapter {
 
 		const debugDevicesState = await this.getStateAsync('info.debugmessages');
 		if (debugDevicesState && debugDevicesState.val) {
-			debugDevices = String(debugDevicesState.val);
+			logCustomizations.debugDevices = String(debugDevicesState.val);
 		}
 
 		const logfilterState = await this.getStateAsync('info.logfilter');
 		if (logfilterState && logfilterState.val) {
-			logfilter = String(logfilterState.val).split(';').filter(x => x); // filter removes empty strings here
+			// @ts-ignore
+			logCustomizations.logfilter = String(logfilterState.val).split(';').filter(x => x); // filter removes empty strings here
 		}
+		// MQTT
+		if (['exmqtt', 'intmqtt'].includes(this.config.connectionType)) {
+			// External MQTT-Server
+			if (this.config.connectionType == 'exmqtt') {
+				if (this.config.externalMqttServerIP == '') {
+					this.log.warn('Please configure the External MQTT-Server connection!');
+					return;
+				}
+				mqttClient = mqtt.connect(`mqtt://${this.config.externalMqttServerIP}:${this.config.externalMqttServerPort}`, { clientId: `ioBroker.zigbee2mqtt_${Math.random().toString(16).slice(2, 8)}`, clean: true, reconnectPeriod: 500 });
+
+			}
+			// Internal MQTT-Server
+			else {
+				mqttServerController = new MqttServerController(this);
+				await mqttServerController.createMQTTServer();
+				await this.delay(1500);
+				mqttClient = mqtt.connect(`mqtt://${this.config.mqttServerIPBind}:${this.config.mqttServerPort}`, { clientId: `ioBroker.zigbee2mqtt_${Math.random().toString(16).slice(2, 8)}`, clean: true, reconnectPeriod: 500 });
+			}
 
-		if (this.config.useExternalMqtt == true) {
-			mqttClient = mqtt.connect(`mqtt://${this.config.externalMqttServerIP}:${this.config.externalMqttServerPort}`, { clientId: `ioBroker.zigbee2mqtt_${Math.random().toString(16).slice(2, 8)}`, clean: true, reconnectPeriod: 500 });
-		} else {
-			const Aedes = require('aedes');
-			const net = require('net');
-			const db = new NedbPersistence({
-				path: `${core.getAbsoluteInstanceDataDir(this)}/mqttData`,
-				prefix: ''
+			// MQTT Client
+			mqttClient.on('connect', () => {
+				this.log.info(`Connect to Zigbee2MQTT over ${this.config.connectionType == 'exmqtt' ? 'external mqtt' : 'internal mqtt'} connection.`);
+			});
+
+			mqttClient.subscribe('zigbee2mqtt/#');
+
+			mqttClient.on('message', (topic, payload) => {
+				const newMessage = `{"payload":${payload.toString() == '' ? '"null"' : payload.toString()},"topic":"${topic.slice(topic.search('/') + 1)}"}`;
+				this.messageParse(newMessage);
 			});
-			// @ts-ignore
-			const aedes = Aedes({ persistence: db });
-			const mqttServer = net.createServer(aedes.handle);
-			mqttServer.listen(this.config.mqttServerPort, this.config.mqttServerIPBind, () => { });
-			mqttClient = mqtt.connect(`mqtt://${this.config.mqttServerIPBind}:${this.config.mqttServerPort}`, { clientId: 'ioBroker.zigbee2mqtt', clean: true, reconnectPeriod: 500 });
 		}
+		// Websocket
+		else if (this.config.connectionType == 'ws') {
+			if (this.config.wsServerIP == '') {
+				this.log.warn('Please configure the Websoket connection!');
+				return;
+			}
 
-		mqttClient.on('connect', () => { this.setStateAsync('info.connection', true, true); });
-		mqttClient.subscribe('#');
-		mqttClient.on('message', (topic, payload) => {
-			const newMessage = `{"payload":${payload.toString() == '' ? '"null"' : payload.toString()},"topic":"${topic.slice(topic.search('/') + 1)}"}`;
-			console.log(newMessage);
-			this.messageParse(newMessage);
-		});
-	}
+			// Dummy MQTT-Server
+			if (this.config.dummyMqtt == true) {
+				mqttServerController = new MqttServerController(this);
+				await mqttServerController.createDummyMQTTServer();
+				await this.delay(1500);
+			}
+
+			websocketController = new WebsocketController(this);
+			const wsClient = await websocketController.initWsClient(this.config.wsServerIP, this.config.wsServerPort);
+
+			wsClient.on('open', () => {
+				this.log.info('Connect to Zigbee2MQTT over websocket connection.');
+			});
+
+			wsClient.on('message', (message) => {
+				this.messageParse(message);
+			});
 
+			wsClient.on('clo', async () => {
+				this.setStateChangedAsync('info.connection', false, true);
+				await statesController.setAllAvailableToFalse();
+				this.log.warn('Websocket disconnectet');
+			});
+		}
+	}
 
 	async messageParse(message) {
 		const messageObj = JSON.parse(message);
@@ -107,6 +141,10 @@ class Zigbee2mqtt extends core.Adapter {
 				}
 				break;
 			case 'bridge/state':
+				if (messageObj.payload.state != 'online') {
+					statesController.setAllAvailableToFalse();
+				}
+				this.setStateChangedAsync('info.connection', messageObj.payload.state == 'online', true);
 				break;
 			case 'bridge/devices':
 				await deviceController.createDeviceDefinitions(messageObj.payload);
@@ -174,10 +212,8 @@ class Zigbee2mqtt extends core.Adapter {
 	async onUnload(callback) {
 		try {
 			await statesController.setAllAvailableToFalse();
-			clearTimeout(ping);
-			clearTimeout(pingTimeout);
-			clearTimeout(autoRestartTimeout);
-			clearTimeout(checkAvailableTimout);
+			await websocketController.allTimerClear();
+			await statesController.allTimerClear();
 			callback();
 		} catch (e) {
 			callback();
@@ -187,18 +223,23 @@ class Zigbee2mqtt extends core.Adapter {
 	async onStateChange(id, state) {
 		if (state && state.ack == false) {
 			if (id.includes('info.debugmessages')) {
-				debugDevices = state.val;
+				logCustomizations.debugDevices = state.val;
 				this.setState(id, state.val, true);
 				return;
 			}
 			if (id.includes('info.logfilter')) {
-				logfilter = state.val.split(';').filter(x => x); // filter removes empty strings here
+				logCustomizations.logfilter = state.val.split(';').filter(x => x); // filter removes empty strings here
 				this.setState(id, state.val, true);
 				return;
 			}
 
 			const message = await z2mController.createZ2MMessage(id, state) || { topic: '', payload: '' };
-			mqttClient.publish('zigbee2mqtt/' + message.topic, JSON.stringify(message.payload));
+
+			if (['exmqtt', 'intmqtt'].includes(this.config.connectionType)) {
+				mqttClient.publish(`zigbee2mqtt/${message.topic}`, JSON.stringify(message.payload));
+			} else if (this.config.connectionType == 'ws') {
+				websocketController.send(JSON.stringify(message));
+			}
 		}
 	}
 }
@@ -213,4 +254,4 @@ if (require.main !== module) {
 } else {
 	// otherwise start the instance directly
 	new Zigbee2mqtt();
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee2mqtt",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "Zigbee2MQTT adapter for ioBroker",
   "author": {
     "name": "Dennis Rathjen",
@@ -19,8 +19,6 @@
     "url": "https://github.com/o0shojo0o/ioBroker.zigbee2mqtt.git"
   },
   "dependencies": {
-    "@alcalzone/release-script-plugin-iobroker": "^3.5.9",
-    "@alcalzone/release-script-plugin-license": "^3.5.9",
     "@iobroker/adapter-core": "^2.6.7",
     "aedes": "^0.48.0",
     "aedes-persistence-nedb": "^2.0.3",
@@ -29,6 +27,8 @@
     "ws": "^8.9.0"
   },
   "devDependencies": {
+    "@alcalzone/release-script-plugin-iobroker": "^3.5.9",
+    "@alcalzone/release-script-plugin-license": "^3.5.9",
     "@alcalzone/release-script": "^3.5.9",
     "@iobroker/adapter-dev": "^1.1.0",
     "@iobroker/testing": "^4.1.0",