Preserve HA metadata and pass override options

Author: MaxRink

lib/extension/homeassistant.ts

@@ -1358,6 +1358,9 @@ export class HomeAssistant extends Extension {
                                 optimistic: !allowsState,
                             }),
                         };
+                        if (feature.category === "config" || feature.category === "diagnostic") {
+                            discoveryPayload.entity_category = feature.category;
+                        }
 
                         if (isNumericExpose(feature)) {
                             if (allowsSet) discoveryPayload.command_template = compositePathCommandTemplate(path, "{{ value }}");
@@ -1468,7 +1471,7 @@ export class HomeAssistant extends Extension {
         // This takes precedence over definitions in this file.
         if (firstExpose.category === "config" || firstExpose.category === "diagnostic") {
             for (const entry of discoveryEntries) {
-                entry.discovery_payload.entity_category = firstExpose.category;
+                entry.discovery_payload.entity_category ??= firstExpose.category;
             }
         }
 
@@ -1985,7 +1988,10 @@ export class HomeAssistant extends Extension {
 
             if (entity.isDevice()) {
                 try {
-                    entity.definition?.meta?.overrideHaDiscoveryPayload?.(payload);
+                    const overrideHaDiscoveryPayload = entity.definition?.meta?.overrideHaDiscoveryPayload as
+                        | ((payload: KeyValue, options: KeyValue) => void)
+                        | undefined;
+                    overrideHaDiscoveryPayload?.(payload, entity.options);
                 } catch (error) {
                     logger.error(`Failed to override HA discovery payload (${(error as Error).stack})`);
                 }

test/extensions/homeassistant.test.ts

@@ -1008,13 +1008,15 @@ describe("Extension: HomeAssistant", () => {
                 property: "network",
                 label: "Network",
                 access: 3,
+                category: "config",
                 features: [
                     {
                         type: "numeric",
                         name: "timeout",
                         property: "timeout",
                         label: "Timeout",
                         access: 3,
+                        category: "config",
                         unit: "min",
                         value_min: 1,
                         value_max: 60,
@@ -1026,6 +1028,7 @@ describe("Extension: HomeAssistant", () => {
                         property: "temperature",
                         label: "Temperature",
                         access: 1,
+                        category: "diagnostic",
                         unit: "°C",
                     },
                     {
@@ -1091,24 +1094,28 @@ describe("Extension: HomeAssistant", () => {
                 value_template:
                     '{% if value_json["network"] is defined and value_json["network"]["timeout"] is defined %}{{ value_json["network"]["timeout"] }}{% endif %}',
                 command_template: '{"network": {"timeout": {{ value }}}}',
+                entity_category: "config",
                 unit_of_measurement: "min",
                 min: 1,
                 max: 60,
                 step: 1,
             });
             expect(configs.find((config) => config.object_id === "network_temperature")?.discovery_payload).toMatchObject({
+                entity_category: "diagnostic",
                 unit_of_measurement: "°C",
                 device_class: "temperature",
                 state_class: "measurement",
             });
             expect(configs.find((config) => config.object_id === "network_mode")?.discovery_payload).toMatchObject({
                 command_template: '{"network": {"mode": {{ value | tojson }}}}',
+                entity_category: "config",
                 options: ["auto", "manual"],
             });
             expect(configs.find((config) => config.object_id === "network_advanced_enabled")?.discovery_payload).toMatchObject({
                 value_template:
                     '{% if value_json["network"] is defined and value_json["network"]["advanced"] is defined and value_json["network"]["advanced"]["enabled"] is defined %}{{ value_json["network"]["advanced"]["enabled"] | string | lower }}{% endif %}',
                 command_template: '{"network": {"advanced": {"enabled": {{ value }}}}}',
+                entity_category: "config",
                 payload_on: "true",
                 payload_off: "false",
             });
@@ -1375,6 +1382,18 @@ describe("Extension: HomeAssistant", () => {
         overrideSpy.mockRestore();
     });
 
+    it("passes device options to discovery payload overrides", async () => {
+        const bosch = getZ2MEntity(devices.BTH_RM230Z) as Device;
+        assert(typeof bosch.definition?.meta?.overrideHaDiscoveryPayload === "function");
+        const overrideSpy = vi.spyOn(bosch.definition.meta, "overrideHaDiscoveryPayload") as MockInstance;
+        settings.set(["devices", "0x18fc2600000d7ae3", "expose_cooling"], true);
+
+        await resetExtension();
+
+        expect(overrideSpy).toHaveBeenCalledWith(expect.any(Object), expect.objectContaining({expose_cooling: true}));
+        overrideSpy.mockRestore();
+    });
+
     it("Should discover Bosch BTH-RM230Z with a current_humidity attribute", () => {
         const payload = {
             action_template: