homebridge-toshiba-plugin 0.2.7 → 0.2.8

package/README.md

@@ -15,7 +15,7 @@ Homebridge dynamic platform plugin for Toshiba **Home AC Control** cloud devices
 - Mobile cloud registration supports both response formats used by the app backend (`SasToken` or `HostName` + `DeviceId` + `PrimaryKey`).
 - Startup self-recovery for transient cloud/network errors with exponential retry backoff.
 - Device auto-discovery and cache reconciliation.
-- Resilient discovery parsing (malformed cloud entries are skipped instead of aborting discovery).
+- Authority-aware discovery parsing (valid updates merge, while malformed/partial inventories can never prune cached accessories).
 - Automatic AMQP reconnect with exponential backoff after cloud disconnects.
 - AMQP operation timeout guards (connect/send/disconnect) with failure-triggered recovery.
 - Poll/discovery overlap protection to avoid queue buildup during slow cloud responses.
@@ -25,8 +25,10 @@ Homebridge dynamic platform plugin for Toshiba **Home AC Control** cloud devices
 - No-op command suppression (skips AMQP send when requested state already matches current effective state).
 - Command preflight online check (`GetAllDeviceState`) before AMQP sends, with offline protection.
 - Short-lived connection-state cache on command precheck to reduce command latency and cloud rate-limit pressure.
-- If online precheck itself fails (timeout/network/transient cloud error), command falls back to best-effort send instead of hard-failing control.
-- Command-send retries with detailed logs for transient AMQP send failures.
+- Commands require a positive online result; an offline or unknown cloud status is reported to HomeKit as a communication failure.
+- Command sends wait for AMQP reconnection and matching push telemetry or bounded HTTP readback before HomeKit reports success.
+- Local receive generations prevent a delayed HTTP snapshot from overwriting state received after that request began. Toshiba's time-of-day-only push timestamp is not used to order packets across reconnects or midnight, so genuinely out-of-order push packets follow local arrival order.
+- Shutdown/disposal aborts in-flight HTTP requests, retry backoff, and command-confirmation readbacks.
 - Defensive payload parsing and malformed-cloud-update guards.
 - Single accessory model: each Toshiba AC is exposed as one HomeKit `HeaterCooler` service (no extra Fan/Switch/Sensor services).
 - HeaterCooler control:
@@ -124,6 +126,7 @@ homebridge -D
 ```bash
 npm run lint
 npm run build
+npm test
 ```
 
 ## Publish

package/config.schema.json

@@ -2,7 +2,7 @@
   "pluginAlias": "ToshibaSmartAC",
   "pluginType": "platform",
   "singular": true,
