iobroker.absolutehumidity 0.0.1

package/lib/adapter-config.d.ts

@@ -0,0 +1,19 @@
+// This file extends the AdapterConfig type from "@iobroker/types"
+// using the actual properties present in io-package.json
+// in order to provide typings for adapter.config properties
+
+import { native } from '../io-package.json';
+
+type _AdapterConfig = typeof native;
+
+// Augment the globally declared type ioBroker.AdapterConfig
+declare global {
+	namespace ioBroker {
+		interface AdapterConfig extends _AdapterConfig {
+			// Do not enter anything here!
+		}
+	}
+}
+
+// this is required so the above AdapterConfig is found by TypeScript / type checking
+export {};

package/lib/modules/calculation.js

@@ -0,0 +1,44 @@
+/* eslint-disable jsdoc/require-param-description */
+'use strict';
+
+/**
+ * @param {number | null} temperature
+ * @param {number | null} relativeHumidity
+ */
+function calculateAbsoluteHumidity(temperature, relativeHumidity) {
+	if (temperature === null || relativeHumidity === null || relativeHumidity < 0 || relativeHumidity > 100) {
+		return null;
+	}
+
+	const saturationVaporPressure = 6.112 * Math.exp((17.67 * temperature) / (temperature + 243.5));
+	const vaporPressure = (relativeHumidity / 100) * saturationVaporPressure;
+
+	return round((216.7 * vaporPressure) / (273.15 + temperature));
+}
+
+/**
+ * @param {number | null} temperature
+ * @param {number | null} relativeHumidity
+ */
+function calculateDewPointTemperature(temperature, relativeHumidity) {
+	if (temperature === null || relativeHumidity === null || relativeHumidity <= 0 || relativeHumidity > 100) {
+		return null;
+	}
+
+	const alpha = Math.log(relativeHumidity / 100) + (17.62 * temperature) / (243.12 + temperature);
+
+	return round((243.12 * alpha) / (17.62 - alpha));
+}
+
+/**
+ * @param {number} value
+ */
+function round(value) {
+	return Math.round(value * 100) / 100;
+}
+
+module.exports = {
+	calculateAbsoluteHumidity,
+	calculateDewPointTemperature,
+	round,
+};

package/lib/modules/constants.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const DEVICE_ROOT = 'devices';
+const STATE_TEMPERATURE = 'temperature';
+const STATE_RELATIVE_HUMIDITY = 'relativeHumidity';
+const STATE_ABSOLUTE_HUMIDITY = 'absoluteHumidity';
+const STATE_DEW_POINT_TEMPERATURE = 'dewPointTemperature';
+const CARD_HEADER_BACKGROUND = '#0f4c81';
+const ADAPTER_ICON = 'adapter/absolutehumidity/absolutehumidity.svg';
+
+module.exports = {
+	ADAPTER_ICON,
+	CARD_HEADER_BACKGROUND,
+	DEVICE_ROOT,
+	STATE_ABSOLUTE_HUMIDITY,
+	STATE_DEW_POINT_TEMPERATURE,
+	STATE_RELATIVE_HUMIDITY,
+	STATE_TEMPERATURE,
+};

package/lib/modules/deviceManager.js

