iobroker.zigbee2mqtt 0.2.0 → 2.1.0

package/lib/rgb.js

@@ -73,14 +73,12 @@ function cie_to_rgb(x, y, brightness) {
 		green = green / red;
 		blue = blue / red;
 		red = 1.0;
-	}
-	else if (green > blue && green > red && green > 1.0) {
+	} else if (green > blue && green > red && green > 1.0) {
 
 		red = red / green;
 		blue = blue / green;
 		green = 1.0;
-	}
-	else if (blue > red && blue > green && blue > 1.0) {
+	} else if (blue > red && blue > green && blue > 1.0) {
 
 		red = red / blue;
 		green = green / blue;
@@ -157,7 +155,9 @@ function hsvToRGB(h, s, v) {
 	s = s / 100;
 	v = v / 100;
 
-	let r; let g; let b;
+	let r;
+	let g;
+	let b;
 	if (arguments.length === 1) {
 		s = h.s, v = h.v, h = h.h;
 	}
@@ -167,12 +167,24 @@ function hsvToRGB(h, s, v) {
 	const q = v * (1 - f * s);
 	const t = v * (1 - (1 - f) * s);
 	switch (i % 6) {
-		case 0: r = v, g = t, b = p; break;
-		case 1: r = q, g = v, b = p; break;
-		case 2: r = p, g = v, b = t; break;
-		case 3: r = p, g = q, b = v; break;
-		case 4: r = t, g = p, b = v; break;
-		case 5: r = v, g = p, b = q; break;
+		case 0:
+			r = v, g = t, b = p;
+			break;
+		case 1:
+			r = q, g = v, b = p;
+			break;
+		case 2:
+			r = p, g = v, b = t;
+			break;
+		case 3:
+			r = p, g = q, b = v;
+			break;
+		case 4:
+			r = t, g = p, b = v;
+			break;
+		case 5:
+			r = v, g = p, b = q;
+			break;
 	}
 	return {
 		r: Math.round(r * 255),
@@ -185,17 +197,29 @@ function rgbToHSV(r, g, b, numeric) {
 	if (arguments.length === 1) {
 		g = r.g, b = r.b, r = r.r;
 	}
-	const max = Math.max(r, g, b); const min = Math.min(r, g, b);
+	const max = Math.max(r, g, b);
+	const min = Math.min(r, g, b);
 	const d = max - min;
 	let h;
 	const s = (max === 0 ? 0 : d / max);
 	const v = max / 255;
 
 	switch (max) {
-		case min: h = 0; break;
-		case r: h = (g - b) + d * (g < b ? 6 : 0); h /= 6 * d; break;
-		case g: h = (b - r) + d * 2; h /= 6 * d; break;
-		case b: h = (r - g) + d * 4; h /= 6 * d; break;
+		case min:
+			h = 0;
+			break;
+		case r:
+			h = (g - b) + d * (g < b ? 6 : 0);
+			h /= 6 * d;
+			break;
+		case g:
+			h = (b - r) + d * 2;
+			h /= 6 * d;
+			break;
+		case b:
+			h = (r - g) + d * 4;
+			h /= 6 * d;
+			break;
 	}
 	if (numeric) return {
 		// @ts-ignore
@@ -210,6 +234,7 @@ function rgbToHSV(r, g, b, numeric) {
 		v: (v * 100).toFixed(3),
 	};
 }
+
 function colorArrayFromString(value) {
 	if (typeof (value) === 'string') {
 		const rv = [];
@@ -260,4 +285,4 @@ exports.hsvToRGB = hsvToRGB;
 exports.rgbToHSV = rgbToHSV;
 exports.colorArrayFromString = colorArrayFromString;
 exports.colorStringFromRGBArray = colorStringFromRGBArray;
-exports.hsvToRGBString = hsvToRGBString;
+exports.hsvToRGBString = hsvToRGBString;

package/lib/states.js

@@ -274,17 +274,16 @@ const states = {
 	},
 	voltage: {
 		id: 'voltage',
-		name: 'Battery voltage',
+		name: 'Voltage',
 		icon: undefined,
-		role: 'battery.voltage',
+		role: 'value.voltage',
 		write: false,
 		read: true,
 		type: 'number',
 		unit: 'V',
-		getter: payload => payload.voltage / 1000,
 		def: 0,
 	},
-	ecozy_voltage: {
+	battery_voltage: {
 		id: 'voltage',
 		name: 'Battery voltage',
 		icon: undefined,
@@ -293,9 +292,18 @@ const states = {
 		read: true,
 		type: 'number',
 		unit: 'V',
-		getter: payload => payload.voltage * 10,
 		def: 0,
 	},
+	energy: {
+		id: 'energy',
+		name: 'Sum of consumed energy',
+		icon: undefined,
+		role: 'value.power.consumption',
+		write: false,
+		read: true,
+		type: 'number',
+		unit: 'kWh'
+	},
 	battery: {
 		id: 'battery',
 		prop: 'battery',
@@ -546,6 +554,17 @@ const states = {
 		type: 'boolean',
 		getter: payload => (payload.button_right === 'hold'),
 	},
+	device_temperature: {
+		id: 'device_temperature',
+		name: 'Temperature of the device',
+		icon: undefined,
+		role: 'value.temperature',
+		write: false,
+		read: true,
+		type: 'number',
+		unit: '°C',
+		def: 0,
+	},
 	temperature: {
 		id: 'temperature',
 		name: 'Temperature',
@@ -736,7 +755,7 @@ const states = {
 		type: 'boolean',
 		def: false,
 	},
-	smoke_detected2: {   // for Heiman
+	smoke_detected2: { // for Heiman
 		id: 'smoke',
 		prop: 'smoke',
 		name: 'Smoke leak detected',
@@ -747,7 +766,7 @@ const states = {
 		type: 'boolean',
 		def: false,
 	},
-	co_detected: {   // for Heiman
+	co_detected: { // for Heiman
 		id: 'carbon_monoxide',
 		prop: 'carbon_monoxide',
 		name: 'CO leak detected',
@@ -1074,11 +1093,11 @@ const states = {
 		unit: 'V'
 	},
 	load_current: {
-		id: 'current',
+		id: 'load_current',
 		prop: 'current',
 		name: 'Load current',
 		icon: undefined,
-		role: 'value',
+		role: 'value.current',
 		write: false,
 		read: true,
 		type: 'number',
@@ -1232,12 +1251,15 @@ const states = {
 				y: xy[1]
 			};
 		},
-		setterOpt: (value, options) => {
-			const hasTransitionTime = options && options.hasOwnProperty('transition_time');
-			const transitionTime = hasTransitionTime ? options.transition_time : 0;
-			return { ...options, transition: transitionTime };
-		},
+		// setterOpt: (value, options) => {
+		// 	const hasTransitionTime = options && options.hasOwnProperty('transition_time');
+		// 	const transitionTime = hasTransitionTime ? options.transition_time : 0;
+		// 	return { ...options, transition: transitionTime };
+		// },
 		getter: payload => {
+			if (payload.color_mode != 'xy') {
+				return undefined;
+			}
 			if (payload.color && payload.color.hasOwnProperty('x') && payload.color.hasOwnProperty('y')) {
 				const colorval = rgb.cie_to_rgb(payload.color.x, payload.color.y);
 				return '#' + utils.decimalToHex(colorval[0]) + utils.decimalToHex(colorval[1]) + utils.decimalToHex(colorval[2]);
@@ -2625,8 +2647,7 @@ const states = {
 		max: 1,
 		type: 'number',
 	},
-	thermostat_keypad_lockout:
-	{
+	thermostat_keypad_lockout: {
 		id: 'keypad_lockout',
 		name: 'Keypad Lockout',
 		prop: 'keypad_lockout',
@@ -5447,6 +5468,7 @@ const states = {
 		write: false,
 		read: true,
 		type: 'boolean',
+		def: false,
 		isEvent: true,
 		getter: payload => (payload.action === 'brightness_move_up') ? true : undefined,
 	},
@@ -5471,6 +5493,7 @@ const states = {
 		write: false,
 		read: true,
 		type: 'boolean',
+		def: false,
 		isEvent: true,
 		getter: payload => (payload.action === 'brightness_move_down') ? true : undefined,
 	},
@@ -5842,8 +5865,7 @@ const states = {
 		setter: (value, options) => {
 			try {
 				return JSON.parse(value);
-			}
-			catch (err) {
+			} catch (err) {
 				const effectjson = {
 					colors: [{ r: 255, g: 0, b: 0 }, { r: 0, g: 255, b: 0 }, { r: 0, g: 0, b: 255 }],
 					speed: 10,
@@ -6417,4 +6439,4 @@ module.exports = {
 	states: states,
 	unitLookup: unitLookup,
 	nameLookup: nameLookup,
-};
+};

package/lib/statesController.js

@@ -0,0 +1,138 @@
+const utils = require('./utils');
+const incStatsQueue = [];
+const timeOutCache = {};
+
+class StatesController {
+	constructor(adapter, deviceCache, groupCache, logCustomizations) {
+		this.adapter = adapter;
+		this.groupCache = groupCache;
+		this.deviceCache = deviceCache;
+		this.logCustomizations = logCustomizations;
+	}
+
+	async processDeviceMessage(messageObj) {
+		// Is payload present?
+		if (messageObj.payload == '') {
+			return;
+		}
+
+		const device = this.groupCache.concat(this.deviceCache).find(x => x.id == messageObj.topic);
+		if (device) {
+			try {
+				this.setDeviceState(messageObj, device);
+			} catch (error) {
+				this.adapter.log.error(error);
+			}
+		} else {
+			incStatsQueue[incStatsQueue.length] = messageObj;
+			this.adapter.log.debug(`Device: ${messageObj.topic} not found, queue state in incStatsQueue!`);
+		}
+	}
+
+	async setDeviceState(messageObj, device) {
+		if (this.logCustomizations.debugDevices.includes(device.ieee_address)) {
+			this.adapter.log.warn(`--->>> fromZ2M -> ${device.ieee_address} states: ${JSON.stringify(messageObj)}`);
+		}
+
+		for (const [key, value] of Object.entries(messageObj.payload)) {
+			let states;
+			if (key == 'action') {
+				states = device.states.filter(x => (x.prop && x.prop == key));
+			} else {
+				states = device.states.filter(x => (x.prop && x.prop == key) || x.id == key);
+			}
+
+			for (const state of states) {
+				if (!state) {
+					continue;
+				}
+
+				const stateName = `${device.ieee_address}.${state.id}`;
+
+				try {
+					if (state.isEvent) {
+						if (state.getter) {
+							await this.setStateWithTimeoutAsync(stateName, state.getter(messageObj.payload), 300);
+						} else {
+							await this.setStateWithTimeoutAsync(stateName, value, 300);
+						}
+					} else {
+						if (state.getter) {
+							await this.setStateChangedAsync(stateName, state.getter(messageObj.payload));
+						} else {
+							await this.setStateChangedAsync(stateName, value);
+						}
+					}
+				} catch (err) {
+					incStatsQueue[incStatsQueue.length] = messageObj;
+					this.adapter.log.debug(`Can not set ${stateName}, queue state in incStatsQueue!`);
+				}
+			}
+		}
+	}
+
+	async setStateAsync(stateName, value) {
+		if (value !== undefined) {
+			await this.adapter.setStateAsync(stateName, value, true);
+		}
+	}
+
+	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);
+			if (timeOutCache[stateName]) {
+				clearTimeout(timeOutCache[stateName]);
+			}
+			timeOutCache[stateName] = setTimeout(() => {
+				this.adapter.setStateAsync(stateName, !value, true);
+			}, timeout);
+		}
+	}
+
+	async processQueue() {
+		const oldIncStatsQueue = [];
+		utils.moveArray(incStatsQueue, oldIncStatsQueue);
+		while (oldIncStatsQueue.length > 0) {
+			this.processDeviceMessage(oldIncStatsQueue.shift());
+		}
+	}
+
+	async subscribeWritableStates() {
+		await this.adapter.unsubscribeObjectsAsync('*');
+		for (const device of this.groupCache.concat(this.deviceCache)) {
+			for (const state of device.states) {
+				if (state.write == true) {
+					this.adapter.subscribeStatesAsync(`${device.ieee_address}.${state.id}`);
+				}
+			}
+		}
+		this.adapter.subscribeStatesAsync('info.debugmessages');
+		this.adapter.subscribeStatesAsync('info.logfilter');
+	}
+
+	async setAllAvailableToFalse() {
+		for (const device of this.deviceCache) {
+			for (const state of device.states) {
+				if (state.id == 'available') {
+					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,26 +106,28 @@ 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();
 	}
 }
 
-exports.bulbLevelToAdapterLevel = bulbLevelToAdapterLevel;
-exports.adapterLevelToBulbLevel = adapterLevelToBulbLevel;
-exports.bytesArrayToWordArray = bytesArrayToWordArray;
-exports.toMired = toMired;
-exports.miredKelvinConversion = miredKelvinConversion;
-exports.decimalToHex = decimalToHex;
-exports.getZbId = getZbId;
-exports.getAdId = getAdId;
-exports.removeDeviceByIeee = removeDeviceByIeee;
-exports.getDeviceIcon = getDeviceIcon;
-exports.clearArray = clearArray;
+function moveArray(source, target) {
+	while (source.length > 0) {
+		target.push(source.shift());
+	}
+}
+
+module.exports = {
+	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

@@ -0,0 +1,80 @@
+class Z2mController {
+	constructor(adapter, deviceCache, groupCache, logCustomizations) {
+		this.adapter = adapter;
+		this.groupCache = groupCache;
+		this.deviceCache = deviceCache;
+		this.logCustomizations = logCustomizations;
+	}
+
+	async createZ2MMessage(id, state) {
+		const splitedID = id.split('.');
+		if (splitedID.length < 4) {
+			this.adapter.log.warn(`state ${id} not valid`);
+			return;
+		}
+
+		const ieee_address = splitedID[2];
+		const stateName = splitedID[3];
+
+		const device = this.groupCache.concat(this.deviceCache).find(d => d.ieee_address == ieee_address);
+		if (!device) {
+			return;
+		}
+
+		const deviceState = device.states.find(s => s.id == stateName);
+		if (!deviceState) {
+			return;
+		}
+
+		let stateVal = state.val;
+		if (deviceState.setter) {
+			stateVal = deviceState.setter(state.val);
+		}
+
+		let stateID = deviceState.id;
+		if (deviceState.prop) {
+			stateID = deviceState.prop;
+		}
+
+		let topic = `${device.ieee_address}/set`;
+		if (device.ieee_address.includes('group_')) {
+			topic = `${device.id}/set`;
+		}
+
+		const controlObj = {
+			payload: {
+				[stateID]: stateVal
+			},
+			topic: topic
+		};
+		// set stats with the mentioned role or ids always immediately to ack = true, because these are not reported back by Zigbee2MQTT
+		if (['button'].includes(deviceState.role) || ['brightness_move', 'color_temp_move'].includes(stateID)) {
+			this.adapter.setState(id, state, true);
+		}
+
+		return controlObj;
+	}
+
+	async proxyZ2MLogs(messageObj) {
+		const logMessage = messageObj.payload.message;
+		if (this.logCustomizations.logfilter.some(x => logMessage.includes(x))) {
+			return;
+		}
+
+		const logLevel = messageObj.payload.level;
+		switch (logLevel) {
+			case 'debug':
+			case 'info':
+			case 'error':
+				this.adapter.log[logLevel](logMessage);
+				break;
+			case 'warning':
+				this.adapter.log.warn(logMessage);
+				break;
+		}
+	}
+}
+
+module.exports = {
+	Z2mController: Z2mController
+};