iobroker.zigbee2mqtt 0.1.0 → 0.2.0

package/main.js

@@ -14,24 +14,24 @@ const clearArray = require('./lib/utils').clearArray;
 let wsClient;
 let adapter;
 let createDevicesOrReady = false;
+let isConnected = false;
 const incStatsQueue = [];
 const createCache = {};
 // eslint-disable-next-line prefer-const
 let deviceCache = [];
 // eslint-disable-next-line prefer-const
 let groupCache = [];
-const lastSeenCache = {};
 let ping;
 let pingTimeout;
 let autoRestartTimeout;
 const wsHeartbeatIntervall = 5000;
 const restartTimeout = 1000;
-const deviceAvailableTimeout = 10 * 60; // 10 Minutes
-const batteryDeviceAvailableTimeout = 24 * 60 * 60; // 24 Hours
-const checkAvailableInterval = 30 * 1000; // 10 Seconds
 let debugLogEnabled;
 let proxyZ2MLogsEnabled;
 let checkAvailableTimout;
+let debugDevices = '';
+let logfilter = [];
+let useKelvin = false;
 
 class Zigbee2mqtt extends core.Adapter {
 
@@ -52,12 +52,27 @@ class Zigbee2mqtt extends core.Adapter {
 		this.log.info(`Zigbee2MQTT Frontend Port: ${this.config.port}`);
 		this.log.info(`Zigbee2MQTT Debug Log: ${this.config.debugLogEnabled ? 'activated' : 'deactivated'}`);
 		this.log.info(`Proxy Zigbee2MQTT Logs to ioBroker Logs: ${this.config.proxyZ2MLogs ? 'activated' : 'deactivated'}`);
+		this.log.info(`Use Kelvin: ${this.config.useKelvin ? 'yes' : 'no'}`);
 
 		this.setStateAsync('info.connection', false, true);
 		this.createWsClient(this.config.server, this.config.port);
 
 		debugLogEnabled = this.config.debugLogEnabled;
 		proxyZ2MLogsEnabled = this.config.proxyZ2MLogs;
+		useKelvin = this.config.useKelvin;
+
+		const debugDevicesState = await this.getStateAsync('info.debugmessages');
+		if (debugDevicesState && debugDevicesState.val) {
+			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
+		}
+
+
+		this.subscribeStatesAsync('*');
 	}
 
 	async createWsClient(server, port) {
@@ -68,23 +83,24 @@ class Zigbee2mqtt extends core.Adapter {
 				// Set connection state
 				this.setState('info.connection', true, true);
 				this.log.info('Connect to server over websocket connection.');
+				isConnected = true;
 				// Send ping to server
 				this.sendPingToServer();
 				// Start Heartbeat
 				this.wsHeartbeat();
-				// Start CheckAvailableTimer
-				this.checkAvailableTimer();
 			});
 			wsClient.on('pong', () => {
 				//this.logDebug('Receive pong from server');
 				this.wsHeartbeat();
 			});
 			// On Close
-			wsClient.on('close', () => {
+			wsClient.on('close', async () => {
 				this.setState('info.connection', false, true);
 				this.log.warn('Websocket disconnectet');
+				await this.setAllAvailableToFalse();
 				clearTimeout(ping);
 				clearTimeout(pingTimeout);
+				isConnected = false;
 
 				if (wsClient.readyState === WebSocket.CLOSED) {
 					this.autoRestart();
@@ -137,6 +153,7 @@ class Zigbee2mqtt extends core.Adapter {
 				createDevicesOrReady = false;
 				await this.createDeviceDefinitions(deviceCache, messageObj.payload);
 				await this.createOrUpdateDevices(deviceCache);
+				this.subscribeWritableStates();
 				createDevicesOrReady = true;
 
 				// Now process all entries in the states queue
@@ -147,6 +164,7 @@ class Zigbee2mqtt extends core.Adapter {
 			case 'bridge/groups':
 				await this.createGroupDefinitions(groupCache, messageObj.payload);
 				await this.createOrUpdateDevices(groupCache);
+				this.subscribeWritableStates();
 				break;
 			case 'bridge/event':
 				break;
@@ -166,9 +184,24 @@ class Zigbee2mqtt extends core.Adapter {
 			case 'bridge/response/touchlink/factory_reset':
 				break;
 			default:
-				// States
 				{
-					if (!messageObj.topic.includes('/')) {
+					// {"payload":{"state":"online"},"topic":"FL.Licht.Links/availability"}  ---->  {"payload":{"available":true},"topic":"FL.Licht.Links"}
+					if (messageObj.topic.endsWith('/availability')) {
+						const topicSplit = messageObj.topic.split('/');
+						if (topicSplit.length == 2 && messageObj.payload && messageObj.payload.state) {
+							const newMessage = {
+								payload: { available: messageObj.payload.state == 'online' },
+								topic: topicSplit[0]
+							};
+							// As long as we are busy creating the devices, the states are written to the queue.
+							if (createDevicesOrReady == false) {
+								incStatsQueue[incStatsQueue.length] = newMessage;
+								break;
+							}
+							this.processDeviceMessage(newMessage);
+						}
+						// States
+					} else if (!messageObj.topic.includes('/')) {
 						// As long as we are busy creating the devices, the states are written to the queue.
 						if (createDevicesOrReady == false) {
 							incStatsQueue[incStatsQueue.length] = messageObj;
@@ -188,18 +221,11 @@ class Zigbee2mqtt extends core.Adapter {
 			return;
 		}
 
-		const device = deviceCache.find(x => x.id == messageObj.topic);
+		const device = groupCache.concat(deviceCache).find(x => x.id == messageObj.topic);
 		if (device) {
 			this.logDebug(`processDeviceMessage -> device: ${JSON.stringify(device)}`);
 			try {
-				// The state available must not be considered for the cacheLastSeen
-				// Groups must not be considered for the cacheLastSeen
-				if (messageObj.payload.available == undefined && !device.ieee_address.startsWith('group_')) {
-					await this.cacheLastSeen(device, messageObj);
-				}
 				this.setDeviceState(messageObj, device);
-				this.checkAvailable(device.ieee_address);
-
 			} catch (error) {
 				adapter.log.error(error);
 			}
@@ -209,64 +235,11 @@ class Zigbee2mqtt extends core.Adapter {
 		}
 	}
 
-	async cacheLastSeen(device, messageObj) {
-		this.logDebug(`cacheLastSeen -> device: ${JSON.stringify(device)}`);
-		this.logDebug(`cacheLastSeen -> messageObj: ${JSON.stringify(messageObj)}`);
-		if (messageObj.payload.last_seen) {
-			lastSeenCache[device.ieee_address] = new Date(messageObj.payload.last_seen).getTime();
-		} else {
-			lastSeenCache[device.ieee_address] = new Date().getTime();
-		}
-		this.logDebug(`cacheLastSeen -> deviceLastSeenCache: ${JSON.stringify(lastSeenCache)}`);
-	}
-
-	async checkAvailableTimer() {
-		checkAvailableTimout = setTimeout(async () => {
-			await this.checkAvailable(null);
-			this.checkAvailableTimer();
-		}, checkAvailableInterval);
-	}
-
-	async checkAvailable(ieee_address) {
-		this.logDebug(`checkAvailable -> ieee_address: ${ieee_address}`);
-		let checkList = {};
-		if (ieee_address) {
-			checkList[ieee_address] = null;
-		}
-		else {
-			checkList = lastSeenCache;
-		}
-
-		for (const ieee_address in checkList) {
-			const device = deviceCache.find(x => x.ieee_address == ieee_address);
-
-			if (!device) {
-				continue;
-			}
-
-			const isBatteryDevice = device.power_source == 'Battery' ? true : false;
-			const offlineTimeout = isBatteryDevice ? batteryDeviceAvailableTimeout : deviceAvailableTimeout;
-			const diffSec = Math.round((new Date().getTime() - lastSeenCache[ieee_address]) / 1000);
-			const available = diffSec < offlineTimeout;
-
-			this.logDebug(`checkAvailable -> device.id: ${device.id}, available: ${available}, diffSec: ${diffSec}, isBatteryDevice: ${isBatteryDevice}`);
-
-			if (device.available == null || device.available != available) {
-				this.logDebug(`checkAvailable -> device.id: ${device.id}, available: ${available}, diffSec: ${diffSec}, isBatteryDevice: ${isBatteryDevice}`);
-				device.available = available;
-				const messageObj = {
-					topic: device.id,
-					payload: {
-						available: available,
-					}
-				};
+	async setDeviceState(messageObj, device) {
 
-				this.processDeviceMessage(messageObj);
-			}
+		if (debugDevices.includes(device.ieee_address)) {
+			this.log.warn(`--->>> fromZ2M -> ${device.ieee_address} states: ${JSON.stringify(messageObj)}`);
 		}
-	}
-
-	async setDeviceState(messageObj, device) {
 
 		for (const [key, value] of Object.entries(messageObj.payload)) {
 			this.logDebug(`setDeviceState -> key: ${key}`);
@@ -284,13 +257,18 @@ class Zigbee2mqtt extends core.Adapter {
 				if (!state) {
 					continue;
 				}
+
 				const stateName = `${device.ieee_address}.${state.id}`;
 
-				if (state.getter) {
-					this.setState(stateName, state.getter(messageObj.payload), true);
-				}
-				else {
-					this.setState(stateName, value, true);
+				try {
+					if (state.getter) {
+						await this.setStateAsync(stateName, state.getter(messageObj.payload), true);
+					}
+					else {
+						await this.setStateAsync(stateName, value, true);
+					}
+				} catch (err) {
+					this.log.warn(`Can not set ${stateName}`);
 				}
 			}
 		}
@@ -300,7 +278,15 @@ class Zigbee2mqtt extends core.Adapter {
 		clearArray(cache);
 		for (const expose of exposes) {
 			if (expose.definition != null) {
-				await defineDeviceFromExposes(cache, expose.friendly_name, expose.ieee_address, expose.definition, expose.power_source);
+				// search for scenes in the endpoints and build them into an array
+				let scenes = [];
+				for (const key in expose.endpoints) {
+					if (expose.endpoints[key].scenes) {
+						scenes = scenes.concat(expose.endpoints[key].scenes);
+					}
+				}
+
+				await defineDeviceFromExposes(cache, expose.friendly_name, expose.ieee_address, expose.definition, expose.power_source, scenes, useKelvin);
 			}
 		}
 	}
@@ -308,7 +294,7 @@ class Zigbee2mqtt extends core.Adapter {
 	async createGroupDefinitions(cache, exposes) {
 		clearArray(cache);
 		for (const expose of exposes) {
-			await defineGroupDevice(cache, expose.friendly_name, `group_${expose.id}`, expose.scenes);
+			await defineGroupDevice(cache, expose.friendly_name, `group_${expose.id}`, expose.scenes, useKelvin);
 		}
 	}
 
@@ -320,28 +306,30 @@ class Zigbee2mqtt extends core.Adapter {
 					type: 'device',
 					common: {
 						name: deviceName,
-						statusStates: {
-							onlineId: `${this.name}.${this.instance}.${device.ieee_address}.available`
-						},
 					},
 
 					native: {}
 				};
+
+				if (!device.ieee_address.includes('group_')) {
+					deviceObj.common.statusStates = {
+						onlineId: `${this.name}.${this.instance}.${device.ieee_address}.available`
+					};
+				}
+
 				//@ts-ignore
 				await this.extendObjectAsync(device.ieee_address, deviceObj);
 				createCache[device.ieee_address] = deviceObj;
 			}
 
-			// Special handling for groups, here it is checked whether the scenes match the current data from z2m.
+			// Here it is checked whether the scenes match the current data from z2m.
 			// If necessary, scenes are automatically deleted from ioBroker.
-			if (device.ieee_address.startsWith('group_')) {
-				const sceneStates = await this.getStatesAsync(`${device.ieee_address}.scene_*`);
-				const sceneIDs = Object.keys(sceneStates);
-				for (const sceneID of sceneIDs) {
-					const stateID = sceneID.split('.')[3];
-					if (device.states.find(x => x.id == stateID) == null) {
-						this.delObject(sceneID);
-					}
+			const sceneStates = await this.getStatesAsync(`${device.ieee_address}.scene_*`);
+			const sceneIDs = Object.keys(sceneStates);
+			for (const sceneID of sceneIDs) {
+				const stateID = sceneID.split('.')[3];
+				if (device.states.find(x => x.id == stateID) == null) {
+					this.delObject(sceneID);
 				}
 			}
 
@@ -351,8 +339,6 @@ class Zigbee2mqtt extends core.Adapter {
 					this.logDebug(`Orig. state: ${JSON.stringify(state)}`);
 					this.logDebug(`Cleaned. state: ${JSON.stringify(iobState)}`);
 
-
-
 					await this.extendObjectAsync(`${device.ieee_address}.${state.id}`, {
 						type: 'state',
 						common: iobState,
@@ -362,7 +348,6 @@ class Zigbee2mqtt extends core.Adapter {
 				}
 			}
 		}
-		this.subscribeWritableStates();
 	}
 
 	async copyAndCleanStateObj(state) {
@@ -385,7 +370,8 @@ class Zigbee2mqtt extends core.Adapter {
 
 	async subscribeWritableStates() {
 		await this.unsubscribeObjectsAsync('*');
-		for (const device of deviceCache) {
+
+		for (const device of groupCache.concat(deviceCache)) {
 			for (const state of device.states) {
 				if (state.write == true) {
 					this.subscribeStatesAsync(`${device.ieee_address}.${state.id}`);
@@ -406,7 +392,7 @@ class Zigbee2mqtt extends core.Adapter {
 		const ieee_address = splitedID[2];
 		const stateName = splitedID[3];
 
-		const device = deviceCache.find(d => d.ieee_address == ieee_address);
+		const device = groupCache.concat(deviceCache).find(d => d.ieee_address == ieee_address);
 
 		if (!device) {
 			return;
@@ -440,8 +426,8 @@ class Zigbee2mqtt extends core.Adapter {
 			},
 			topic: topic
 		};
-		// set stats with role 'button' always immediately to ack = true, because these are not reported back by Zigbee2MQTT
-		if (deviceState.role == 'button') {
+		// set stats with the mentioned role or ids always immediately to ack = true, because these are not reported back by Zigbee2MQTT
+		if (isConnected == true && (['button'].includes(deviceState.role) || ['brightness_move', 'color_temp_move'].includes(stateID))) {
 			this.setState(id, state, true);
 		}
 
@@ -451,9 +437,12 @@ class Zigbee2mqtt extends core.Adapter {
 	async proxyZ2MLogs(messageObj) {
 		this.logDebug(`proxyZ2MLogs -> messageObj: ${JSON.stringify(messageObj)}`);
 
-		const logLevel = messageObj.payload.level;
 		const logMessage = messageObj.payload.message;
+		if (logfilter.some(x => logMessage.includes(x))) {
+			return;
+		}
 
+		const logLevel = messageObj.payload.level;
 		switch (logLevel) {
 			case 'debug':
 			case 'info':
@@ -472,8 +461,19 @@ class Zigbee2mqtt extends core.Adapter {
 		}
 	}
 
-	onUnload(callback) {
+	async setAllAvailableToFalse() {
+		for (const device of deviceCache) {
+			for (const state of device.states) {
+				if (state.id == 'available') {
+					await this.setStateAsync(`${device.ieee_address}.${state.id}`, false, true);
+				}
+			}
+		}
+	}
+
+	async onUnload(callback) {
 		try {
+			await this.setAllAvailableToFalse();
 			clearTimeout(ping);
 			clearTimeout(pingTimeout);
 			clearTimeout(autoRestartTimeout);
@@ -488,10 +488,20 @@ class Zigbee2mqtt extends core.Adapter {
 		if (state && state.ack == false) {
 			const message = await this.createZ2MMessage(id, state);
 			wsClient.send(message);
+
+			if (id.includes('info.debugmessages')) {
+				debugDevices = state.val;
+				this.setState(id, state.val, true);
+			}
+			if (id.includes('info.logfilter')) {
+				logfilter = state.val.split(';').filter(x => x); // filter removes empty strings here
+				this.setState(id, state.val, true);
+			}
 		}
 	}
 }
 
+
 if (require.main !== module) {
 	// Export the constructor in compact mode
 	/**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee2mqtt",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Zigbee2MQTT adapter for ioBroker",
   "author": {
     "name": "Dennis Rathjen",