@@ -0,0 +1,312 @@
+/* eslint-disable jsdoc/require-jsdoc, jsdoc/require-param-description, jsdoc/reject-any-type */
+'use strict';
+
+const { DeviceManagement } = require('@iobroker/dm-utils');
+const {
+	ADAPTER_ICON,
+	CARD_HEADER_BACKGROUND,
+	STATE_ABSOLUTE_HUMIDITY,
+	STATE_DEW_POINT_TEMPERATURE,
+	STATE_RELATIVE_HUMIDITY,
+	STATE_TEMPERATURE,
+} = require('./constants');
+const { translate } = require('./i18n');
+
+class AbsoluteHumidityDeviceManagement extends DeviceManagement {
+	/**
+	 * @param {import('../../main')} adapter
+	 */
+	constructor(adapter) {
+		super(adapter, true);
+	}
+
+	getInstanceInfo() {
+		return {
+			apiVersion: 'v3',
+			communicationStateId: 'info.deviceManager',
+			actions: [
+				{
+					id: 'addDevice',
+					icon: 'add',
+					title: {
+						en: '+ Add device',
+						de: '+ Gerät hinzufügen',
+						ru: '+ Добавить устройство',
+						pt: '+ Adicionar dispositivo',
+						nl: '+ Apparaat toevoegen',
+						fr: '+ Ajouter un appareil',
+						it: '+ Aggiungi dispositivo',
+						es: '+ Añadir dispositivo',
+						pl: '+ Dodaj urządzenie',
+						uk: '+ Додати пристрій',
+						'zh-cn': '+ 添加设备',
+					},
+					description: translate('Add a temperature and humidity device'),
+					color: CARD_HEADER_BACKGROUND,
+					backgroundColor: CARD_HEADER_BACKGROUND,
+					variant: 'contained',
+					style: {
+						backgroundColor: CARD_HEADER_BACKGROUND,
+						color: '#ffffff',
+					},
+					handler: async context => {
+						const data = await showDeviceForm(context, undefined);
+
+						if (!data) {
+							return { refresh: false };
+						}
+
+						await this.adapter.addDevice(data);
+						return { refresh: true };
+					},
+				},
+			],
+		};
+	}
+
+	/**
+	 * @param {import('@iobroker/dm-utils').DeviceLoadContext<string>} context
+	 */
+	loadDevices(context) {
+		const devices = this.adapter.getConfiguredDevices();
+
+		context.setTotalDevices(devices.length);
+
+		for (const device of devices) {
+			context.addDevice(createDeviceInfo(this.adapter, device));
+		}
+	}
+}
+
+/**
+ * @param {import('../../main')} adapter
+ * @param {Record<string, any>} device
+ */
+function createDeviceInfo(adapter, device) {
+	return {
+		id: device.id,
+		name: device.name,
+		icon: ADAPTER_ICON,
+		backgroundColor: CARD_HEADER_BACKGROUND,
+		status: 'connected',
+		actions: [
+			{
+				id: 'editDevice',
+				icon: 'edit',
+				description: translate('Edit device'),
+				handler: async (deviceId, context) => {
+					const existingDevice = adapter.getDeviceById(deviceId);
+
+					if (!existingDevice) {
+						await context.showMessage(translate('Device not found'));
+						return { refresh: 'none' };
+					}
+
+					const data = await showDeviceForm(context, existingDevice);
+
+					if (!data) {
+						return { refresh: 'none' };
+					}
+
+					await adapter.updateDevice(deviceId, data);
+					return { refresh: 'devices' };
+				},
+			},
+			{
+				id: 'deleteDevice',
+				icon: 'delete',
+				description: translate('Delete device'),
+				color: 'secondary',
+				confirmation: translate('Delete this device?'),
+				handler: async deviceId => {
+					await adapter.deleteDevice(deviceId);
+					return { refresh: 'devices' };
+				},
+			},
+		],
+		customInfo: createDeviceCustomInfo(adapter, device),
+	};
+}
+
+/**
+ * @param {import('../../main')} adapter
+ * @param {Record<string, any>} device
+ */
+function createDeviceCustomInfo(adapter, device) {
+	return {
+		id: device.id,
+		schema: {
+			type: 'panel',
+			innerStyle: {
+				marginTop: 0,
+				paddingTop: 0,
+			},
+			items: {
+				temperature: createStateInfoItem(
+					translate('Temperature'),
+					device.createTemperatureState
+						? `${adapter.getDeviceObjectId(device.id)}.${STATE_TEMPERATURE}`
+						: device.temperatureStateId,
+					'°C',
+					!device.createTemperatureState,
+				),
+				relativeHumidity: createStateInfoItem(
+					translate('Relative humidity'),
+					device.createRelativeHumidityState
+						? `${adapter.getDeviceObjectId(device.id)}.${STATE_RELATIVE_HUMIDITY}`
+						: device.relativeHumidityStateId,
+					'%',
+					!device.createRelativeHumidityState,
+				),
+				absoluteHumidity: createStateInfoItem(
+					translate('Absolute humidity'),
+					`${adapter.getDeviceObjectId(device.id)}.${STATE_ABSOLUTE_HUMIDITY}`,
+					'g/m³',
+					false,
+				),
+				dewPointTemperature: createStateInfoItem(
+					translate('Dew point temperature'),
+					`${adapter.getDeviceObjectId(device.id)}.${STATE_DEW_POINT_TEMPERATURE}`,
+					'°C',
+					false,
+				),
+				spacer: {
+					type: 'staticText',
+					text: '',
+					newLine: true,
+					xs: 12,
+					sm: 12,
+					md: 12,
+					lg: 12,
+					xl: 12,
+				},
+				spacer2: {
+					type: 'staticText',
+					text: '',
+					newLine: true,
+					xs: 12,
+					sm: 12,
+					md: 12,
+					lg: 12,
+					xl: 12,
+				},
+			},
+		},
+	};
+}
+
+/**
+ * @param {string} label
+ * @param {string} oid
+ * @param {string} unit
+ * @param {boolean} foreign
+ */
+function createStateInfoItem(label, oid, unit, foreign) {
+	return {
+		type: 'state',
+		label,
+		oid,
+		foreign,
+		control: 'text',
+		readOnly: true,
+		unit,
+		narrow: false,
+		addColon: true,
+		newLine: true,
+		xs: 12,
+		sm: 12,
+		md: 12,
+		lg: 12,
+		xl: 12,
+	};
+}
+
+/**
+ * @param {import('@iobroker/dm-utils').ActionContext} context
+ * @param {Record<string, any> | undefined} device
+ */
+async function showDeviceForm(context, device) {
+	return context.showForm(getDeviceFormSchema(), {
+		title: device ? translate('Edit device') : translate('Add device'),
+		data: device
+			? {
+					name: device.name,
+					temperatureStateId: device.temperatureStateId,
+					relativeHumidityStateId: device.relativeHumidityStateId,
+					createTemperatureState: device.createTemperatureState,
+					createRelativeHumidityState: device.createRelativeHumidityState,
+				}
+			: {
+					name: '',
+					temperatureStateId: '',
+					relativeHumidityStateId: '',
+					createTemperatureState: true,
+					createRelativeHumidityState: true,
+				},
+		buttons: ['apply', 'cancel'],
+		minWidth: 520,
+		applyDisabledRule: '!data.name || !data.temperatureStateId || !data.relativeHumidityStateId',
+	});
+}
+
+function getDeviceFormSchema() {
+	return {
+		type: 'panel',
+		items: {
+			name: {
+				type: 'text',
+				label: translate('Name'),
+				newLine: true,
+				xs: 12,
+				sm: 12,
+			},
+			temperatureStateId: {
+				type: 'objectId',
+				label: translate('Temperature state'),
+				newLine: true,
+				xs: 12,
+				sm: 12,
+				customFilter: {
+					type: 'state',
+					common: {
+						type: 'number',
+					},
+				},
+			},
+			createTemperatureState: {
+				type: 'checkbox',
+				label: translate('Create temperature state in adapter'),
+				newLine: true,
+				xs: 12,
+				sm: 12,
+			},
+			relativeHumidityStateId: {
+				type: 'objectId',
+				label: translate('Relative humidity state'),
+				newLine: true,
+				xs: 12,
+				sm: 12,
+				customFilter: {
+					type: 'state',
+					common: {
+						type: 'number',
+					},
+				},
+			},
+			createRelativeHumidityState: {
+				type: 'checkbox',
+				label: translate('Create relative humidity state in adapter'),
+				newLine: true,
+				xs: 12,
+				sm: 12,
+			},
+		},
+	};
+}
+
+module.exports = {
+	AbsoluteHumidityDeviceManagement,
+	createDeviceInfo,
+	getDeviceFormSchema,
+	showDeviceForm,
+};