-  "strictValidation": true,
+  "strictValidation": false,
   "schema": {
     "type": "object",
     "required": [
@@ -63,18 +63,21 @@
       "enableFanService": {
         "title": "Expose Fan Service (Deprecated)",
         "type": "boolean",
+        "hidden": true,
         "default": false,
         "description": "Deprecated and ignored. Plugin now exposes a single HeaterCooler service only."
       },
       "enableFeatureSwitches": {
         "title": "Expose Feature Switches (Deprecated)",
         "type": "boolean",
+        "hidden": true,
         "default": false,
         "description": "Deprecated and ignored. Plugin now exposes a single HeaterCooler service only."
       },
       "enableTemperatureSensors": {
         "title": "Expose Temperature Sensors (Deprecated)",
         "type": "boolean",
+        "hidden": true,
         "default": false,
         "description": "Deprecated and ignored. Plugin now exposes a single HeaterCooler service only."
       }

package/dist/nameUtils.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Preserve vendor-facing Unicode text while removing only characters that
+ * cannot safely be serialized as a HomeKit name or cache value. The original
+ * script, diacritics, punctuation, emoji, and ZWJ sequences remain intact.
+ */
+export declare function cleanVendorName(value: unknown): string | undefined;
+/**
+ * Produce a deterministic HAP-compliant name without ASCII transliteration.
+ * All Unicode letters and numbers (including Polish and non-Latin scripts)
+ * are preserved. Typography with a safe HAP equivalent is mapped; unsupported
+ * symbols such as emoji remain available in the separately cached vendor name.
+ */
+export declare function toHomeKitName(value: unknown, fallback?: unknown): string;

package/dist/nameUtils.js

@@ -0,0 +1,108 @@
+const CONTROL_OR_LINE_SEPARATOR = /[\p{Cc}\p{Zl}\p{Zp}]+/gu;
+const SPACE_SEPARATOR = /\p{Zs}+/gu;
+const DASH_PUNCTUATION = /[\u2010-\u2015\u2212\uFE58\uFE63\uFF0D]/gu;
+const LEFT_APOSTROPHE = /\u2018/gu;
+const DOUBLE_QUOTE = /["\u201C\u201D\u201E\u201F\u2033]/gu;
+const HOMEKIT_UNSUPPORTED = /[^\p{L}\p{N}\p{Zs}\u2019'&!._:;()\u002F,-]+/gu;
+const HOMEKIT_EDGE = /^[^\p{L}\p{N}]+|[^\p{L}\p{N}]+$/gu;
+const HOMEKIT_NAME_PATTERN = /^[\p{L}\p{N}][\p{L}\p{N}\p{Zs}\u2019'&!._:;()\u002F,-]*[\p{L}\p{N}]$/u;
+const HOMEKIT_NAME_MAX_UTF16_LENGTH = 64;
+function replaceLoneSurrogates(value) {
+    let output = '';
+    for (let index = 0; index < value.length; index += 1) {
+        const codeUnit = value.charCodeAt(index);
+        if (codeUnit >= 0xD800 && codeUnit <= 0xDBFF) {
+            const nextCodeUnit = value.charCodeAt(index + 1);
+            if (nextCodeUnit >= 0xDC00 && nextCodeUnit <= 0xDFFF) {
+                output += value[index] + value[index + 1];
+                index += 1;
+            }
+            else {
+                output += '\uFFFD';
+            }
+        }
+        else if (codeUnit >= 0xDC00 && codeUnit <= 0xDFFF) {
+            output += '\uFFFD';
+        }
+        else {
+            output += value[index];
+        }
+    }
+    return output;
+}
+function replaceUnsafeFormatControls(value) {
+    let output = '';
+    for (const character of value) {
+        const codePoint = character.codePointAt(0);
+        const isUnsafeFormat = /\p{Cf}/u.test(character)
+            && codePoint !== 0x200C
+            && codePoint !== 0x200D;
+        output += isUnsafeFormat ? ' ' : character;
+    }
+    return output;
+}
+/**
+ * Preserve vendor-facing Unicode text while removing only characters that
+ * cannot safely be serialized as a HomeKit name or cache value. The original
+ * script, diacritics, punctuation, emoji, and ZWJ sequences remain intact.
+ */
+export function cleanVendorName(value) {
+    if (typeof value !== 'string') {
+        return undefined;
+    }
+    const cleaned = replaceUnsafeFormatControls(replaceLoneSurrogates(value))
+        .normalize('NFC')
+        .replace(CONTROL_OR_LINE_SEPARATOR, ' ')
+        .replace(SPACE_SEPARATOR, ' ')
+        .trim();
+    return cleaned.length > 0 ? cleaned : undefined;
+}
+function truncateUtf16WithoutSplittingCodePoints(value, maximumLength) {
+    let output = '';
+    for (const codePoint of value) {
+        if (output.length + codePoint.length > maximumLength) {
+            break;
+        }
+        output += codePoint;
+    }
+    return output;
+}
+function normalizeHomeKitCandidate(value) {
+    const vendorName = cleanVendorName(value);
+    if (!vendorName) {
+        return undefined;
+    }
+    let normalized = vendorName
+        .replace(DASH_PUNCTUATION, '-')
+        .replace(LEFT_APOSTROPHE, '\u2019')
+        .replace(DOUBLE_QUOTE, '\u0027')
+        .replace(HOMEKIT_UNSUPPORTED, ' ')
+        .replace(SPACE_SEPARATOR, ' ')
+        .trim()
+        .replace(HOMEKIT_EDGE, '');
+    normalized = truncateUtf16WithoutSplittingCodePoints(normalized, HOMEKIT_NAME_MAX_UTF16_LENGTH)
+        .replace(HOMEKIT_EDGE, '');
+    // Current HAP-NodeJS name validation expects distinct start/end alphanumeric
+    // characters. Preserve the one-character vendor name in context and expose a
+    // stable compliant label rather than letting Apple substitute a default.
+    if (Array.from(normalized).length === 1 && /^[\p{L}\p{N}]$/u.test(normalized)) {
+        normalized = `${normalized} AC`;
+    }
+    return HOMEKIT_NAME_PATTERN.test(normalized) ? normalized : undefined;
+}
+/**
+ * Produce a deterministic HAP-compliant name without ASCII transliteration.
+ * All Unicode letters and numbers (including Polish and non-Latin scripts)
+ * are preserved. Typography with a safe HAP equivalent is mapped; unsupported
+ * symbols such as emoji remain available in the separately cached vendor name.
+ */
+export function toHomeKitName(value, fallback = 'Toshiba AC') {
+    for (const candidate of [value, fallback, 'Toshiba AC']) {
+        const normalized = normalizeHomeKitCandidate(candidate);
+        if (normalized) {
+            return normalized;
+        }
+    }
+    return 'Toshiba AC';
+}
+//# sourceMappingURL=nameUtils.js.map

package/dist/nameUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nameUtils.js","sourceRoot":"","sources":["../src/nameUtils.ts"],"names":[],"mappings":"AAAA,MAAM,yBAAyB,GAAG,yBAAyB,CAAC;AAC5D,MAAM,eAAe,GAAG,WAAW,CAAC;AACpC,MAAM,gBAAgB,GAAG,2CAA2C,CAAC;AACrE,MAAM,eAAe,GAAG,UAAU,CAAC;AACnC,MAAM,YAAY,GAAG,qCAAqC,CAAC;AAC3D,MAAM,mBAAmB,GAAG,+CAA+C,CAAC;AAC5E,MAAM,YAAY,GAAG,mCAAmC,CAAC;AACzD,MAAM,oBAAoB,GAAG,uEAAuE,CAAC;AACrG,MAAM,6BAA6B,GAAG,EAAE,CAAC;AAEzC,SAAS,qBAAqB,CAAC,KAAa;IAC1C,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACrD,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,QAAQ,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;YAC7C,MAAM,YAAY,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YACjD,IAAI,YAAY,IAAI,MAAM,IAAI,YAAY,IAAI,MAAM,EAAE,CAAC;gBACrD,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;gBAC1C,KAAK,IAAI,CAAC,CAAC;YACb,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,QAAQ,CAAC;YACrB,CAAC;QACH,CAAC;aAAM,IAAI,QAAQ,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,QAAQ,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,2BAA2B,CAAC,KAAa;IAChD,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC,CAAE,CAAC;QAC5C,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC;eAC3C,SAAS,KAAK,MAAM;eACpB,SAAS,KAAK,MAAM,CAAC;QAC1B,MAAM,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,OAAO,GAAG,2BAA2B,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;SACtE,SAAS,CAAC,KAAK,CAAC;SAChB,OAAO,CAAC,yBAAyB,EAAE,GAAG,CAAC;SACvC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC;SAC7B,IAAI,EAAE,CAAC;IAEV,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAClD,CAAC;AAED,SAAS,uCAAuC,CAAC,KAAa,EAAE,aAAqB;IACnF,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;YACrD,MAAM;QACR,CAAC;QACD,MAAM,IAAI,SAAS,CAAC;IACtB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,yBAAyB,CAAC,KAAc;IAC/C,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IAC1C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,UAAU,GAAG,UAAU;SACxB,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC;SAC9B,OAAO,CAAC,eAAe,EAAE,QAAQ,CAAC;SAClC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC;SAC/B,OAAO,CAAC,mBAAmB,EAAE,GAAG,CAAC;SACjC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC;SAC7B,IAAI,EAAE;SACN,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAE7B,UAAU,GAAG,uCAAuC,CAAC,UAAU,EAAE,6BAA6B,CAAC;SAC5F,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAE7B,6EAA6E;IAC7E,6EAA6E;IAC7E,yEAAyE;IACzE,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9E,UAAU,GAAG,GAAG,UAAU,KAAK,CAAC;IAClC,CAAC;IAED,OAAO,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AACxE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,WAAoB,YAAY;IAC5E,KAAK,MAAM,SAAS,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,CAAC;QACxD,MAAM,UAAU,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACxD,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,UAAU,CAAC;QACpB,CAAC;IACH,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/dist/platform.d.ts

@@ -1,4 +1,5 @@
 import type { API, Characteristic, DynamicPlatformPlugin, Logging, PlatformAccessory, PlatformConfig, Service } from 'homebridge';
+import { ToshibaAcDevice } from './toshiba/device.js';
 interface ToshibaPlatformConfig extends PlatformConfig {
     username?: string;
     password?: string;
@@ -6,6 +7,9 @@ interface ToshibaPlatformConfig extends PlatformConfig {
     discoveryRefreshMinutes?: number;
     requestTimeoutSeconds?: number;
     httpRetries?: number;
+    enableFanService?: boolean;
+    enableFeatureSwitches?: boolean;
+    enableTemperatureSensors?: boolean;
 }
 type ToshibaCloudConnectionState = 'online' | 'offline' | 'unknown';
 export declare class ToshibaSmartACPlatform implements DynamicPlatformPlugin {
@@ -20,6 +24,8 @@ export declare class ToshibaSmartACPlatform implements DynamicPlatformPlugin {
     private readonly connectionStateCache;
     private readonly missingConnectionStateCounts;
     private readonly stateEndpointByDevice;
+    private readonly missingAccessoryCounts;
+    private consecutiveSuspiciousEmptyInventories;
     private readonly sessionId;
     private httpApi?;
     private amqpClient?;
@@ -34,9 +40,14 @@ export declare class ToshibaSmartACPlatform implements DynamicPlatformPlugin {
     private stateRefreshInProgress;
     private discoveryRefreshInProgress;
     private additionalInfoEndpointForbidden;
+    private stateStaleAfterMs;
+    private readonly shutdownController;
     constructor(log: Logging, config: ToshibaPlatformConfig, api: API);
     configureAccessory(accessory: PlatformAccessory): void;
+    private markCachedAccessoryUnavailable;
     getDeviceCloudConnectionState(uniqueId: string): ToshibaCloudConnectionState;
+    isDeviceStateFresh(device: ToshibaAcDevice): boolean;
+    isDeviceStateTimestampFresh(receivedAt: number | undefined): boolean;
     private start;
     private connectCloud;
     private refreshSasToken;
@@ -45,10 +56,15 @@ export declare class ToshibaSmartACPlatform implements DynamicPlatformPlugin {
     private scheduleTokenRefreshRetry;
     private calculateTokenRefreshDelayMs;
     private discoverDevices;
+    private resolveDiscoveredName;
+    private updateCachedAccessory;
     private removeStaleAccessories;
+    private resetDiscoveryPruningEvidence;
     private startStatePolling;
     private startDiscoveryRefresh;
     private refreshStates;
+    private refreshSingleDeviceState;
+    private forEachWithConcurrency;
     private fetchLatestStateForDevice;
     private getStateEndpointStatus;
     private markStateEndpointForbidden;
@@ -62,15 +78,16 @@ export declare class ToshibaSmartACPlatform implements DynamicPlatformPlugin {
     private loadOrCreateMobileDeviceId;
     private errorToString;
     private isHttpForbidden;
-    private isAlreadyBridgedAccessoryError;
     private sleep;
     private isConnectedState;
+    private parseCloudConnectionState;
     private refreshDeviceConnectionStates;
     private updateConnectionStateCache;
     private incrementMissingConnectionStateCount;
     private clearMissingConnectionStateCount;
     private findDeviceByCloudSourceId;
     private normalizeCloudIdentifier;
+    private captureDeviceStateGenerations;
     private normalizeIntegerConfig;
     private scheduleStartupRetry;
 }