fix: De-conflict Sonoff dongles discovery (#1377)

Author: Nerivec

src/adapter/adapterDiscovery.ts

@@ -100,14 +100,22 @@ const USB_FINGERPRINTS: Record<DiscoverableUsbAdapter, UsbAdapterFingerprint[]>
             pathRegex: '.*slzb-07mg24.*',
         },
         {
-            // Sonoff ZBDongle-E V2
+            // Sonoff ZBDongle-E V2 (CH variant)
             vendorId: '1a86',
             productId: '55d4',
             manufacturer: 'ITEAD',
             // /dev/serial/by-id/usb-ITEAD_SONOFF_Zigbee_3.0_USB_Dongle_Plus_V2_20240122184111-if00
             // /dev/serial/by-id/usb-ITead_Sonoff_Zigbee_3.0_USB_Dongle_Plus_186ff44314e2ed11b891eb5162c61111-if00-port0
             pathRegex: '.*sonoff.*plus.*',
         },
+        {
+            // Sonoff ZBDongle-E V2 (CP variant)
+            vendorId: '10c4',
+            productId: 'ea60',
+            manufacturer: 'ITEAD',
+            // /dev/serial/by-id/usb-Itead_Sonoff_Zigbee_3.0_USB_Dongle_Plus_V2_a6ee897e4d1fef11aa004ad0639e525b-if00-port0
+            pathRegex: '.*sonoff.*plus_v2_.*',
+        },
         // {
         //     // TODO: Z-station by z-wave.me (EFR32MG21A020F1024IM32)
         //     vendorId: '',
@@ -140,7 +148,7 @@ const USB_FINGERPRINTS: Record<DiscoverableUsbAdapter, UsbAdapterFingerprint[]>
             manufacturer: 'ITEAD',
             // /dev/serial/by-id/usb-Silicon_Labs_Sonoff_Zigbee_3.0_USB_Dongle_Plus_0111-if00-port0
             // /dev/serial/by-id/usb-ITead_Sonoff_Zigbee_3.0_USB_Dongle_Plus_b8b49abd27a6ed11a280eba32981d111-if00-port0
