feat: Improve multi-endpoint support for lights (#8031)

* Add exposeEndpoints utility function

* Make modernExtend and philipsLight multi-endpoint aware

Author: mundschenk-at

src/lib/modernExtend.ts

@@ -33,6 +33,7 @@ import {
     assertNumber,
     batteryVoltageToPercentage,
     configureSetPowerSourceWhenUnknown,
+    exposeEndpoints,
     flatten,
     getEndpointName,
     getFromLookup,
@@ -469,7 +470,7 @@ export interface OnOffArgs {
 export function onOff(args?: OnOffArgs): ModernExtend {
     args = {powerOnBehavior: true, skipDuplicateTransaction: false, configureReporting: true, ...args};
 
-    const exposes: Expose[] = args.endpointNames ? args.endpointNames.map((ep) => e.switch().withEndpoint(ep)) : [e.switch()];
+    const exposes: Expose[] = exposeEndpoints(e.switch(), args.endpointNames);
 
     const fromZigbee: Fz.Converter[] = [args.skipDuplicateTransaction ? fz.on_off_skip_duplicate_transaction : fz.on_off];
     const toZigbee: Tz.Converter[] = [tz.on_off];
@@ -943,9 +944,7 @@ export function light(args?: LightArgs): ModernExtend {
           }
         : false;
 
-    const lightExpose = args.endpointNames
-        ? args.endpointNames.map((ep) => e.light().withBrightness().withEndpoint(ep))
-        : [e.light().withBrightness()];
+    const lightExpose = exposeEndpoints(e.light().withBrightness(), args.endpointNames);
 
     const fromZigbee: Fz.Converter[] = [fz.on_off, fz.brightness, fz.ignore_basic_report, fz.level_config];
     const toZigbee: Tz.Converter[] = [
@@ -1001,12 +1000,13 @@ export function light(args?: LightArgs): ModernExtend {
         if (args.color) {
             effects.values.push('colorloop', 'stop_colorloop');
         }
-        exposes.push(effects);
+
+        exposes.push(...exposeEndpoints(effects, args.endpointNames));
         toZigbee.push(tz.effect);
     }
 
     if (args.powerOnBehavior) {
-        exposes.push(e.power_on_behavior(['off', 'on', 'toggle', 'previous']));
+        exposes.push(...exposeEndpoints(e.power_on_behavior(['off', 'on', 'toggle', 'previous']), args.endpointNames));
         fromZigbee.push(fz.power_on_behavior);
         toZigbee.push(tz.power_on_behavior);
     }

src/lib/philips.ts

@@ -10,7 +10,7 @@ import * as ota from './ota';
 import * as globalStore from './store';
 import {Fz, KeyValue, KeyValueAny, Tz} from './types';
 import * as utils from './utils';
-import {isObject} from './utils';
+import {exposeEndpoints, isObject} from './utils';
 
 const NS = 'zhc:philips';
 const ea = exposes.access;
@@ -71,12 +71,15 @@ export function philipsLight(args?: modernExtend.LightArgs & {hueEffect?: boolea
             }
             result.exposes.push(
                 // gradient_scene is deprecated, use gradient instead
-                e.enum('gradient_scene', ea.SET, Object.keys(gradientScenes)),
-                e
-                    .list('gradient', ea.ALL, e.text('hex', ea.ALL).withDescription('Color in RGB HEX format (eg #663399)'))
-                    .withLengthMin(1)
-                    .withLengthMax(9)
-                    .withDescription('List of RGB HEX colors'),
+                ...exposeEndpoints(e.enum('gradient_scene', ea.SET, Object.keys(gradientScenes)), args.endpointNames),
+                ...exposeEndpoints(
+                    e
+                        .list('gradient', ea.ALL, e.text('hex', ea.ALL).withDescription('Color in RGB HEX format (eg #663399)'))
+                        .withLengthMin(1)
+                        .withLengthMax(9)
+                        .withDescription('List of RGB HEX colors'),
+                    args.endpointNames,
+                ),
             );
             result.configure.push(async (device, coordinatorEndpoint, definition) => {
                 for (const ep of device.endpoints.filter((ep) => ep.supportsInputCluster('manuSpecificPhilips2'))) {
@@ -85,7 +88,7 @@ export function philipsLight(args?: modernExtend.LightArgs & {hueEffect?: boolea
             });
         }
         effects.push('finish_effect', 'stop_effect', 'stop_hue_effect');
-        result.exposes.push(e.enum('effect', ea.SET, effects));
+        result.exposes.push(...exposeEndpoints(e.enum('effect', ea.SET, effects), args.endpointNames));
     }
     return result;
 }

src/lib/utils.ts

@@ -244,6 +244,10 @@ export function postfixWithEndpointName(value: string, msg: Fz.Message, definiti
     return value;
 }
 
+export function exposeEndpoints<T extends Expose>(expose: T, endpointNames?: string[]): T[] {
+    return endpointNames ? (endpointNames.map((ep) => expose.clone().withEndpoint(ep)) as T[]) : [expose];
+}
+
 export function enforceEndpoint(entity: Zh.Endpoint, key: string, meta: Tz.Meta) {
     // @ts-expect-error ignore
     const multiEndpointEnforce: {[s: string]: number} = getMetaValue(entity, meta.mapped, 'multiEndpointEnforce', 'allEqual', []);

test/modernExtend.test.ts

@@ -314,7 +314,16 @@ describe('ModernExtend', () => {
                 'osram_set_transition',
                 'osram_remember_state',
             ],
-            exposes: ['action', 'effect', 'light_l1(state,brightness)', 'light_l2(state,brightness)', 'light_s1(state,brightness)', 'linkquality'],
+            exposes: [
+                'action',
+                'effect',
+                'effect',
+                'effect',
+                'light_l1(state,brightness)',
+                'light_l2(state,brightness)',
+                'light_s1(state,brightness)',
+                'linkquality',
+            ],
             bind: {
                 10: ['genOnOff', 'genLevelCtrl'],
                 11: ['genOnOff', 'genLevelCtrl'],