Merge branch 'dev' into feature/sd-notify

.github/workflows/ci.yml

@@ -93,15 +93,16 @@ jobs:
     - name: "release: merge dev -> master and promote dev"
       if: startsWith(github.ref, 'refs/tags/') && github.event_name == 'push'  
       run: |
+        TAG=${GITHUB_REF#refs/*/}
         git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
         git config --local user.name "github-actions[bot]"
         git fetch origin
         git checkout master
-        git merge -m 'chore: merge dev to master' dev
+        git merge -m 'chore: merge dev to master' origin/dev
         git push origin master
         git checkout dev
-        jq '.version = "${{ needs.release-please.outputs.version }}-dev"' package.json > package.json.tmp
-        jq '.version = "${{ needs.release-please.outputs.version }}-dev"' package-lock.json > package-lock.json.tmp
+        jq ".version = \"$TAG-dev\"" package.json > package.json.tmp
+        jq ".version = \"$TAG-dev\"" package-lock.json > package-lock.json.tmp
         mv package.json.tmp package.json
         mv package-lock.json.tmp package-lock.json
         git add -A

.github/workflows/deps_review.yaml

@@ -11,4 +11,4 @@ jobs:
       - name: 'Checkout repository'
         uses: actions/checkout@v4
       - name: 'Dependency review'
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v4

.github/workflows/release_please.yml

@@ -38,7 +38,7 @@ jobs:
           ref: master
 
       - name: Restore cache commit-user-lookup.json
-        uses: actions/cache/restore@v3
+        uses: actions/cache/restore@v4
         with:
           path: z2m/scripts/commit-user-lookup.json
           key: commit-user-lookup-dummy
@@ -62,7 +62,7 @@ jobs:
         env:
           GH_TOKEN: ${{secrets.GH_TOKEN}}
       - name: Save cache commit-user-lookup.json
-        uses: actions/cache/save@v3
+        uses: actions/cache/save@v4
         if: always()
         with:
           path: z2m/scripts/commit-user-lookup.json

lib/eventBus.ts

@@ -90,6 +90,13 @@ export default class EventBus {
         this.on('entityOptionsChanged', callback, key);
     }
 
+    public emitExposesChanged(data: eventdata.ExposesChanged): void {
+        this.emitter.emit('exposesChanged', data);
+    }
+    public onExposesChanged(key: ListenerKey, callback: (data: eventdata.ExposesChanged) => void): void {
+        this.on('exposesChanged', callback, key);
+    }
+
     public emitDeviceLeave(data: eventdata.DeviceLeave): void {
         this.emitter.emit('deviceLeave', data);
     }

lib/extension/homeassistant.ts

@@ -146,6 +146,7 @@ export default class HomeAssistant extends Extension {
         this.eventBus.onDeviceMessage(this, this.onZigbeeEvent);
         this.eventBus.onScenesChanged(this, this.onScenesChanged);
         this.eventBus.onEntityOptionsChanged(this, (data) => this.discover(data.entity, true));
+        this.eventBus.onExposesChanged(this, (data) => this.discover(data.device, true));
 
         this.mqtt.subscribe(this.statusTopic);
         this.mqtt.subscribe(defaultStatusTopic);
@@ -599,6 +600,7 @@ export default class HomeAssistant extends Extension {
             discoveryEntries.push(discoveryEntry);
         } else if (isBinaryExposeFeature(firstExpose)) {
             const lookup: {[s: string]: KeyValue}= {
+                auto_off: {icon: 'mdi:flash-auto'},
                 battery_low: {entity_category: 'diagnostic', device_class: 'battery'},
                 button_lock: {entity_category: 'config', icon: 'mdi:lock'},
                 calibration: {entity_category: 'config', icon: 'mdi:progress-wrench'},
@@ -630,8 +632,10 @@ export default class HomeAssistant extends Extension {
                 occupancy: {device_class: 'motion'},
                 power_outage_memory: {entity_category: 'config', icon: 'mdi:memory'},
                 presence: {device_class: 'presence'},
+                setup: {device_class: 'running'},
                 smoke: {device_class: 'smoke'},
                 sos: {device_class: 'safety'},
+                schedule: {icon: 'mdi:calendar'},
                 status_capacitive_load: {entity_category: 'diagnostic', icon: 'mdi:tune'},
                 status_forward_phase_control: {entity_category: 'diagnostic', icon: 'mdi:tune'},
                 status_inductive_load: {entity_category: 'diagnostic', icon: 'mdi:tune'},
@@ -640,10 +644,15 @@ export default class HomeAssistant extends Extension {
                 tamper: {device_class: 'tamper'},
                 temperature_scale: {entity_category: 'config', icon: 'mdi:temperature-celsius'},
                 test: {entity_category: 'diagnostic', icon: 'mdi:test-tube'},
+                trigger_indicator: {icon: 'mdi:led-on'},
+                valve_alarm: {device_class: 'problem'},
+                valve_detection: {icon: 'mdi:pipe-valve'},
                 valve_state: {device_class: 'opening'},
                 vibration: {device_class: 'vibration'},
                 water_leak: {device_class: 'moisture'},
                 window: {device_class: 'window'},
+                window_detection: {icon: 'mdi:window-open-variant'},
+                window_open: {device_class: 'window'},
             };
 
             /**
@@ -700,6 +709,7 @@ export default class HomeAssistant extends Extension {
             const lookup: {[s: string]: KeyValue} = {
                 ac_frequency: {device_class: 'frequency', enabled_by_default: false, entity_category: 'diagnostic',
                     state_class: 'measurement'},
+                action_duration: {icon: 'mdi:timer', device_class: 'duration'},
                 alarm_humidity_max: {device_class: 'humidity', entity_category: 'config', icon: 'mdi:water-plus'},
                 alarm_humidity_min: {device_class: 'humidity', entity_category: 'config', icon: 'mdi:water-minus'},
                 alarm_temperature_max: {device_class: 'temperature', entity_category: 'config',
@@ -750,13 +760,15 @@ export default class HomeAssistant extends Extension {
                     state_class: 'measurement',
                 },
                 deadzone_temperature: {entity_category: 'config', icon: 'mdi:thermometer'},
+                detection_interval: {icon: 'mdi:timer'},
                 device_temperature: {
                     device_class: 'temperature', entity_category: 'diagnostic', state_class: 'measurement',
                 },
                 duration: {entity_category: 'config', icon: 'mdi:timer'},
                 eco2: {device_class: 'carbon_dioxide', state_class: 'measurement'},
                 eco_temperature: {entity_category: 'config', icon: 'mdi:thermometer'},
                 energy: {device_class: 'energy', state_class: 'total_increasing'},
+                external_temperature_input: {icon: 'mdi:thermometer'},
                 formaldehyd: {state_class: 'measurement'},
                 gas_density: {icon: 'mdi:google-circles-communities', state_class: 'measurement'},
                 hcho: {icon: 'mdi:air-filter', state_class: 'measurement'},
@@ -781,13 +793,15 @@ export default class HomeAssistant extends Extension {
                 minimum_on_level: {entity_category: 'config'},
                 measurement_poll_interval: {entity_category: 'config', icon: 'mdi:clock-out'},
                 occupancy_timeout: {entity_category: 'config', icon: 'mdi:timer'},
+                overload_protection: {icon: 'mdi:flash'},
                 pm10: {device_class: 'pm10', state_class: 'measurement'},
                 pm25: {device_class: 'pm25', state_class: 'measurement'},
                 people: {state_class: 'measurement', icon: 'mdi:account-multiple'},
                 position: {icon: 'mdi:valve', state_class: 'measurement'},
                 power: {device_class: 'power', entity_category: 'diagnostic', state_class: 'measurement'},
                 power_factor: {device_class: 'power_factor', enabled_by_default: false,
                     entity_category: 'diagnostic', state_class: 'measurement'},
+                power_outage_count: {icon: 'mdi:counter'},
                 precision: {entity_category: 'config', icon: 'mdi:decimal-comma-increase'},
                 pressure: {device_class: 'atmospheric_pressure', state_class: 'measurement'},
                 presence_timeout: {entity_category: 'config', icon: 'mdi:timer'},
@@ -925,6 +939,7 @@ export default class HomeAssistant extends Extension {
                 alarm_temperature: {entity_category: 'config', icon: 'mdi:thermometer-alert'},
                 backlight_auto_dim: {entity_category: 'config', icon: 'mdi:brightness-auto'},
                 backlight_mode: {entity_category: 'config', icon: 'mdi:lightbulb'},
+                calibrate: {icon: 'mdi:tune'},
                 color_power_on_behavior: {entity_category: 'config', icon: 'mdi:palette'},
                 control_mode: {entity_category: 'config', icon: 'mdi:tune'},
                 device_mode: {entity_category: 'config', icon: 'mdi:tune'},
@@ -938,13 +953,15 @@ export default class HomeAssistant extends Extension {
                 melody: {entity_category: 'config', icon: 'mdi:music-note'},
                 mode_phase_control: {entity_category: 'config', icon: 'mdi:tune'},
                 mode: {entity_category: 'config', icon: 'mdi:tune'},
+                mode_switch: {icon: 'mdi:tune'},
                 motion_sensitivity: {entity_category: 'config', icon: 'mdi:tune'},
                 operation_mode: {entity_category: 'config', icon: 'mdi:tune'},
                 power_on_behavior: {entity_category: 'config', icon: 'mdi:power-settings'},
                 power_outage_memory: {entity_category: 'config', icon: 'mdi:power-settings'},
                 power_supply_mode: {entity_category: 'config', icon: 'mdi:power-settings'},
                 power_type: {entity_category: 'config', icon: 'mdi:lightning-bolt-circle'},
                 sensitivity: {entity_category: 'config', icon: 'mdi:tune'},
+                sensor: {icon: 'mdi:tune'},
                 sensors_type: {entity_category: 'config', icon: 'mdi:tune'},
                 sound_volume: {entity_category: 'config', icon: 'mdi:volume-high'},
                 status: {icon: 'mdi:state-machine'},
@@ -1000,10 +1017,12 @@ export default class HomeAssistant extends Extension {
             const settableText = firstExpose.type === 'text' && firstExpose.access & ACCESS_SET;
             const lookup: {[s: string]: KeyValue} = {
                 action: {icon: 'mdi:gesture-double-tap'},
+                color_options: {icon: 'mdi:palette'},
                 level_config: {entity_category: 'diagnostic'},
                 programming_mode: {icon: 'mdi:calendar-clock'},
                 program: {value_template: `{{ value_json.${firstExpose.property}|default('',True) ` +
                     `| truncate(254, True, '', 0) }}`},
+                schedule_settings: {icon: 'mdi:calendar-clock'},
             };
             if (firstExpose.access & ACCESS_STATE) {
                 const discoveryEntry: DiscoveryEntry = {
@@ -1039,6 +1058,14 @@ export default class HomeAssistant extends Extension {
             throw new Error(`Unsupported exposes type: '${firstExpose.type}'`);
         }
 
+        // Exposes with category 'config' or 'diagnostic' are always added to the respective category.
+        // This takes precedence over definitions in this file.
+        if (firstExpose.category === 'config') {
+            discoveryEntries.forEach((d) => d.discovery_payload.entity_category = 'config');
+        } else if (firstExpose.category === 'diagnostic') {
+            discoveryEntries.forEach((d) => d.discovery_payload.entity_category = 'diagnostic');
+        }
+
         discoveryEntries.forEach((d) => {
             // If a sensor has entity category `config`, then change
             // it to `diagnostic`. Sensors have no input, so can't be configured.

lib/extension/otaUpdate.ts

@@ -125,11 +125,11 @@ export default class OTAUpdate extends Extension {
         logger.debug(`Responded to OTA request of '${data.device.name}' with 'NO_IMAGE_AVAILABLE'`);
     }
 
-    private async readSoftwareBuildIDAndDateCode(device: Device, sendWhen: 'active' | 'immediate'):
+    private async readSoftwareBuildIDAndDateCode(device: Device, sendPolicy?: 'immediate'):
         Promise<{softwareBuildID: string, dateCode: string}> {
         try {
             const endpoint = device.zh.endpoints.find((e) => e.supportsInputCluster('genBasic'));
-            const result = await endpoint.read('genBasic', ['dateCode', 'swBuildId'], {sendWhen});
+            const result = await endpoint.read('genBasic', ['dateCode', 'swBuildId'], {sendPolicy});
             return {softwareBuildID: result.swBuildId, dateCode: result.dateCode};
         } catch (e) {
             return null;
@@ -273,7 +273,7 @@ export default class OTAUpdate extends Extension {
                     const payload = this.getEntityPublishPayload(device,
                         {available: false, currentFileVersion: fileVersion, otaFileVersion: fileVersion});
                     this.publishEntityState(device, payload);
-                    const to = await this.readSoftwareBuildIDAndDateCode(device, 'active');
+                    const to = await this.readSoftwareBuildIDAndDateCode(device);
                     const [fromS, toS] = [stringify(from_), stringify(to)];
                     logger.info(`Device '${device.name}' was updated from '${fromS}' to '${toS}'`);
                     responseData.from = from_ ? utils.toSnakeCase(from_) : null;

lib/extension/receive.ts

@@ -138,7 +138,13 @@ export default class Receive extends Extension {
             }
         };
 
-        const meta = {device: data.device.zh, logger, state: this.state.get(data.device)};
+        const deviceExposesChanged = (): void => {
+            this.eventBus.emitDevicesChanged();
+            this.eventBus.emitExposesChanged({device: data.device});
+        };
+
+        const meta = {device: data.device.zh, logger, state: this.state.get(data.device),
+            deviceExposesChanged: deviceExposesChanged};
         let payload: KeyValue = {};
         for (const converter of converters) {
             try {

lib/types/types.d.ts

@@ -90,6 +90,7 @@ declare global {
         type DeviceInterview = { device: Device, status: 'started' | 'successful' | 'failed' };
         type DeviceJoined = { device: Device };
         type EntityOptionsChanged = { entity: Device | Group, from: KeyValue, to: KeyValue };
+        type ExposesChanged = { device: Device };
         type Reconfigure = { device: Device };
         type DeviceLeave = { ieeeAddr: string, name: string };
         type GroupMembersChanged = {group: Group, action: 'remove' | 'add' | 'remove_all',