package/lib/modules/i18n.js

@@ -0,0 +1,209 @@
+/* eslint-disable jsdoc/require-jsdoc */
+'use strict';
+
+const I18N = {
+	'Add device': {
+		en: 'Add device',
+		de: 'Gerät hinzufügen',
+		ru: 'Добавить устройство',
+		pt: 'Adicionar dispositivo',
+		nl: 'Apparaat toevoegen',
+		fr: 'Ajouter un appareil',
+		it: 'Aggiungi dispositivo',
+		es: 'Añadir dispositivo',
+		pl: 'Dodaj urządzenie',
+		uk: 'Додати пристрій',
+		'zh-cn': '添加设备',
+	},
+	'Add a temperature and humidity device': {
+		en: 'Add a temperature and humidity device',
+		de: 'Temperatur- und Luftfeuchte-Gerät hinzufügen',
+		ru: 'Добавить устройство температуры и влажности',
+		pt: 'Adicionar dispositivo de temperatura e umidade',
+		nl: 'Temperatuur- en vochtigheidsapparaat toevoegen',
+		fr: 'Ajouter un appareil de température et humidité',
+		it: 'Aggiungi dispositivo di temperatura e umidità',
+		es: 'Añadir dispositivo de temperatura y humedad',
+		pl: 'Dodaj urządzenie temperatury i wilgotności',
+		uk: 'Додати пристрій температури та вологості',
+		'zh-cn': '添加温湿度设备',
+	},
+	'Edit device': {
+		en: 'Edit device',
+		de: 'Gerät bearbeiten',
+		ru: 'Редактировать устройство',
+		pt: 'Editar dispositivo',
+		nl: 'Apparaat bewerken',
+		fr: "Modifier l'appareil",
+		it: 'Modifica dispositivo',
+		es: 'Editar dispositivo',
+		pl: 'Edytuj urządzenie',
+		uk: 'Редагувати пристрій',
+		'zh-cn': '编辑设备',
+	},
+	'Delete device': {
+		en: 'Delete device',
+		de: 'Gerät löschen',
+		ru: 'Удалить устройство',
+		pt: 'Excluir dispositivo',
+		nl: 'Apparaat verwijderen',
+		fr: "Supprimer l'appareil",
+		it: 'Elimina dispositivo',
+		es: 'Eliminar dispositivo',
+		pl: 'Usuń urządzenie',
+		uk: 'Видалити пристрій',
+		'zh-cn': '删除设备',
+	},
+	'Delete this device?': {
+		en: 'Delete this device?',
+		de: 'Dieses Gerät löschen?',
+		ru: 'Удалить это устройство?',
+		pt: 'Excluir este dispositivo?',
+		nl: 'Dit apparaat verwijderen?',
+		fr: 'Supprimer cet appareil ?',
+		it: 'Eliminare questo dispositivo?',
+		es: '¿Eliminar este dispositivo?',
+		pl: 'Usunąć to urządzenie?',
+		uk: 'Видалити цей пристрій?',
+		'zh-cn': '删除此设备？',
+	},
+	'Device not found': {
+		en: 'Device not found',
+		de: 'Gerät nicht gefunden',
+		ru: 'Устройство не найдено',
+		pt: 'Dispositivo não encontrado',
+		nl: 'Apparaat niet gevonden',
+		fr: 'Appareil introuvable',
+		it: 'Dispositivo non trovato',
+		es: 'Dispositivo no encontrado',
+		pl: 'Nie znaleziono urządzenia',
+		uk: 'Пристрій не знайдено',
+		'zh-cn': '未找到设备',
+	},
+	Name: {
+		en: 'Name',
+		de: 'Name',
+		ru: 'Имя',
+		pt: 'Nome',
+		nl: 'Naam',
+		fr: 'Nom',
+		it: 'Nome',
+		es: 'Nombre',
+		pl: 'Nazwa',
+		uk: "Ім'я",
+		'zh-cn': '名称',
+	},
+	Temperature: {
+		en: 'Temperature',
+		de: 'Temperatur',
+		ru: 'Температура',
+		pt: 'Temperatura',
+		nl: 'Temperatuur',
+		fr: 'Température',
+		it: 'Temperatura',
+		es: 'Temperatura',
+		pl: 'Temperatura',
+		uk: 'Температура',
+		'zh-cn': '温度',
+	},
+	'Temperature state': {
+		en: 'Temperature state',
+		de: 'Temperatur-State',
+		ru: 'Состояние температуры',
+		pt: 'Estado de temperatura',
+		nl: 'Temperatuurstate',
+		fr: 'État de température',
+		it: 'Stato temperatura',
+		es: 'Estado de temperatura',
+		pl: 'Stan temperatury',
+		uk: 'Стан температури',
+		'zh-cn': '温度状态',
+	},
+	'Create temperature state in adapter': {
+		en: 'Create temperature state in adapter',
+		de: 'Temperatur-State im Adapter anlegen',
+		ru: 'Создать состояние температуры в адаптере',
+		pt: 'Criar estado de temperatura no adaptador',
+		nl: 'Temperatuurstate in adapter aanmaken',
+		fr: "Créer l'état de température dans l'adaptateur",
+		it: "Crea stato temperatura nell'adattatore",
+		es: 'Crear estado de temperatura en el adaptador',
+		pl: 'Utwórz stan temperatury w adapterze',
+		uk: 'Створити стан температури в адаптері',
+		'zh-cn': '在适配器中创建温度状态',
+	},
+	'Relative humidity': {
+		en: 'Relative humidity',
+		de: 'Relative Luftfeuchte',
+		ru: 'Относительная влажность',
+		pt: 'Umidade relativa',
+		nl: 'Relatieve luchtvochtigheid',
+		fr: 'Humidité relative',
+		it: 'Umidità relativa',
+		es: 'Humedad relativa',
+		pl: 'Wilgotność względna',
+		uk: 'Відносна вологість',
+		'zh-cn': '相对湿度',
+	},
+	'Relative humidity state': {
+		en: 'Relative humidity state',
+		de: 'State für relative Luftfeuchte',
+		ru: 'Состояние относительной влажности',
+		pt: 'Estado de umidade relativa',
+		nl: 'Relatieve-luchtvochtigheidstate',
+		fr: "État d'humidité relative",
+		it: 'Stato umidità relativa',
+		es: 'Estado de humedad relativa',
+		pl: 'Stan wilgotności względnej',
+		uk: 'Стан відносної вологості',
+		'zh-cn': '相对湿度状态',
+	},
+	'Create relative humidity state in adapter': {
+		en: 'Create relative humidity state in adapter',
+		de: 'State für relative Luftfeuchte im Adapter anlegen',
+		ru: 'Создать состояние относительной влажности в адаптере',
+		pt: 'Criar estado de umidade relativa no adaptador',
+		nl: 'Relatieve-luchtvochtigheidstate in adapter aanmaken',
+		fr: "Créer l'état d'humidité relative dans l'adaptateur",
+		it: "Crea stato umidità relativa nell'adattatore",
+		es: 'Crear estado de humedad relativa en el adaptador',
+		pl: 'Utwórz stan wilgotności względnej w adapterze',
+		uk: 'Створити стан відносної вологості в адаптері',
+		'zh-cn': '在适配器中创建相对湿度状态',
+	},
+	'Absolute humidity': {
+		en: 'Absolute humidity',
+		de: 'Absolute Luftfeuchte',
+		ru: 'Абсолютная влажность',
+		pt: 'Umidade absoluta',
+		nl: 'Absolute luchtvochtigheid',
+		fr: 'Humidité absolue',
+		it: 'Umidità assoluta',
+		es: 'Humedad absoluta',
+		pl: 'Wilgotność bezwzględna',
+		uk: 'Абсолютна вологість',
+		'zh-cn': '绝对湿度',
+	},
+	'Dew point temperature': {
+		en: 'Dew point temperature',
+		de: 'Taupunkttemperatur',
+		ru: 'Температура точки росы',
+		pt: 'Temperatura do ponto de orvalho',
+		nl: 'Dauwpunttemperatuur',
+		fr: 'Température du point de rosée',
+		it: 'Temperatura del punto di rugiada',
+		es: 'Temperatura del punto de rocío',
+		pl: 'Temperatura punktu rosy',
+		uk: 'Температура точки роси',
+		'zh-cn': '露点温度',
+	},
+};
+
+function translate(text) {
+	return I18N[text] || text;
+}
+
+module.exports = {
+	I18N,
+	translate,
+};

