@marcel2215/homebridge-supla-plugin 2.1.28 → 2.1.29

package/dist/platform.js

@@ -74,6 +74,9 @@ class SuplaPlatform {
         this.mqttHandlers = new Map();
         this.mqttHandlerOwners = new Map();
         this.mqttWildcardHandlers = new Map();
+        this.mqttNoLocalTopics = new Set();
+        this.mqttTransportHandlers = new Map();
+        this.channelRegistry = new Map();
         this.ownerCleanups = new Map();
         this.mqttDesiredSubscriptions = new Set();
         this.mqttSubscriptions = new Set();
@@ -81,6 +84,7 @@ class SuplaPlatform {
         this.mqttRetryTimers = new Map();
         this.mqttRetryState = new Map();
         this.mqttRouterAttached = false;
+        this.mqttTransportConnected = false;
         this.log.debug('Finished initializing platform:', this.config.name);
         const configView = this.config;
         this.coveringControlMode = this.normalizeCoveringControlMode(configView.coveringControlMode);
@@ -90,9 +94,6 @@ class SuplaPlatform {
         this.coveringExecuteActionClose = (configView.coveringExecuteActionClose || 'shut').toString();
         this.coveringExecuteActionStop = (configView.coveringExecuteActionStop || 'stop').toString();
         this.coveringTravelTimeSeconds = Number(configView.coveringTravelTimeSeconds) || 0;
-        this.gateControlMode = this.normalizeGateControlMode(configView.gateControlMode);
-        this.gateExecuteActionOpen = (configView.gateExecuteActionOpen || 'open_close').toString();
-        this.gateExecuteActionClose = (configView.gateExecuteActionClose || 'open_close').toString();
         this.gateExecuteActionToggle = (configView.gateExecuteActionToggle || 'open_close').toString();
         this.gateLockControlMode = this.normalizeGateLockControlMode(configView.gateLockControlMode);
         this.gateLockExecuteAction = (configView.gateLockExecuteAction || 'open').toString();
@@ -100,18 +101,15 @@ class SuplaPlatform {
         this.gateLockPulseSeconds = Number(configView.gateLockPulseSeconds) || 0;
         this.gateLockSetOnPayload = (configView.gateLockSetOnPayload ?? 'true').toString();
         this.gateLockSetOffPayload = (configView.gateLockSetOffPayload ?? 'false').toString();
-        this.gatePartialHiMode = this.normalizeGatePartialHiMode(configView.gatePartialHiMode);
-        this.gateReverseFollowUpDelayMs = this.normalizeGateReverseFollowUpDelayMs(configView.gateReverseFollowUpDelayMs);
-        this.gateOpenAssumeDelayMs = this.normalizeGateOpenAssumeDelayMs(configView.gateOpenAssumeDelayMs);
-        this.gateCommandCooldownMs = this.normalizeGateCommandCooldownMs(configView.gateCommandCooldownMs);
-        this.gatePublishRetryDelayMs = this.normalizeGatePublishRetryDelayMs(configView.gatePublishRetryDelayMs);
-        this.gateStrictReverseDoublePulse = this.parseBoolean(configView.gateStrictReverseDoublePulse ?? true);
-        this.gateDebugTimeline = this.parseBoolean(configView.gateDebugTimeline ?? false);
-        this.frontGateFullTravelMs = this.normalizeFrontGateFullTravelMs(configView.frontGateFullTravelMs ?? configView.gateOpenAssumeDelayMs);
+        this.frontGateFullTravelMs = this.normalizeFrontGateFullTravelMs(configView.frontGateFullTravelMs);
         this.frontGateReversePauseMs = this.normalizeFrontGateReversePauseMs(configView.frontGateReversePauseMs);
-        this.frontGateWrongDirectionRunMs = this.normalizeFrontGateWrongDirectionRunMs(configView.frontGateWrongDirectionRunMs);
-        this.frontGateMinimumPulseGapMs = this.normalizeFrontGateMinimumPulseGapMs(configView.frontGateMinimumPulseGapMs ?? configView.gateCommandCooldownMs);
-        this.frontGateCloseRetryLimit = this.normalizeFrontGateCloseRetryLimit(configView.frontGateCloseRetryLimit);
+        this.frontGateMinimumPulseGapMs = this.normalizeFrontGateMinimumPulseGapMs(configView.frontGateMinimumPulseGapMs);
+        this.frontGateUnknownOpenPolicy = this.normalizeFrontGateUnknownOpenPolicy(configView.frontGateUnknownOpenPolicy);
+        this.frontGateUnknownClosePolicy = this.normalizeFrontGateUnknownClosePolicy(configView.frontGateUnknownClosePolicy);
+        this.frontGateSeekClosedMaxPulses = this.normalizeFrontGateSeekClosedMaxPulses(configView.frontGateSeekClosedMaxPulses);
+        this.frontGateAssumeOpenAfterTravel = this.parseBoolean(configView.frontGateAssumeOpenAfterTravel ?? false);
+        this.frontGateSensorFallbackToControlChannel = this.parseBoolean(configView.frontGateSensorFallbackToControlChannel ?? false);
+        this.mqttProtocolVersion = this.normalizeMqttProtocolVersion(configView.mqttProtocolVersion);
         this.commandQos = this.normalizeCommandQos(configView.commandQos);
         this.commandRetain = this.parseBoolean(configView.commandRetain ?? false);
         this.api.on('shutdown', () => {
@@ -126,18 +124,23 @@ class SuplaPlatform {
             this.MqttClient = new SuplaMqttClient_1.SuplaMqttClient(mqttSettings, this.log);
             this.startMqttRouter();
             this.MqttClient.client.on('connect', () => {
+                this.updateMqttTransportState(true);
                 this.resubscribeAll(true);
             });
             this.MqttClient.client.on('close', () => {
+                this.updateMqttTransportState(false);
                 this.clearActiveSubscriptions();
             });
             this.MqttClient.client.on('offline', () => {
+                this.updateMqttTransportState(false);
                 this.clearActiveSubscriptions();
             });
             this.MqttClient.client.on('end', () => {
+                this.updateMqttTransportState(false);
                 this.clearActiveSubscriptions();
             });
             if (this.MqttClient.client.connected) {
+                this.updateMqttTransportState(true);
                 this.resubscribeAll(true);
             }
             this.discoverDevices();
@@ -166,9 +169,11 @@ class SuplaPlatform {
         }
         const normalized = this.normalizeChannelContext(cachedDevice);
         accessory.context.device = normalized;
-        accessory.context.deviceSignature = this.getChannelSignature(normalized);
-        const configured = this.setupAccessory(normalized, accessory);
-        accessory.context.deviceConfigured = configured;
+        this.addChannelToRegistry(normalized);
+        // Accessory construction is intentionally deferred until didFinishLaunching.
+        // Homebridge restores cached accessories one at a time, so configuring a gate
+        // here could pair it before its separate contact-sensor accessory is known.
+        accessory.context.deviceConfigured = false;
     }
     /**
      * This is an example method showing how to register discovered accessories.
@@ -177,7 +182,15 @@ class SuplaPlatform {
      */
     discoverDevices(channelsOverride) {
         const rawChannels = channelsOverride ?? this.loadChannelsFromConfig();
-        const channels = rawChannels.map(channel => this.normalizeChannelContext(channel));
+        let channels = rawChannels.map(channel => this.normalizeChannelContext(channel));
+        if (channels.length === 0 && channelsOverride === undefined) {
+            channels = this.accessories
+                .map(accessory => accessory.context.device)
+                .filter((channel) => Boolean(channel))
+                .map(channel => this.normalizeChannelContext(channel));
+        }
+        channels = this.deduplicateChannels(channels);
+        this.replaceChannelRegistry(channels);
         this.log.info('Channels discovered:', channels.length);
         this.log.debug(`Discovery mode: ${channelsOverride ? 'live' : 'cached'} channels`);
         const channelUuids = new Set();
@@ -279,6 +292,7 @@ class SuplaPlatform {
                 return;
             }
             platformConfig.channels = JSON.stringify(channels);
+            this.config.channels = platformConfig.channels;
             const payload = JSON.stringify(config, null, 2);
             const tempPath = `${configPath}.tmp`;
             fs.writeFileSync(tempPath, payload);
@@ -327,14 +341,61 @@ class SuplaPlatform {
         return this.api.hap.uuid.generate(key);
     }
     getChannelSignature(channel) {
-        return [
+        const signature = [
             channel.topic ?? '',
             channel.channelFunction ?? '',
             channel.channelType ?? '',
             channel.deviceId ?? '',
             channel.channelId ?? '',
+        ];
+        if (channel.channelFunction === 'CONTROLLINGTHEGATE') {
+            const configView = this.config;
+            const sensorRegistrySignature = Array.from(this.channelRegistry.values())
+                .filter(candidate => {
+                const functionName = (candidate.channelFunction ?? '').toUpperCase();
+                const typeName = (candidate.channelType ?? '').toUpperCase();
+                return functionName.startsWith('OPENINGSENSOR_') || typeName === 'BINARYSENSOR';
+            })
+                .map(candidate => [
+                candidate.topic,
+                candidate.channelFunction,
+                candidate.channelType,
+                candidate.deviceId,
+                candidate.channelId,
+                candidate.channelCaption,
+            ].join(':'))
+                .sort()
+                .join(';');
+            signature.push(configView.frontGateSensorTopic ?? '', String(configView.frontGateSensorDeviceId ?? ''), String(configView.frontGateSensorChannelId ?? ''), String(this.frontGateSensorFallbackToControlChannel), sensorRegistrySignature);
+        }
+        return signature.join('|');
+    }
+    getChannelRegistryKey(channel) {
+        return [
+            channel.deviceId ?? '',
+            channel.channelId ?? '',
+            this.normalizeTopicBase(channel.topic),
         ].join('|');
     }
+    addChannelToRegistry(channel) {
+        this.channelRegistry.set(this.getChannelRegistryKey(channel), channel);
+    }
+    replaceChannelRegistry(channels) {
+        this.channelRegistry.clear();
+        for (const channel of channels) {
+            this.addChannelToRegistry(channel);
+        }
+    }
+    deduplicateChannels(channels) {
+        const byKey = new Map();
+        for (const channel of channels) {
+            byKey.set(this.getChannelRegistryKey(channel), channel);
+        }
+        return Array.from(byKey.values());
+    }
+    getKnownChannels() {
+        return Array.from(this.channelRegistry.values());
+    }
     resetAccessoryServices(accessory) {
         const keepUuid = this.Service.AccessoryInformation.UUID;
         for (const service of accessory.services) {
@@ -479,15 +540,6 @@ class SuplaPlatform {
     getCoveringTravelTimeSeconds() {
         return this.coveringTravelTimeSeconds;
     }
-    getGateControlMode() {
-        return this.gateControlMode;
-    }
-    getGateExecuteActionOpen() {
-        return this.gateExecuteActionOpen;
-    }
-    getGateExecuteActionClose() {
-        return this.gateExecuteActionClose;
-    }
     getGateExecuteActionToggle() {
         return this.gateExecuteActionToggle;
     }
@@ -509,50 +561,25 @@ class SuplaPlatform {
     getGateLockSetOffPayload() {
         return this.gateLockSetOffPayload;
     }
-    getGatePartialHiMode() {
-        return this.gatePartialHiMode;
-    }
-    getGateReverseFollowUpDelayMs() {
-        return this.gateReverseFollowUpDelayMs;
-    }
-    getGateOpenAssumeDelayMs() {
-        return this.gateOpenAssumeDelayMs;
-    }
-    getGateCommandCooldownMs() {
-        return this.gateCommandCooldownMs;
-    }
-    getGatePublishRetryDelayMs() {
-        return this.gatePublishRetryDelayMs;
-    }
-    getGateStrictReverseDoublePulse() {
-        return this.gateStrictReverseDoublePulse;
-    }
-    getGateDebugTimeline() {
-        return this.gateDebugTimeline;
-    }
-    getFrontGateTimings() {
+    getFrontGateConfig() {
         return {
             fullTravelMs: this.frontGateFullTravelMs,
             reversePauseMs: this.frontGateReversePauseMs,
-            wrongDirectionRunMs: this.frontGateWrongDirectionRunMs,
             minimumPulseGapMs: this.frontGateMinimumPulseGapMs,
-            closeRetryLimit: this.frontGateCloseRetryLimit,
+            unknownOpenPolicy: this.frontGateUnknownOpenPolicy,
+            unknownClosePolicy: this.frontGateUnknownClosePolicy,
+            seekClosedMaxPulses: this.frontGateSeekClosedMaxPulses,
+            assumeOpenAfterTravel: this.frontGateAssumeOpenAfterTravel,
         };
     }
+    shouldFallbackFrontGateSensorToControlChannel() {
+        return this.frontGateSensorFallbackToControlChannel;
+    }
+    isMqttNoLocalAvailable() {
+        return this.mqttProtocolVersion === 5;
+    }
     getFrontGatePulseAction() {
-        const toggleAction = this.gateExecuteActionToggle.trim();
-        if (toggleAction) {
-            return toggleAction;
-        }
-        const openAction = this.gateExecuteActionOpen.trim();
-        const closeAction = this.gateExecuteActionClose.trim();
-        if (openAction && openAction === closeAction) {
-            return openAction;
-        }
-        if (openAction) {
-            return openAction;
-        }
-        return closeAction;
+        return this.gateExecuteActionToggle.trim();
     }
     normalizeCoveringControlMode(value) {
         const normalized = (value ?? 'set').toString().toLowerCase();
@@ -564,13 +591,6 @@ class SuplaPlatform {
         }
         return 'set';
     }
-    normalizeGateControlMode(value) {
-        const normalized = (value ?? 'execute_action').toString().toLowerCase();
-        if (normalized === 'toggle') {
-            return 'toggle';
-        }
-        return 'execute_action';
-    }
     normalizeGateLockControlMode(value) {
         const normalized = (value ?? 'execute_action').toString().toLowerCase();
         if (normalized === 'set_on_pulse') {
@@ -578,55 +598,6 @@ class SuplaPlatform {
         }
         return 'execute_action';
     }
-    normalizeGatePartialHiMode(value) {
-        const normalized = (value ?? 'moving').toString().toLowerCase();
-        if (normalized === 'open_endstop' || normalized === 'open') {
-            return 'open_endstop';
-        }
-        if (normalized === 'pedestrian_endstop' || normalized === 'pedestrian') {
-            return 'pedestrian_endstop';
-        }
-        if (normalized === 'ignore' || normalized === 'absent') {
-            return 'ignore';
-        }
-        return 'moving';
-    }
-    normalizeGateReverseFollowUpDelayMs(value) {
-        const fallbackMs = 3000;
-        const parsed = Number(value);
-        if (!Number.isFinite(parsed)) {
-            return fallbackMs;
-        }
-        const rounded = Math.round(parsed);
-        return Math.min(10000, Math.max(250, rounded));
-    }
-    normalizeGateOpenAssumeDelayMs(value) {
-        const fallbackMs = 22000;
-        const parsed = Number(value);
-        if (!Number.isFinite(parsed)) {
-            return fallbackMs;
-        }
-        const rounded = Math.round(parsed);
-        return Math.min(120000, Math.max(1000, rounded));
-    }
-    normalizeGateCommandCooldownMs(value) {
-        const fallbackMs = 700;
-        const parsed = Number(value);
-        if (!Number.isFinite(parsed)) {
-            return fallbackMs;
-        }
-        const rounded = Math.round(parsed);
-        return Math.min(15000, Math.max(3000, rounded));
-    }
-    normalizeGatePublishRetryDelayMs(value) {
-        const fallbackMs = 300;
-        const parsed = Number(value);
-        if (!Number.isFinite(parsed)) {
-            return fallbackMs;
-        }
-        const rounded = Math.round(parsed);
-        return Math.min(5000, Math.max(0, rounded));
-    }
     normalizeFrontGateFullTravelMs(value) {
         const fallbackMs = 25000;
         const parsed = Number(value);
@@ -645,15 +616,6 @@ class SuplaPlatform {
         const rounded = Math.round(parsed);
         return Math.min(15000, Math.max(3000, rounded));
     }
-    normalizeFrontGateWrongDirectionRunMs(value) {
-        const fallbackMs = 700;
-        const parsed = Number(value);
-        if (!Number.isFinite(parsed)) {
-            return fallbackMs;
-        }
-        const rounded = Math.round(parsed);
-        return Math.min(5000, Math.max(100, rounded));
-    }
     normalizeFrontGateMinimumPulseGapMs(value) {
         const fallbackMs = 3000;
         const parsed = Number(value);
@@ -661,16 +623,28 @@ class SuplaPlatform {
             return fallbackMs;
         }
         const rounded = Math.round(parsed);
-        return Math.min(10000, Math.max(0, rounded));
+        return Math.min(15000, Math.max(0, rounded));
+    }
+    normalizeFrontGateUnknownOpenPolicy(value) {
+        return value === 'accept_non_closed' ? 'accept_non_closed' : 'reject';
     }
-    normalizeFrontGateCloseRetryLimit(value) {
-        const fallbackValue = 0;
+    normalizeFrontGateUnknownClosePolicy(value) {
+        if (value === 'single_pulse_best_effort' || value === 'seek_closed') {
+            return value;
+        }
+        return 'reject';
+    }
+    normalizeFrontGateSeekClosedMaxPulses(value) {
+        const fallbackValue = 3;
         const parsed = Number(value);
         if (!Number.isFinite(parsed)) {
             return fallbackValue;
         }
         const rounded = Math.round(parsed);
-        return Math.min(3, Math.max(0, rounded));
+        return Math.min(3, Math.max(1, rounded));
+    }
+    normalizeMqttProtocolVersion(value) {
+        return Number(value) === 5 ? 5 : 4;
     }
     normalizeTopicSuffix(value) {
         return value.toString().replace(/^\/+/, '');
@@ -686,7 +660,7 @@ class SuplaPlatform {
         base = base.replace(/\/set\/.+$/, '');
         return base.replace(/\/+$/, '');
     }
-    registerMqttHandler(topic, handler, ownerId) {
+    registerMqttHandler(topic, handler, ownerId, options = {}) {
         if (!topic) {
             return () => undefined;
         }
@@ -701,6 +675,9 @@ class SuplaPlatform {
         ownerTopics.set(topic, ownerHandlers);
         this.mqttHandlerOwners.set(ownerId, ownerTopics);
         this.mqttDesiredSubscriptions.add(topic);
+        if (options.noLocal && this.mqttProtocolVersion === 5) {
+            this.mqttNoLocalTopics.add(topic);
+        }
         this.ensureSubscribed(topic, false);
         return () => {
             this.removeHandler(topic, handler);
@@ -717,6 +694,21 @@ class SuplaPlatform {
             }
         };
     }
+    registerMqttTransportHandler(handler, ownerId) {
+        const handlers = this.mqttTransportHandlers.get(ownerId) ?? new Set();
+        handlers.add(handler);
+        this.mqttTransportHandlers.set(ownerId, handlers);
+        handler(this.mqttTransportConnected);
+        const cleanup = () => {
+            const active = this.mqttTransportHandlers.get(ownerId);
+            active?.delete(handler);
+            if (active?.size === 0) {
+                this.mqttTransportHandlers.delete(ownerId);
+            }
+        };
+        this.registerOwnerCleanup(ownerId, cleanup);
+        return cleanup;
+    }
     registerOwnerCleanup(ownerId, cleanup) {
         const cleanups = this.ownerCleanups.get(ownerId) ?? new Set();
         cleanups.add(cleanup);
@@ -758,6 +750,8 @@ class SuplaPlatform {
         }
         this.mqttHandlers.clear();
         this.mqttWildcardHandlers.clear();
+        this.mqttNoLocalTopics.clear();
+        this.mqttTransportHandlers.clear();
         this.mqttDesiredSubscriptions.clear();
         this.mqttSubscriptions.clear();
         this.mqttPendingSubscriptions.clear();
@@ -765,6 +759,12 @@ class SuplaPlatform {
         this.ownerCleanups.clear();
     }
     publishCommand(topic, payload, callback) {
+        this.publishMqtt(topic, payload, { qos: this.commandQos, retain: this.commandRetain }, callback);
+    }
+    publishGateAction(topic, payload, callback) {
+        this.publishMqtt(topic, payload, { qos: 0, retain: false }, callback);
+    }
+    publishMqtt(topic, payload, options, callback) {
         const client = this.MqttClient?.client;
         if (!client || !client.connected) {
             const error = new Error('MQTT not connected');
@@ -774,7 +774,7 @@ class SuplaPlatform {
             }
             return;
         }
-        client.publish(topic, payload, { qos: this.commandQos, retain: this.commandRetain }, (error) => {
+        client.publish(topic, payload, options, (error) => {
             if (callback) {
                 callback(error);
                 return;
@@ -800,6 +800,31 @@ class SuplaPlatform {
         }
         return false;
     }
+    parseBooleanStrict(value) {
+        if (typeof value === 'boolean') {
+            return value;
+        }
+        if (typeof value === 'number') {
+            if (value === 1) {
+                return true;
+            }
+            if (value === 0) {
+                return false;
+            }
+            return undefined;
+        }
+        if (typeof value !== 'string') {
+            return undefined;
+        }
+        const normalized = value.trim().toLowerCase();
+        if (['1', 'true', 'on', 'yes'].includes(normalized)) {
+            return true;
+        }
+        if (['0', 'false', 'off', 'no'].includes(normalized)) {
+            return false;
+        }
+        return undefined;
+    }
     runOwnerCleanup(ownerId) {
         const cleanups = this.ownerCleanups.get(ownerId);
         if (!cleanups) {
@@ -815,6 +840,22 @@ class SuplaPlatform {
         }
         this.ownerCleanups.delete(ownerId);
     }
+    updateMqttTransportState(connected) {
+        if (this.mqttTransportConnected === connected) {
+            return;
+        }
+        this.mqttTransportConnected = connected;
+        for (const handlers of this.mqttTransportHandlers.values()) {
+            for (const handler of handlers) {
+                try {
+                    handler(connected);
+                }
+                catch (error) {
+                    this.log.error(`MQTT transport handler failed: ${error.message}`);
+                }
+            }
+        }
+    }
     clearActiveSubscriptions() {
         if (this.mqttSubscriptions.size > 0 || this.mqttPendingSubscriptions.size > 0) {
             this.log.debug('MQTT connection lost; clearing active subscriptions.');
@@ -930,7 +971,11 @@ class SuplaPlatform {
             return;
         }
         this.mqttPendingSubscriptions.add(topic);
-        this.MqttClient.client.subscribe(topic, (err, granted) => {
+        const subscribeOptions = {
+            qos: 0,
+            ...(this.mqttNoLocalTopics.has(topic) && this.mqttProtocolVersion === 5 ? { nl: true } : {}),
+        };
+        this.MqttClient.client.subscribe(topic, subscribeOptions, (err, granted) => {
             this.mqttPendingSubscriptions.delete(topic);
             if (err) {
                 this.logSubscriptionIssue(topic, `MQTT subscribe failed for ${topic}: ${err.message}`);
@@ -976,6 +1021,7 @@ class SuplaPlatform {
     }
     removeSubscription(topic) {
         this.mqttDesiredSubscriptions.delete(topic);
+        this.mqttNoLocalTopics.delete(topic);
         this.mqttPendingSubscriptions.delete(topic);
         this.clearSubscriptionRetry(topic);
         if (!this.MqttClient) {
@@ -1041,7 +1087,7 @@ class SuplaPlatform {
         }
         this.mqttRouterAttached = true;
         this.resubscribeAll(false);
-        this.MqttClient.client.on('message', (topic, message) => {
+        this.MqttClient.client.on('message', (topic, message, packet) => {
             const dispatched = new Set();
             const dispatch = (handler, label) => {
                 if (dispatched.has(handler)) {
@@ -1049,7 +1095,7 @@ class SuplaPlatform {
                 }
                 dispatched.add(handler);
                 try {
-                    handler(message, topic);
+                    handler(message, topic, packet);
                 }
                 catch (error) {
                     this.log.error(`MQTT handler error for ${label}: ${error.message}`);