fix!: Remove permit_join_timeout (#25082)

Co-authored-by: Nerivec <[email protected]>
Co-authored-by: IIIEII <[email protected]>
Co-authored-by: Artem Draft <[email protected]>

Author: 4 people

lib/extension/bridge.ts

@@ -692,7 +692,8 @@ export default class Bridge extends Extension {
                 channel: networkParams.channel,
             },
             log_level: logger.getLevel(),
-            permit_join_timeout: this.zigbee.getPermitJoinTimeout(),
+            permit_join: this.zigbee.getPermitJoin(),
+            permit_join_end: this.zigbee.getPermitJoinEnd(),
             restart_required: this.restartRequired,
             config,
             config_schema: settings.schemaJson,

lib/extension/homeassistant.ts

@@ -2014,20 +2014,6 @@ export default class HomeAssistant extends Extension {
                     json_attributes_template: '{{ value_json.data.value | tojson }}',
                 },
             },
-            {
-                type: 'sensor',
-                object_id: 'permit_join_timeout',
-                mockProperties: [],
-                discovery_payload: {
-                    name: 'Permit join timeout',
-                    device_class: 'duration',
-                    unit_of_measurement: 's',
-                    entity_category: 'diagnostic',
-                    state_topic: true,
-                    state_topic_postfix: 'info',
-                    value_template: '{{ iif(value_json.permit_join_timeout is defined, value_json.permit_join_timeout, None) }}',
-                },
-            },
 
             // Switches.
             {

lib/types/api.ts

@@ -169,7 +169,8 @@ export interface Zigbee2MQTTAPI {
             channel: number;
         };
         log_level: 'debug' | 'info' | 'warning' | 'error';
-        permit_join_timeout: number;
+        permit_join: boolean;
+        permit_join_end: number | undefined;
         restart_required: boolean;
         config: Settings;
         config_schema: typeof schemaJson;

lib/zigbee.ts

@@ -223,8 +223,12 @@ export default class Zigbee {
         logger.info('Stopped zigbee-herdsman');
     }
 
-    getPermitJoinTimeout(): number {
-        return this.herdsman.getPermitJoinTimeout();
+    getPermitJoin(): boolean {
+        return this.herdsman.getPermitJoin();
+    }
+
+    getPermitJoinEnd(): number | undefined {
+        return this.herdsman.getPermitJoinEnd();
     }
 
     async permitJoin(time: number, device?: Device): Promise<void> {

package.json

@@ -60,7 +60,7 @@
         "winston-syslog": "^2.7.1",
         "winston-transport": "^4.9.0",
         "ws": "^8.18.0",
-        "zigbee-herdsman": "3.0.1",
+        "zigbee-herdsman": "3.0.2",
         "zigbee-herdsman-converters": "21.2.1",
         "zigbee2mqtt-frontend": "0.9.0"
     },

pnpm-lock.yaml

@@ -221,7 +221,8 @@ describe('Extension: Bridge', () => {
                 coordinator: {ieee_address: '0x00124b00120144ae', meta: {revision: 20190425, version: 1}, type: 'z-Stack'},
                 log_level: 'info',
                 network: {channel: 15, extended_pan_id: 0x001122, pan_id: 5674},
-                permit_join_timeout: 0,
+                permit_join: false,
+                permit_join_end: undefined,
                 restart_required: false,
                 version: version.version,
                 zigbee_herdsman: zhVersion,

test/extensions/bridge.test.ts

@@ -2389,26 +2389,6 @@ describe('Extension: HomeAssistant', () => {
             {retain: true, qos: 1},
         );
 
-        payload = {
-            name: 'Permit join timeout',
-            object_id: 'zigbee2mqtt_bridge_permit_join_timeout',
-            entity_category: 'diagnostic',
-            device_class: 'duration',
-            unit_of_measurement: 's',
-            unique_id: 'bridge_0x00124b00120144ae_permit_join_timeout_zigbee2mqtt',
-            state_topic: 'zigbee2mqtt/bridge/info',
-            value_template: '{{ iif(value_json.permit_join_timeout is defined, value_json.permit_join_timeout, None) }}',
-            origin: origin,
-            device: devicePayload,
-            availability: [{topic: 'zigbee2mqtt/bridge/state', value_template: '{{ value_json.state }}'}],
-            availability_mode: 'all',
-        };
-        expect(mockMQTT.publishAsync).toHaveBeenCalledWith(
-            'homeassistant/sensor/1221051039810110150109113116116_0x00124b00120144ae/permit_join_timeout/config',
-            stringify(payload),
-            {retain: true, qos: 1},
-        );
-
         // Switches.
         payload = {
             name: 'Permit join',

test/extensions/homeassistant.test.ts

@@ -1092,7 +1092,8 @@ export const mockController = {
     touchlinkFactoryResetFirst: jest.fn(),
     addInstallCode: jest.fn(),
     permitJoin: jest.fn(),
-    getPermitJoinTimeout: jest.fn((): number => 0),
+    getPermitJoin: jest.fn((): boolean => false),
+    getPermitJoinEnd: jest.fn((): number | undefined => undefined),
     isStopping: jest.fn((): boolean => false),
     backup: jest.fn(),
     coordinatorCheck: jest.fn(),