package/lib/modules/idUtils.js

@@ -0,0 +1,82 @@
+/* eslint-disable jsdoc/require-param-description, jsdoc/reject-any-type */
+'use strict';
+
+/**
+ * @param {string} name
+ * @param {Record<string, any>[]} devices
+ */
+function createUniqueDeviceId(name, devices) {
+	const usedIds = new Set(devices.map(device => device.id));
+	const baseId = sanitizeId(name || 'device');
+	const id = createUniqueIdFromBase(baseId, usedIds);
+
+	usedIds.add(id);
+
+	return id;
+}
+
+/**
+ * @param {string} baseId
+ * @param {Set<string>} usedIds
+ */
+function createUniqueIdFromBase(baseId, usedIds) {
+	let id = baseId;
+	let index = 2;
+
+	while (usedIds.has(id)) {
+		id = `${baseId}_${index}`;
+		index++;
+	}
+
+	return id;
+}
+
+/**
+ * @param {string} value
+ */
+function sanitizeId(value) {
+	const id = replaceGermanUmlauts(String(value))
+		.normalize('NFKD')
+		.replace(/[\u0300-\u036f]/g, '')
+		.toLowerCase()
+		.trim()
+		.replace(/[^a-z0-9]+/g, '_')
+		.replace(/^_+|_+$/g, '');
+
+	return id || 'device';
+}
+
+/**
+ * @param {string} value
+ */
+function legacySanitizeId(value) {
+	const id = String(value)
+		.toLowerCase()
+		.trim()
+		.replace(/[^a-z0-9]+/g, '_')
+		.replace(/^_+|_+$/g, '');
+
+	return id || 'device';
+}
+
+/**
+ * @param {string} value
+ */
+function replaceGermanUmlauts(value) {
+	return value
+		.replace(/ä/g, 'ae')
+		.replace(/ö/g, 'oe')
+		.replace(/ü/g, 'ue')
+		.replace(/Ä/g, 'Ae')
+		.replace(/Ö/g, 'Oe')
+		.replace(/Ü/g, 'Ue')
+		.replace(/ß/g, 'ss');
+}
+
+module.exports = {
+	createUniqueDeviceId,
+	createUniqueIdFromBase,
+	legacySanitizeId,
+	replaceGermanUmlauts,
+	sanitizeId,
+};