iobroker.zigbee2mqtt 0.1.0 → 1.0.0

package/lib/states.js

@@ -71,7 +71,8 @@ const states = {
 		read: true,
 		type: 'number',
 		min: 0,
-		max: 255
+		max: 255,
+		def: 10,
 	},
 
 	available: {
@@ -79,10 +80,11 @@ const states = {
 		prop: 'available',
 		name: 'Available',
 		icon: undefined,
-		role: 'state',
+		role: 'indicator.reachable',
 		write: false,
 		read: true,
-		type: 'boolean'
+		type: 'boolean',
+		def: false,
 	},
 	device_query: { // button to trigger device read
 		id: 'device_query',
@@ -280,6 +282,7 @@ const states = {
 		type: 'number',
 		unit: 'V',
 		getter: payload => payload.voltage / 1000,
+		def: 0,
 	},
 	ecozy_voltage: {
 		id: 'voltage',
@@ -291,6 +294,7 @@ const states = {
 		type: 'number',
 		unit: 'V',
 		getter: payload => payload.voltage * 10,
+		def: 0,
 	},
 	battery: {
 		id: 'battery',
@@ -303,7 +307,8 @@ const states = {
 		type: 'number',
 		unit: '%',
 		min: 0,
-		max: 100
+		max: 100,
+		def: 0,
 	},
 	left_click: {
 		id: 'left_click',
@@ -549,7 +554,8 @@ const states = {
 		write: false,
 		read: true,
 		type: 'number',
-		unit: '°C'
+		unit: '°C',
+		def: 0,
 	},
 	humidity: {
 		id: 'humidity',
@@ -605,6 +611,7 @@ const states = {
 		write: false,
 		read: true,
 		type: 'boolean',
+		def: false,
 	},
 	occupancy_event: {
 		id: 'occupancy',
@@ -615,6 +622,7 @@ const states = {
 		read: true,
 		type: 'boolean',
 		isEvent: true,
+		def: false,
 	},
 	occupancy_pirOToUDelay: {
 		// this is different from occupancy_timeout,
@@ -670,17 +678,19 @@ const states = {
 		role: 'state',
 		write: false,
 		read: true,
-		type: 'boolean'
+		type: 'boolean',
+		def: false,
 	},
 	opened: {
 		id: 'opened',
 		prop: 'contact',
 		name: 'Is open',
 		icon: undefined,
-		role: 'state',
+		role: 'sensor.window',
 		write: false,
 		read: true,
 		type: 'boolean',
+		def: false,
 		getter: payload => !payload.contact,
 	},
 	tamper: {
@@ -701,7 +711,8 @@ const states = {
 		role: 'indicator.leakage',
 		write: false,
 		read: true,
-		type: 'boolean'
+		type: 'boolean',
+		def: false,
 	},
 	gas_detected: {
 		id: 'detected',
@@ -711,7 +722,8 @@ const states = {
 		role: 'indicator.alarm.fire',
 		write: false,
 		read: true,
-		type: 'boolean'
+		type: 'boolean',
+		def: false,
 	},
 	smoke_detected: {
 		id: 'detected',
@@ -721,7 +733,8 @@ const states = {
 		role: 'indicator.alarm.fire',
 		write: false,
 		read: true,
-		type: 'boolean'
+		type: 'boolean',
+		def: false,
 	},
 	smoke_detected2: {   // for Heiman
 		id: 'smoke',
@@ -731,7 +744,8 @@ const states = {
 		role: 'indicator.alarm.fire',
 		write: false,
 		read: true,
-		type: 'boolean'
+		type: 'boolean',
+		def: false,
 	},
 	co_detected: {   // for Heiman
 		id: 'carbon_monoxide',
@@ -741,7 +755,8 @@ const states = {
 		role: 'indicator.alarm.carbon_monoxide',
 		write: false,
 		read: true,
-		type: 'boolean'
+		type: 'boolean',
+		def: false,
 	},
 	heiman_batt_low: {
 		id: 'battery_low',
@@ -751,7 +766,8 @@ const states = {
 		role: 'indicator.lowbat',
 		write: false,
 		read: true,
-		type: 'boolean'
+		type: 'boolean',
+		def: false
 	},
 	heiman_battery: {
 		id: 'battery',
@@ -764,7 +780,8 @@ const states = {
 		type: 'number',
 		unit: '%',
 		min: 0,
-		max: 100
+		max: 100,
+		def: 0,
 	},
 	heiman_smart_controller_armed: {
 		id: 'arm_state',
@@ -1154,7 +1171,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'number',
-		unit: '',
+		unit: '%',
 		min: 0,
 		max: 100,
 		getter: payload => {
@@ -1478,7 +1495,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string',
-		states: 'low:low;medium:medium;high:high',
+		states: { low: 'low', medium: 'medium', high: 'high' },
 		epname: 'ep2',
 	},
 	occupancy_timeout: {
@@ -2185,7 +2202,7 @@ const states = {
 		prop: 'occupied_heating_setpoint',
 		name: 'Occupied Target Temperature',
 		icon: undefined,
-		role: 'value.temperature',
+		role: 'level.temperature',
 		write: true,
 		read: true,
 		type: 'number',
@@ -2196,7 +2213,7 @@ const states = {
 		prop: 'unoccupied_heating_setpoint',
 		name: 'Unoccupied Target Temperature',
 		icon: undefined,
-		role: 'value.temperature',
+		role: 'level.temperature',
 		write: true,
 		read: true,
 		type: 'number',
@@ -2629,6 +2646,7 @@ const states = {
 		write: false,
 		read: true,
 		type: 'boolean',
+		def: false,
 	},
 	natgas_density: {
 		id: 'gas_density',
@@ -3715,7 +3733,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string', // valid: low, medium, high
-		states: 'low:low;medium:medium;high:high',
+		states: { low: 'low', medium: 'medium', high: 'high' },
 	},
 	cover_stop: {
 		id: 'cover_stop',
@@ -4029,7 +4047,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string',
-		states: 'hold:manual;program:program',
+		states: { hold: 'manual', program: 'program' },
 		setattr: 'preset',
 	},
 	moes_trv_heating: {
@@ -4052,7 +4070,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string', // valid: IN, AL, OU
-		states: 'IN:IN;AL:AL;OU:OU',
+		states: { IN: 'IN', AL: 'AL', OU: 'OU' },
 		setter: (value) => (value) === 'IN' ? 0 : (value) === 'AL' ? 1 : (value) === 'OU' ? 2 : 0,
 	},
 	tuya_trv_target_temperature: {
@@ -4187,7 +4205,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string', // valid: low, medium, high
-		states: 'off:off;auto:auto;manual:manual;comfort:comfort;eco:eco;boost:boost;complex:complex',
+		states: { off: 'off', auto: 'auto', manual: 'manual', comfort: 'comfort', eco: 'eco', boost: 'boost', complex: 'complex' },
 	},
 	climate_preset: {
 		id: 'preset',
@@ -4197,7 +4215,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string',
-		states: 'schedule:schedule;manual:manual;boost:boost;complex:complex;comfort:comfort;eco:eco',
+		states: { schedule: 'schedule', manual: 'manual', boost: 'boost', complex: 'complex', comfort: 'comfort', eco: 'eco' },
 	},
 	climate_away_mode: {
 		id: 'away_mode',
@@ -4221,7 +4239,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string',
-		states: 'auto:auto;off:off;heat:heat',
+		states: { auto: 'auto', off: 'off', heat: 'heat' },
 	},
 	climate_running_mode: {
 		id: 'running_state',
@@ -4232,7 +4250,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string', // valid: low, medium, high
-		states: 'idle;idle;heat:heat',
+		states: { idle: 'idle', heat: 'heat' },
 	},
 	tuya_trv_force_mode: {
 		id: 'mode_force',
@@ -4243,7 +4261,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string', // valid: low, medium, high
-		states: 'normal:normal;open:open;close:close',
+		states: { normal: 'normal', open: 'open', close: 'close' },
 	},
 	tuya_trv_valve_position: {
 		id: 'valve_position',
@@ -4858,7 +4876,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string', // valid: low, medium, high
-		states: 'low:low;medium:medium;high:high',
+		states: { low: 'low', medium: 'medium', high: 'high' },
 	},
 	duration: {
 		id: 'duration',
@@ -5217,7 +5235,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string',
-		states: '0:СБМ-20/СТС-5/BOI-33;1:СБМ-19/СТС-6;3:Other',
+		states: { 0: 'СБМ-20/СТС-5/BOI-33', 1: 'СБМ-19/СТС-6', 3: 'Other' },
 		setter: (value) => parseInt(value),
 	},
 	geiger_alert_threshold: {
@@ -5263,7 +5281,8 @@ const states = {
 		read: false,
 		type: 'number',
 		min: -50,
-		max: 50
+		max: 50,
+		def: 0
 	},
 	colortemp_move: {
 		id: 'colortemp_move',
@@ -5275,7 +5294,8 @@ const states = {
 		read: false,
 		type: 'number',
 		min: -50,
-		max: 50
+		max: 50,
+		def: 0
 	},
 	hue_move: {
 		id: 'hue_move',
@@ -5287,7 +5307,8 @@ const states = {
 		read: false,
 		type: 'number',
 		min: -50,
-		max: 50
+		max: 50,
+		def: 0
 	},
 	saturation_move: {
 		id: 'saturation_move',
@@ -5299,7 +5320,8 @@ const states = {
 		read: false,
 		type: 'number',
 		min: -50,
-		max: 50
+		max: 50,
+		def: 0
 	},
 	brightness_step_up: {
 		id: 'brightness_step_up',
@@ -5370,6 +5392,7 @@ const states = {
 		write: false,
 		read: true,
 		type: 'boolean',
+		def: 0,
 		isEvent: true,
 		getter: payload => (payload.action === 'color_temperature_move') ? true : undefined,
 	},
@@ -5424,6 +5447,7 @@ const states = {
 		write: false,
 		read: true,
 		type: 'boolean',
+		def: false,
 		isEvent: true,
 		getter: payload => (payload.action === 'brightness_move_up') ? true : undefined,
 	},
@@ -5448,6 +5472,7 @@ const states = {
 		write: false,
 		read: true,
 		type: 'boolean',
+		def: false,
 		isEvent: true,
 		getter: payload => (payload.action === 'brightness_move_down') ? true : undefined,
 	},
@@ -5667,7 +5692,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string',
-		states: 'auto:auto;manual:manual;away:away',
+		states: { auto: 'auto', manual: 'manual', away: 'away' },
 	},
 	child_lock: {
 		id: 'lock',
@@ -5701,7 +5726,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string',
-		states: 'internal:internal;external:external;both:both',
+		states: { internal: 'internal', external: 'external', both: 'both' },
 	},
 	hvacThermostat_external_temp: {
 		id: 'external_temp',
@@ -5786,7 +5811,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string',
-		states: 'steady:steady;snow:snow;rainbow:rainbow;snake:snake;twinkle:twinkle;firework:firework;horizontal_flag:horizontal_flag;waves:waves;updown:updown;vintage:vintage;fading:fading;collide:collide;strobe:strobe;sparkles:sparkles;carnaval:carnaval;glow:glow',
+		states: { steady: 'steady', snow: 'snow', rainbow: 'rainbow', snake: 'snake', twinkle: 'twinkle', firework: 'firework', horizontal_flag: 'horizontal_flag', waves: 'waves', updown: 'updown', vintage: 'vintage', fading: 'fading', collide: 'collide', strobe: 'strobe', sparkles: 'sparkles', carnaval: 'carnaval', glow: 'glow' },
 		setter: (value, options) => {
 			const effectjson = {
 				colors: [{ r: 255, g: 0, b: 0 }, { r: 0, g: 255, b: 0 }, { r: 0, g: 0, b: 255 }],
@@ -5957,7 +5982,7 @@ const states = {
 		write: true,
 		read: true,
 		type: 'string',
-		states: 'blink:blink;breathe:breathe;okay:okay;channel_change:channel_change;finish_effect:finish_effect;stop_effect:stop_effect'
+		states: { blink: 'blink', breathe: 'breathe', okay: 'okay', channel_change: 'channel_change', finish_effect: 'finish_effect', stop_effect: 'stop_effect' }
 	},
 	interlock: {
 		id: 'interlock',

package/lib/statesController.js

@@ -0,0 +1,127 @@
+const utils = require('./utils');
+const incStatsQueue = [];
+
+class StatesController {
+	constructor(adapter, deviceCache, groupCache, debugDevices) {
+		this.adapter = adapter;
+		this.groupCache = groupCache;
+		this.deviceCache = deviceCache;
+		this.debugDevices = debugDevices;
+	}
+
+	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.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.setStateAsync(stateName, state.getter(messageObj.payload));
+						}
+						else {
+							await this.setStateAsync(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!`);
+				}
+			}
+		}
+	}
+
+	async setStateAsync(stateName, value) {
+		if (value !== undefined) {
+			await this.adapter.setStateAsync(stateName, value, true);
+		}
+	}
+
+	async setStateWithTimeoutAsync(stateName, value, timeout) {
+		if (value !== undefined) {
+			await this.adapter.setStateAsync(stateName, value, true);
+			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.setStateAsync(`${device.ieee_address}.${state.id}`, false, true);
+				}
+			}
+		}
+	}
+}
+
+module.exports = {
+	StatesController
+};

package/lib/utils.js

@@ -61,7 +61,7 @@ function toMired(t) {
 }
 
 function miredKelvinConversion(t) {
-	return (1000000 / t).toFixed();
+	return Math.round(1000000 / t);
 }
 
 /**
@@ -118,14 +118,23 @@ function clearArray(array) {
 	}
 }
 
-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: bulbLevelToAdapterLevel,
+	adapterLevelToBulbLevel: adapterLevelToBulbLevel,
+	bytesArrayToWordArray: bytesArrayToWordArray,
+	toMired: toMired,
+	miredKelvinConversion: miredKelvinConversion,
+	decimalToHex: decimalToHex,
+	getZbId: getZbId,
+	getAdId: getAdId,
+	removeDeviceByIeee: removeDeviceByIeee,
+	getDeviceIcon: getDeviceIcon,
+	clearArray: clearArray,
+	moveArray: moveArray,
+};

package/lib/z2mController.js

@@ -0,0 +1,80 @@
+class Z2mController {
+	constructor(adapter, deviceCache, groupCache, logfilter) {
+		this.adapter = adapter;
+		this.groupCache = groupCache;
+		this.deviceCache = deviceCache;
+		this.logfilter = logfilter;
+	}
+
+	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.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
+};