homebridge-tydom-mk 1.0.0 → 1.1.0

package/README.md

@@ -165,12 +165,18 @@ They take precedence over the corresponding config fields.
 | `settings` | `Record<deviceId, object>` | `{}` | Per-device overrides. See [Device settings](#device-settings). |
 | `debug` | `boolean` | `false` | Log every gateway request and every characteristic read and write. |
 
-Device ids are printed in the Homebridge log at startup:
+Device ids are printed in the Homebridge log at startup, one line per accessory:
 
 ```text
-[Tydom] Found new tydom device named="Kitchen" with deviceId=1234567 (id=…)
+[Tydom] Gateway reports 2 devices, exposing 2 accessories to HomeKit:
+[Tydom]   window-covering  Kitchen      id 1234567
+[Tydom]   window-covering  Living room  id 1234568  new
+[Tydom] Ready: 2 accessories (1 new, 1 up to date)
 ```
 
+A device the plugin cannot expose is named on a `Not exposed:` line, with its
+Tydom usage and id, so you can tell what is missing and ask for it.
+
 Environment variables:
 
 | Variable | Description |
@@ -278,6 +284,8 @@ Reported working by the community:
 
 - Window coverings ([TYXIA 5630](https://www.deltadore.co.uk/home-automation/control-shutters-blinds-gate-garage/receiver-micromodule/tyxia-5630-ref-6351401), [TYXIA 5730](https://www.deltadore.co.uk/home-automation/control-shutters-blinds-gate-garage/receiver-micromodule/tyxia-5730-ref-6351402), [TYXIA 5731](https://www.deltadore.co.uk/home-automation/control-shutters-blinds-gate-garage/receiver-micromodule/tyxia-5731-ref-6351412))
 
+The gateway's weather source, which the gateway lists as `Invisible 1` with no picture, appears as a temperature sensor named "Outdoor weather" ("Météo extérieure" with `locale` set to `fr`). Only the outdoor temperature is exposed: HomeKit has no weather service, and the daily maximum and the irradiation values do not map to one. The name and the missing picture suggest an internal weather service rather than a probe on your façade, so do not expect the reading of a sensor you installed. Rename it with `settings.<deviceId>.name`, or leave it out with `excludedDevices`.
+
 Also published: outlets, garage door openers, smoke detectors and temperature sensors. Devices are matched on the shape of the metadata the gateway reports, so similar hardware generally works untouched — and adding a new match is a small change, so please open an issue if yours is not recognised.
 
 ## Switching from homebridge-tydom

package/config.schema.json

@@ -3,7 +3,7 @@
   "pluginType": "platform",
   "singular": true,
   "headerDisplay": "Exposes [Delta Dore](https://www.deltadore.fr/) hardware to HomeKit through a **Tydom** gateway. Lights, shutters, thermostats, garage doors, contact and smoke sensors and Tyxal alarms are discovered automatically — nothing has to be listed by hand.",
-  "footerDisplay": "Per-device options live under **Device settings**, keyed by the numeric device id shown in the Homebridge log at startup (`Found new tydom device ... with deviceId=1234567`). Full reference in the [wiki](https://github.com/mgcrea/homebridge-tydom/wiki/Configuration).",
+  "footerDisplay": "Per-device options live under **Device settings**, keyed by the numeric device id shown in the Homebridge log at startup (`Found new tydom device ... with deviceId=1234567`). Full reference in the [README](https://github.com/maximekduval/homebridge-tydom#device-settings) and the [upstream wiki](https://github.com/mgcrea/homebridge-tydom/wiki/Configuration).",
   "schema": {
     "type": "object",
     "properties": {

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { n as PLUGIN_NAME, t as PLATFORM_NAME } from "./env-Czc5jJOI.mjs";
 // src/index.ts
 process.setSourceMapsEnabled(true);
-const { default: TydomPlatform } = await import("./platform-BkQduXj6.mjs");
+const { default: TydomPlatform } = await import("./platform-Co0jggka.mjs");
 var src_default = (homebridge) => {
 	homebridge.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, TydomPlatform);
 };

package/dist/{platform-BkQduXj6.mjs → platform-Co0jggka.mjs}

@@ -375,6 +375,10 @@ const FIRST_USAGE_MATCHES = {
 		deviceType: "window-covering",
 		category: CATEGORY.WINDOW_COVERING
 	},
+	weather: {
+		deviceType: "temperature-sensor",
+		category: CATEGORY.SENSOR
+	},
 	window: {
 		deviceType: "contact-sensor",
 		category: CATEGORY.WINDOW
@@ -1236,6 +1240,7 @@ const TABLES = {
 		PILE_FAULT_REPETITION: "Battery error",
 		PIN_FAULT: "PIN code error",
 		PLAY_ROOM: "Play room",
+		PLUGIN_OUTDOOR_WEATHER: "Outdoor weather",
 		POOL: "Pool",
 		PORCH: "Porch",
 		PRACTICE: "Practice",
@@ -2256,6 +2261,7 @@ const TABLES = {
 		PILE_FAULT_REPETITION: "Défaut pile",
 		PIN_FAULT: "Défaut code PIN",
 		PLAY_ROOM: "Salle de jeux",
+		PLUGIN_OUTDOOR_WEATHER: "Météo extérieure",
 		POOL: "Piscine",
 		PORCH: "Porche",
 		PRACTICE: "Cabinet",
@@ -2730,6 +2736,62 @@ const createPluginLogger = (log, verbose) => ({
 		log.error(message);
 	}
 });
+// src/platform/startup-report.ts
+const count = (n, one, many = `${one}s`) => `${n} ${n === 1 ? one : many}`;
+const statusMarker = (status) => {
+	switch (status) {
+		case "new": return `  ${styleGet("new")}`;
+		case "recreated": return `  ${styleUpd("recreated")}`;
+		default: return "";
+	}
+};
+/**
+* The device list, as the lines to log at info level.
+*
+* One line per accessory with its `deviceId`, which `includedDevices` and
+* `settings` are keyed by and which users have no other way to read. What the
+* plugin left out is named, rather than reported by `firstUsage` alone: a
+* missing accessory should be explained by the log, not found by elimination.
+*/
+const deviceTableLines = (rows, scan) => {
+	const exposed = count(rows.length, "accessory", "accessories");
+	const colon = rows.length > 0 ? ":" : "";
+	const unsupported = scan?.skipped.filter(({ reason }) => reason === "unsupported") ?? [];
+	const lines = [];
+	if (scan) {
+		const notes = [];
+		if (unsupported.length > 0) notes.push(`${unsupported.length} not supported`);
+		const excluded = scan.skipped.length - unsupported.length;
+		if (excluded > 0) notes.push(`${excluded} excluded by your settings`);
+		const detail = notes.length > 0 ? ` (${notes.join(", ")})` : "";
+		lines.push(`Gateway reports ${count(scan.total, "device")}${detail}, exposing ${exposed} to HomeKit${colon}`);
+	} else lines.push(`Exposing ${exposed} to HomeKit${colon}`);
+	const typeWidth = Math.max(0, ...rows.map(({ type }) => type.length));
+	const nameWidth = Math.max(0, ...rows.map(({ name }) => name.length));
+	for (const { type, name, deviceId, status } of rows) lines.push(`  ${styleKeyword(type.padEnd(typeWidth))}  ${name.padEnd(nameWidth)}  id ${styleNumber(deviceId)}${statusMarker(status)}`);
+	for (const { name, firstUsage, deviceId } of unsupported) lines.push(`Not exposed: ${name} (${firstUsage}, id ${styleNumber(deviceId)}), this type of device is not supported yet`);
+	return lines;
+};
+/**
+* The closing line: how many accessories are live, and what changed.
+*
+* An unchanged home reads "all up to date" rather than a row of zeros, so a
+* restart that changed something stands out from one that did not.
+*/
+const readyLine = (ready, rows, removed) => {
+	const created = rows.filter(({ status }) => status === "new").length;
+	const recreated = rows.filter(({ status }) => status === "recreated").length;
+	const known = rows.filter(({ status }) => status === "known").length;
+	const changes = [
+		created > 0 ? `${created} new` : "",
+		recreated > 0 ? `${recreated} recreated` : "",
+		removed > 0 ? `${removed} removed` : ""
+	].filter(Boolean);
+	const accessories = count(ready, "accessory", "accessories");
+	if (changes.length === 0) return `Ready: ${accessories}, all up to date`;
+	if (known > 0) changes.push(`${known} up to date`);
+	return `Ready: ${accessories} (${changes.join(", ")})`;
+};
 // src/util/basic.ts
 const stringIncludes = (array, value) => array.includes(value) || array.includes(`${value}`);
 /**
@@ -2822,6 +2884,7 @@ const discoverDevices = (input) => {
 			skipped.push({
 				deviceId,
 				endpointId,
+				name: deviceName,
 				firstUsage,
 				reason: "filtered"
 			});
@@ -2831,6 +2894,7 @@ const discoverDevices = (input) => {
 			skipped.push({
 				deviceId,
 				endpointId,
+				name: deviceName,
 				firstUsage,
 				reason: "filtered"
 			});
@@ -2857,6 +2921,7 @@ const discoverDevices = (input) => {
 			skipped.push({
 				deviceId,
 				endpointId,
+				name: deviceName,
 				firstUsage,
 				reason: "unsupported"
 			});
@@ -2867,6 +2932,7 @@ const discoverDevices = (input) => {
 			skipped.push({
 				deviceId,
 				endpointId,
+				name: deviceName,
 				firstUsage,
 				reason: "filtered"
 			});
@@ -2876,6 +2942,7 @@ const discoverDevices = (input) => {
 			skipped.push({
 				deviceId,
 				endpointId,
+				name: deviceName,
 				firstUsage,
 				reason: "filtered"
 			});
@@ -3344,6 +3411,14 @@ var TydomController = class extends EventEmitter {
 	* companion, since the primary always claimed the key first.
 	*/
 	emitted = /* @__PURE__ */ new Set();
+	/**
+	* What the last completed scan found, including the endpoints it left out.
+	*
+	* A property rather than the return value of `scan`, which announces the
+	* devices through events: the platform reads it once the announced devices
+	* have settled, to report them together.
+	*/
+	lastScan;
 	refreshInterval;
 	hasConnectedOnce = false;
 	/**
@@ -3392,7 +3467,7 @@ var TydomController = class extends EventEmitter {
 		this.log = log;
 		this.t = createTranslator(config.locale);
 		const { hostname, username, password, email } = config;
-		this.log.info(`Creating tydom client with username=${styleString(username)} and hostname=${styleString(hostname)}`);
+		debug(`Creating tydom client with username=${styleString(username)} and hostname=${styleString(hostname)}`);
 		this.gatewayPassword = email ? "" : password;
 		this.client = this.createClient(this.gatewayPassword);
 	}
@@ -3431,7 +3506,7 @@ var TydomController = class extends EventEmitter {
 				this.resync().catch((err) => {
 					this.log.error(`Failed to re-sync after reconnection: ${stringifyError(err)}`);
 				});
-			} else this.log.info(`Successfully connected to Tydom hostname=${styleString(hostname)} with username=${styleString(username)}`);
+			} else this.log.info(`Connected to Tydom gateway ${styleString(username)} via ${styleString(hostname)}`);
 			this.emit("connect");
 		});
 		client.on("disconnect", () => {
@@ -3540,7 +3615,7 @@ var TydomController = class extends EventEmitter {
 		this.gatewayPassword = password;
 		this.client.removeAllListeners();
 		this.client = this.createClient(password);
-		this.log.info(`Resolved the gateway password for username=${styleString(username)}`);
+		this.log.info(`Got the password of gateway ${styleString(username)} from your Delta Dore account`);
 	}
 	/** Whether a socket is up, however it got there. */
 	get isConnected() {
@@ -3590,7 +3665,8 @@ var TydomController = class extends EventEmitter {
 	}
 	async scan() {
 		const { hostname, username, settings = {} } = this.config;
-		this.log.info(`Scanning devices from hostname=${styleString(hostname)}...`);
+		this.log.info("Reading the device list...");
+		debug(`Scanning devices from hostname=${styleString(hostname)}...`);
 		const { config, groups, meta, cmeta } = await this.sync();
 		const { devices, skipped } = discoverDevices({
 			username,
@@ -3606,16 +3682,18 @@ var TydomController = class extends EventEmitter {
 				excludedCategories: this.config.excludedCategories
 			}
 		});
-		for (const skip of skipped) if (skip.reason === "unsupported") this.log.warn(`Unsupported firstUsage="${skip.firstUsage}" for endpoint with deviceId="${skip.deviceId}"`);
+		this.lastScan = {
+			total: config.endpoints.length,
+			skipped
+		};
 		for (const device of devices.flatMap((d) => expandCompanions(d))) {
 			const { uniqueId, deviceId, endpointId, firstUsage, category } = device;
-			this.log.info(`Found new device with firstUsage=${styleString(firstUsage)}, deviceId=${styleNumber(deviceId)} and endpointId=${styleNumber(endpointId)}`);
 			if (this.emitted.has(device.accessoryId)) continue;
 			this.emitted.add(device.accessoryId);
-			this.log.info(`Adding new device with firstUsage=${styleString(firstUsage)}, deviceId=${styleNumber(deviceId)} and endpointId=${styleNumber(endpointId)}`);
+			debug(`Announcing device with firstUsage=${styleString(firstUsage)}, deviceId=${styleNumber(deviceId)} and endpointId=${styleNumber(endpointId)}`);
 			if (!device.companionOf) this.devices.set(uniqueId, category);
 			const context = {
-				name: device.deviceType === "alarm-sensors" ? this.t("ALARME_ISSUES_OUVERTES", device.name) : device.name,
+				name: this.accessoryName(device),
 				category,
 				deviceType: device.deviceType,
 				metadata: device.metadata,
@@ -3633,6 +3711,17 @@ var TydomController = class extends EventEmitter {
 			this.emit("device", context);
 		}
 	}
+	/**
+	* The name an accessory is announced under.
+	*
+	* Discovery stays framework-free, so the names that come from the locale
+	* tables are filled in here. A name the user set in `settings` always wins.
+	*/
+	accessoryName(device) {
+		if (device.deviceType === "alarm-sensors") return this.t("ALARME_ISSUES_OUVERTES", device.name);
+		if (device.firstUsage === "weather" && device.settings.name === void 0) return this.t("PLUGIN_OUTDOOR_WEATHER", device.name);
+		return device.name;
+	}
 	async refresh() {
 		debug(`Refreshing Tydom controller ...`);
 		await this.client.post("/refresh/all");
@@ -5738,6 +5827,11 @@ var TydomPlatform = class {
 	* told us nothing", and those look identical from the cleanup set alone.
 	*/
 	discoveredDevices = 0;
+	/**
+	* One row per accessory the current scan announced, in the order the gateway
+	* listed them, for the device list logged once the scan has settled.
+	*/
+	startupRows = [];
 	accessories = /* @__PURE__ */ new Map();
 	/** Live handlers, keyed by the same UUID as `accessories`. */
 	handlers = /* @__PURE__ */ new Map();
@@ -5843,6 +5937,8 @@ var TydomPlatform = class {
 		assert(this.controller);
 		this.cleanupAccessoriesIds = new Set(this.accessories.keys());
 		this.discoveredDevices = 0;
+		this.startupRows = [];
+		this.controller.lastScan = void 0;
 		const maxDelay = 3e5;
 		for (let attempt = 0;; attempt++) {
 			if (this.shuttingDown) return;
@@ -5862,19 +5958,34 @@ var TydomPlatform = class {
 			}
 		}
 		await this.settlePendingDevices();
+		const rows = this.startupRows.filter(({ id }) => this.accessories.has(id));
+		this.logDeviceList(rows);
 		if (this.discoveredDevices === 0 && this.accessories.size > 0) {
 			this.log.warn(`The gateway reported no devices, so the ${this.accessories.size} known accessories were kept rather than deleted. This is usually a gateway that is still starting up, or one whose radio is down — check it answers in the Tydom app, then restart Homebridge. Remove them from the Homebridge UI if they really are gone.`);
-			this.log.info(`Properly loaded ${this.accessories.size}-accessories`);
+			this.log.info(`Ready: ${this.accessories.size} kept from the previous run, none confirmed by the gateway`);
 			return;
 		}
+		let removed = 0;
 		this.cleanupAccessoriesIds.forEach((accessoryId) => {
 			const accessory = this.accessories.get(accessoryId);
 			if (!accessory) return;
-			this.log.warn(`Deleting missing accessory with id=${styleNumber(accessoryId)}`);
+			this.log.warn(`Removing ${styleString(accessory.displayName)} (id ${styleNumber(accessory.context.deviceId)}): the gateway no longer reports it`);
 			this.api.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [accessory]);
 			this.forgetAccessory(accessoryId);
+			removed += 1;
 		});
-		this.log.info(`Properly loaded ${this.accessories.size}-accessories`);
+		this.log.info(readyLine(this.accessories.size, rows, removed));
+	}
+	/**
+	* Log what the gateway reported and what is now exposed to HomeKit.
+	*
+	* The one place devices show up at info level, as one line each: the platform
+	* used to log four per accessory, and in no order a reader could follow.
+	*/
+	logDeviceList(rows) {
+		const scan = this.controller?.lastScan;
+		for (const line of deviceTableLines(rows, scan)) this.log.info(line);
+		for (const { name, deviceId, firstUsage, reason } of scan?.skipped ?? []) if (reason === "filtered") this.log.debug(`Excluded by your settings: ${styleString(name)} (firstUsage=${styleString(firstUsage)}, deviceId=${styleNumber(deviceId)})`);
 	}
 	/**
 	* Open the first connection if there is none yet, then read the device list.
@@ -5927,11 +6038,20 @@ var TydomPlatform = class {
 	async handleControllerDevice(context) {
 		const { name, deviceId, category, accessoryId } = context;
 		const id = this.api.hap.uuid.generate(accessoryId);
-		this.log.info(`Found new tydom device named=${styleString(name)} with deviceId=${styleNumber(deviceId)} (id=${styleKeyword(id)})`);
-		this.log.debug(`Tydom with deviceId=${styleNumber(deviceId)} (id=${styleKeyword(id)}) context="${JSON.stringify(context)}"`);
+		this.log.debug(`Tydom device named=${styleString(name)} with deviceId=${styleNumber(deviceId)} (id=${styleKeyword(id)}) context="${JSON.stringify(context)}"`);
 		const existingAccessory = this.accessories.get(id);
 		const hasNewCategory = existingAccessory?.category !== category;
 		debug(`[${deviceId}] ${existingAccessory?.category} vs ${category}`);
+		let status = "known";
+		if (!existingAccessory) status = "new";
+		else if (hasNewCategory) status = "recreated";
+		this.startupRows.push({
+			id,
+			type: this.resolveDeviceType(context, category) ?? "unknown",
+			name: existingAccessory && !hasNewCategory ? existingAccessory.displayName : this.accessoryNameFor(name, category, context.group),
+			deviceId,
+			status
+		});
 		this.discoveredDevices += 1;
 		this.cleanupAccessoriesIds.delete(id);
 		if (existingAccessory) {
@@ -5939,7 +6059,7 @@ var TydomPlatform = class {
 				await this.updateAccessory(existingAccessory, context);
 				return;
 			} else {
-				this.log.warn(`Deleting accessory with new category with id=${styleNumber(accessoryId)}`);
+				this.log.warn(`Recreating ${styleString(existingAccessory.displayName)} (id ${styleNumber(deviceId)}): its HomeKit category changed`);
 				this.api.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [existingAccessory]);
 				this.forgetAccessory(id, { pruneCompanions: false });
 			}
@@ -5985,11 +6105,14 @@ var TydomPlatform = class {
 	resolveDeviceType(context, category) {
 		return context.deviceType ?? deviceTypeForCategory(category, context.settings, context.metadata);
 	}
+	/** The HomeKit name of a new accessory: a window takes the name of its group. */
+	accessoryNameFor(name, category, group) {
+		return category === CATEGORY.WINDOW && group ? group.name || name : name;
+	}
 	async createAccessory(name, id, category, context) {
 		const { platformAccessory: PlatformAccessory } = this.api;
-		const { group } = context;
-		const accessoryName = category === CATEGORY.WINDOW && group ? group.name || name : name;
-		this.log.info(`Creating accessory named=${styleString(accessoryName)}, deviceId="${styleNumber(context.deviceId)} (id=${styleKeyword(id)})"`);
+		const accessoryName = this.accessoryNameFor(name, category, context.group);
+		this.log.debug(`Creating accessory named=${styleString(accessoryName)}, deviceId=${styleNumber(context.deviceId)} (id=${styleKeyword(id)})`);
 		const accessory = new PlatformAccessory(accessoryName, id, category);
 		Object.assign(accessory.context, context);
 		return accessory;
@@ -6004,7 +6127,7 @@ var TydomPlatform = class {
 	*/
 	async updateAccessory(accessory, context) {
 		const { displayName: accessoryName, UUID: id } = accessory;
-		this.log.info(`Updating accessory named=${styleString(accessoryName)}, deviceId=${styleNumber(context.deviceId)} (id=${styleKeyword(id)})"`);
+		this.log.debug(`Updating accessory named=${styleString(accessoryName)}, deviceId=${styleNumber(context.deviceId)} (id=${styleKeyword(id)})`);
 		if (!await this.configureHandler(accessory, context)) return;
 		this.api.updatePlatformAccessories([accessory]);
 	}
@@ -6051,4 +6174,4 @@ var TydomPlatform = class {
 };
 export { TydomPlatform as default };
 
-//# sourceMappingURL=platform-BkQduXj6.mjs.map
+//# sourceMappingURL=platform-Co0jggka.mjs.map