homebridge-tydom 0.32.2 → 0.33.0

package/README.md

@@ -201,6 +201,7 @@ Pointing `hostname` at your gateway's IP (e.g. `192.168.0.42`) skips Delta Dore'
 | `name` | any | Rename the accessory. |
 | `category` | any | Pin the device to a HAP category, bypassing hardware detection. See [Category overrides](#category-overrides). |
 | `trigger` | switches | Publish a stateless switch that returns to off, rather than a toggle. |
+| `autoShutdownDelay` | switches, outlets, fans | Switch off again this many **milliseconds** after coming on, whether that was from HomeKit or from the device's own button. Off by default. |
 | `smokeDetector` | temperature sensors | Publish as a smoke detector instead. |
 | `delay` | garage doors | Travel time in **milliseconds**. Defaults to `20000`. |
 | `autoCloseDelay` | garage doors | Close again this many **milliseconds** after opening. Off by default. |

package/config.schema.json

@@ -115,7 +115,7 @@
         "patternProperties": {
           "^[0-9]+$": { "type": "object" }
         },
-        "description": "Per-device overrides, keyed by numeric device id. Free-form, because the options a device accepts depend on what it is — edit this in the JSON config rather than here.\n\n```json\n\"settings\": {\n  \"1234567\": { \"name\": \"Kitchen blind\" },\n  \"1234568\": { \"trigger\": true },\n  \"1234569\": { \"delay\": 10000, \"autoCloseDelay\": 300000 },\n  \"1657464\": {\n    \"pin\": \"1234\",\n    \"sensors\": true,\n    \"aliases\": { \"stay\": [1], \"night\": [1, 2] }\n  }\n}\n```\n\n`name` renames the accessory and `category` pins it to a HAP category, bypassing hardware detection. `trigger` turns a switch into a stateless one that returns to off. On a garage door, `delay` is the travel time in **milliseconds** (default 20000) and `autoCloseDelay` closes it again after that many milliseconds. `smokeDetector` publishes a temperature sensor as a smoke detector. On an alarm: `pin` overrides the platform PIN, `sensors: false` drops the companion accessory that holds one contact sensor per opening detector (it is published by default), `aliases` says which armed-zone combinations HomeKit should show as Home and Night, and `legacy` selects the CTX60 protocol (detected automatically; only set it if detection is wrong)."
+        "description": "Per-device overrides, keyed by numeric device id. Free-form, because the options a device accepts depend on what it is — edit this in the JSON config rather than here.\n\n```json\n\"settings\": {\n  \"1234567\": { \"name\": \"Kitchen blind\" },\n  \"1234568\": { \"trigger\": true },\n  \"1234569\": { \"delay\": 10000, \"autoCloseDelay\": 300000 },\n  \"1657464\": {\n    \"pin\": \"1234\",\n    \"sensors\": true,\n    \"aliases\": { \"stay\": [1], \"night\": [1, 2] }\n  }\n}\n```\n\n`name` renames the accessory and `category` pins it to a HAP category, bypassing hardware detection. `trigger` turns a switch into a stateless one that returns to off. On a garage door, `delay` is the travel time in **milliseconds** (default 20000) and `autoCloseDelay` closes it again after that many milliseconds. `autoShutdownDelay` switches a switch, outlet or fan off again that many milliseconds after it comes on, counted from the moment it was switched on rather than from the last thing the gateway reported, and it follows the device's own button as well as HomeKit. `smokeDetector` publishes a temperature sensor as a smoke detector. On an alarm: `pin` overrides the platform PIN, `sensors: false` drops the companion accessory that holds one contact sensor per opening detector (it is published by default), `aliases` says which armed-zone combinations HomeKit should show as Home and Night, and `legacy` selects the CTX60 protocol (detected automatically; only set it if detection is wrong)."
       },
       "debug": {
         "title": "Verbose logging",

package/dist/index.mjs

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

package/dist/{platform-CJBHeITb.mjs → platform-Bp1Glauz.mjs}

@@ -3021,6 +3021,15 @@ const parseDiscoveryResponse = (uri, schema, payload) => {
 * device is not the shape the accessory was built for — which is a bug in the
 * signature table, not a value HomeKit should be handed.
 */
+/**
+* The value of a property the hardware may simply not carry.
+*
+* `getTydomDataPropValue` asserts, which is right for a property the device
+* type guarantees. Delta Dore's HVAC range guarantees less than it looks: some
+* endpoints expose a thermic level and no numbers at all, no `setpoint` and no
+* `temperature`, and asserting on those turned every read into an error.
+*/
+const findTydomDataPropValue = (data, name) => data.find((prop) => prop.name === name)?.value;
 const getTydomDataPropValue = (data, name) => {
 	const item = data.find((prop) => prop.name === name);
 	assert(item, `Missing property with name="${name}" in endpoint data`);
@@ -4039,11 +4048,12 @@ var GarageDoorAccessory = class extends BaseAccessory {
 		this.#computedPosition = doorState === CurrentDoorState.OPEN ? 100 : 0;
 	}
 	#setDoorState(doorState) {
-		const { CurrentDoorState } = this.platform.Characteristic;
+		const { CurrentDoorState, TargetDoorState } = this.platform.Characteristic;
 		debug(`assignCurrentDoorState=${styleString(this.#label(doorState))}`);
 		this.#currentDoorState = doorState;
 		this.#settleTarget(doorState);
 		this.#service.updateCharacteristic(CurrentDoorState, doorState);
+		if (doorState === CurrentDoorState.OPEN || doorState === CurrentDoorState.CLOSED) this.#service.updateCharacteristic(TargetDoorState, this.#targetDoorState);
 	}
 	/** A door at rest, open or closed, was headed exactly there. */
 	#settleTarget(doorState) {
@@ -4813,6 +4823,14 @@ const EXPOSED_THERMIC_LEVELS = /* @__PURE__ */ new Set([
 	"ECO",
 	"COMFORT"
 ]);
+/**
+* What to report when the endpoint carries no temperature at all.
+*
+* HAP's own default for `CurrentTemperature`, so a device with no thermometer
+* looks the same as one that has not answered yet, rather than inventing a
+* reading.
+*/
+const UNKNOWN_TEMPERATURE = 0;
 /** An electric heating controller (Delta Dore RF4890, RF6600FP). */
 var ThermostatAccessory = class extends BaseAccessory {
 	#service;
@@ -4859,9 +4877,13 @@ var ThermostatAccessory = class extends BaseAccessory {
 			debugGet(CurrentHeatingCoolingState, this.#service);
 			const data = await this.#read();
 			const authorization = getTydomDataPropValue(data, "authorization");
-			const setpoint = getTydomDataPropValue(data, "setpoint");
-			const temperature = getTydomDataPropValue(data, "temperature");
+			const setpoint = findTydomDataPropValue(data, "setpoint");
+			const temperature = findTydomDataPropValue(data, "temperature");
 			let nextValue = CurrentHeatingCoolingState.OFF;
+			if (typeof setpoint !== "number" || typeof temperature !== "number") {
+				debugGetResult(CurrentHeatingCoolingState, this.#service, nextValue);
+				return nextValue;
+			}
 			if (authorization === "HEATING" && setpoint > temperature) nextValue = CurrentHeatingCoolingState.HEAT;
 			else if (authorization === "COOLING" && temperature > setpoint) nextValue = CurrentHeatingCoolingState.COOL;
 			debugGetResult(CurrentHeatingCoolingState, this.#service, nextValue);
@@ -4901,14 +4923,15 @@ var ThermostatAccessory = class extends BaseAccessory {
 		});
 		this.#service.getCharacteristic(CurrentTemperature).onGet(async () => {
 			debugGet(CurrentTemperature, this.#service);
-			const temperature = getTydomDataPropValue(await this.#read(), "temperature");
+			const data = await this.#read();
+			const temperature = findTydomDataPropValue(data, "temperature") ?? findTydomDataPropValue(data, "setpoint") ?? UNKNOWN_TEMPERATURE;
 			debugGetResult(CurrentTemperature, this.#service, temperature);
 			return temperature;
 		});
 		this.#service.getCharacteristic(TargetTemperature).onGet(async () => {
 			debugGet(TargetTemperature, this.#service);
 			const data = await this.#read();
-			const setpoint = getTydomDataPropValue(data, "setpoint") ?? getTydomDataPropValue(data, "temperature");
+			const setpoint = findTydomDataPropValue(data, "setpoint") ?? findTydomDataPropValue(data, "temperature") ?? UNKNOWN_TEMPERATURE;
 			debugGetResult(TargetTemperature, this.#service, setpoint);
 			return setpoint;
 		}).onSet(async (value) => {
@@ -5188,10 +5211,26 @@ const createWindowCoveringAccessory = (deps) => new WindowCoveringAccessory(deps
 var MappedAccessory = class extends BaseAccessory {
 	#service;
 	#bindings;
+	/** How long after switching on to switch off again, if the user asked. */
+	#autoShutdownMs;
+	/** The writable `On` binding, which is the only thing there is to switch off. */
+	#onBinding;
+	#autoShutdownTimer;
+	/**
+	* What the `On` characteristic last read, so a repeat can be told from a
+	* change. The periodic refresh pushes the current state whether or not it
+	* moved, and re-arming on those would push the shutdown out for as long as
+	* the device stayed on — which is the one thing it must not do.
+	*/
+	#isOn;
 	constructor(deps, spec) {
 		super(deps);
 		this.#service = this.service(spec.service(this.platform.Service));
 		this.#bindings = spec.bindings(this.platform.Characteristic);
+		const { autoShutdownDelay } = this.accessory.context.settings ?? {};
+		this.#autoShutdownMs = autoShutdownDelay;
+		const { On } = this.platform.Characteristic;
+		this.#onBinding = this.#bindings.find((binding) => binding.characteristic === On && binding.toTydom);
 		for (const binding of this.#bindings) this.#bind(binding);
 	}
 	/** The service this accessory publishes. Exposed for tests. */
@@ -5220,9 +5259,45 @@ var MappedAccessory = class extends BaseAccessory {
 				value: tydomValue
 			}]);
 			debugSetResult(characteristic, service, value, tydomValue);
+			this.#trackAutoShutdown(binding, value);
 		});
 	}
 	/**
+	* Arm or stand down the auto-shutdown, following the device's on state.
+	*
+	* Called from both directions on purpose: the Home app is the case nobody
+	* needs help with, and a switch left on at the wall is the case the setting
+	* exists for.
+	*/
+	#trackAutoShutdown(binding, value) {
+		if (this.#autoShutdownMs === void 0 || binding !== this.#onBinding) return;
+		const isOn = value === true;
+		if (isOn === this.#isOn) return;
+		this.#isOn = isOn;
+		this.clearTimer(this.#autoShutdownTimer);
+		this.#autoShutdownTimer = void 0;
+		if (!isOn) return;
+		this.#autoShutdownTimer = this.setTimer(() => {
+			this.#autoShutdownTimer = void 0;
+			this.#switchOff(binding);
+		}, this.#autoShutdownMs);
+	}
+	async #switchOff(binding) {
+		const { On } = this.platform.Characteristic;
+		this.#isOn = false;
+		try {
+			await this.api.putDeviceData(this.deviceId, this.endpointId, [{
+				name: binding.prop,
+				value: binding.toTydom?.(false)
+			}]);
+		} catch (err) {
+			this.platform.log.error(`Failed to switch off ${this.accessory.displayName} after its shutdown delay: ${String(err)}`);
+			return;
+		}
+		debugSetUpdate(On, this.#service, false);
+		this.#service.updateCharacteristic(On, false);
+	}
+	/**
 	* The mapping a pushed property feeds, or undefined if this binding ignores
 	* it. Read and push therefore agree by construction.
 	*/
@@ -5237,6 +5312,7 @@ var MappedAccessory = class extends BaseAccessory {
 			const next = map(value);
 			debugSetUpdate(binding.characteristic, this.#service, next);
 			this.#service.updateCharacteristic(binding.characteristic, next);
+			this.#trackAutoShutdown(binding, next);
 		}
 	}
 };
@@ -5652,4 +5728,4 @@ var TydomPlatform = class {
 //#endregion
 export { TydomPlatform as default };
 
-//# sourceMappingURL=platform-CJBHeITb.mjs.map
+//# sourceMappingURL=platform-Bp1Glauz.mjs.map