-            pathRegex: '.*sonoff.*plus.*',
+            pathRegex: '.*sonoff.*plus(?!_v2_).*',
         },
         {
             // CC2538
@@ -297,7 +305,7 @@ function matchUsbFingerprint(
 ): [path: PortInfo['path'], score: number] | undefined {
     if (!portInfo.vendorId || !portInfo.productId) {
         // port info is missing essential information for proper matching, ignore it
-        return;
+        return undefined;
     }
 
     let match: UsbAdapterFingerprint | undefined;
@@ -346,7 +354,20 @@ function matchUsbFingerprint(
     }
 
     // poor match only returned if port info not conflict-prone
-    return match && (score > UsbFingerprintMatchScore.VID_PID || !conflictProne) ? [portInfo.path, score] : undefined;
+    if (match) {
+        if (score > UsbFingerprintMatchScore.VID_PID) {
+            if (conflictProne && score < UsbFingerprintMatchScore.VID_PID_PATH && matchString(match.manufacturer!, 'itead')) {
+                // can't trust metadata "only" on sonoff dongles with conflicts
+                return undefined;
+            }
+
+            return [portInfo.path, score];
+        } else if (!conflictProne) {
+            return [portInfo.path, score];
+        }
+    }
+
+    return undefined;
 }
 
 export async function matchUsbAdapter(adapter: Adapter, path: string): Promise<boolean> {

test/adapter/adapter.test.ts

@@ -16,6 +16,7 @@ import {
     DECONZ_CONBEE_II,
     EMBER_SKYCONNECT,
     EMBER_ZBDONGLE_E,
+    EMBER_ZBDONGLE_E_CP,
     ZBOSS_NORDIC,
     ZIGATE_PLUSV2,
     ZSTACK_CC2538,
@@ -167,7 +168,7 @@ describe('Adapter', () => {
         // on Windows
         mockPlatform.mockReturnValueOnce('win32');
         vi.spyOn(SerialPort, 'list').mockResolvedValueOnce([
-            Object.assign({pnpId: 'zbdongle-e', serialNumber: '', locationId: '', friendlyName: 'silicon labs cp210x'}, EMBER_ZBDONGLE_E),
+            Object.assign({pnpId: 'zbdongle-e', serialNumber: '', locationId: '', friendlyName: 'silicon labs cp210x'}, EMBER_ZBDONGLE_E_CP),
         ]);
         // `name` in `txt`, no `addresses`
         mockBonjourResult.mockImplementationOnce((type) => ({
@@ -196,7 +197,7 @@ describe('Adapter', () => {
         await expect(p).resolves.toStrictEqual([
             {
                 name: 'silicon labs cp210x (ITEAD)',
-                path: '/dev/serial/by-id/usb-ITEAD_SONOFF_Zigbee_3.0_USB_Dongle_Plus_V2_20240122184111-if00',
+                path: EMBER_ZBDONGLE_E_CP.path,
                 adapter: undefined,
             },
             {
@@ -514,6 +515,14 @@ describe('Adapter', () => {
 
                 listSpy.mockReturnValueOnce([{...ZSTACK_ZBDONGLE_P, path: '/dev/ttyACM0'}]);
 
+                await expect(Adapter.create({panID: 0x1a62, channelList: [11]}, {}, 'test.db.backup', {disableLED: false})).rejects.toThrow(
+                    `USB adapter discovery error (No valid USB adapter found). Specify valid 'adapter' and 'port' in your configuration.`,
+                );
+
+                listSpy.mockReturnValueOnce([
+                    {...ZSTACK_ZBDONGLE_P, path: '/dev/ttyACM0', pnpId: ZSTACK_ZBDONGLE_P.path.replace('/dev/serial/by-id/', '')},
+                ]);
+
                 adapter = await Adapter.create({panID: 0x1a62, channelList: [11]}, {}, 'test.db.backup', {disableLED: false});
 
                 expect(adapter).toBeInstanceOf(ZStackAdapter);
@@ -523,6 +532,28 @@ describe('Adapter', () => {
                     adapter: 'zstack',
                 });
 
+                listSpy.mockReturnValueOnce([ZSTACK_ZBDONGLE_P]);
+
+                adapter = await Adapter.create({panID: 0x1a62, channelList: [11]}, {}, 'test.db.backup', {disableLED: false});
+
+                expect(adapter).toBeInstanceOf(ZStackAdapter);
+                // @ts-expect-error protected
+                expect(adapter.serialPortOptions).toStrictEqual({
+                    path: ZSTACK_ZBDONGLE_P.path,
+                    adapter: 'zstack',
+                });
+
+                listSpy.mockReturnValueOnce([EMBER_ZBDONGLE_E_CP]);
+
+                adapter = await Adapter.create({panID: 0x1a62, channelList: [11]}, {}, 'test.db.backup', {disableLED: false});
+
+                expect(adapter).toBeInstanceOf(EmberAdapter);
+                // @ts-expect-error protected
+                expect(adapter.serialPortOptions).toStrictEqual({
+                    path: EMBER_ZBDONGLE_E_CP.path,
+                    adapter: 'ember',
+                });
+
                 listSpy.mockReturnValueOnce([ZSTACK_SMLIGHT_SLZB_06P10]);
 
                 adapter = await Adapter.create({panID: 0x1a62, channelList: [11]}, {}, 'test.db.backup', {disableLED: false});

test/mockAdapters.ts

@@ -5,11 +5,19 @@ export const DECONZ_CONBEE_II = {
     manufacturer: 'dresden elektronik ingenieurtechnik GmbH',
 };
 export const EMBER_ZBDONGLE_E = {
+    // may or may not have `V2` (bad metadata in some batches)
     path: '/dev/serial/by-id/usb-ITEAD_SONOFF_Zigbee_3.0_USB_Dongle_Plus_V2_20240122184111-if00',
     vendorId: '1A86', // uppercased for extra coverage
     productId: '55d4',
     manufacturer: 'ITEAD',
 };
+export const EMBER_ZBDONGLE_E_CP = {
+    // may or may not have `V2` (bad metadata in some batches)
+    path: '/dev/serial/by-id/usb-Itead_Sonoff_Zigbee_3.0_USB_Dongle_Plus_V2_a6ee897e4d1fef11aa004ad0639e525b-if00-port0',
+    vendorId: '10c4',
+    productId: 'ea60',
+    manufacturer: 'ITEAD',
+};
 // vendorId+productId conflict with all 10c4:ea60
 export const EMBER_SKYCONNECT = {
     path: '/dev/serial/by-id/usb-Nabu_Casa_SkyConnect_v1.0_3abe54797c91ed118fc3cad13b20a111-if00-port0',
@@ -25,7 +33,7 @@ export const ZSTACK_CC2538 = {
 };
 // vendorId+productId conflict with all 10c4:ea60
 export const ZSTACK_ZBDONGLE_P = {
-    path: '/dev/serial/by-id/usb-Silicon_Labs_Sonoff_Zigbee_3.0_USB_Dongle_Plus_0111-if00-port0',
+    path: '/dev/serial/by-id/usb-ITead_Sonoff_Zigbee_3.0_USB_Dongle_Plus_b8b49abd27a6ed11a280eba32981d111-if00-port0',
     vendorId: '10c4',
     productId: 'ea60',
     manufacturer: 'ITEAD',