Add support LED call. Koenkk/zigbee2mqtt#1429

Koenkk · Oct 16, 2019 · fc75484 · fc75484
1 parent a6d5f32
commit fc75484
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 4 deletions.
diff --git a/docs/api/classes/_controller_controller_.controller.md b/docs/api/classes/_controller_controller_.controller.md
@@ -30,6 +30,7 @@
 * [setLED](_controller_controller_.controller.md#setled)
 * [start](_controller_controller_.controller.md#start)
 * [stop](_controller_controller_.controller.md#stop)
+* [supportsLED](_controller_controller_.controller.md#supportsled)
 
 ## Constructors
 
@@ -215,7 +216,7 @@ ___
 
 ▸ **setLED**(`enabled`: boolean): *Promise‹void›*
 
-*Defined in [controller/controller.ts:244](https://github.com/Koenkk/zigbee-herdsman/blob/master/src/controller/controller.ts#L244)*
+*Defined in [controller/controller.ts:251](https://github.com/Koenkk/zigbee-herdsman/blob/master/src/controller/controller.ts#L251)*
 
  Enable/Disable the LED
 
@@ -248,3 +249,15 @@ ___
 *Defined in [controller/controller.ts:155](https://github.com/Koenkk/zigbee-herdsman/blob/master/src/controller/controller.ts#L155)*
 
 **Returns:** *Promise‹void›*
+
+___
+
+###  supportsLED
+
+▸ **supportsLED**(): *Promise‹boolean›*
+
+*Defined in [controller/controller.ts:244](https://github.com/Koenkk/zigbee-herdsman/blob/master/src/controller/controller.ts#L244)*
+
+ Check if the adapters supports LED
+
+**Returns:** *Promise‹boolean›*
diff --git a/src/adapter/adapter.ts b/src/adapter/adapter.ts
@@ -71,6 +71,8 @@ abstract class Adapter extends events.EventEmitter {
 
     public abstract reset(type: 'soft' | 'hard'): Promise<void>;
 
+    public abstract supportsLED(): Promise<boolean>;
+
     public abstract setLED(enabled: boolean): Promise<void>;
 
     public abstract lqi(networkAddress: number): Promise<TsType.LQI>;

diff --git a/src/adapter/z-stack/adapter/zStackAdapter.ts b/src/adapter/z-stack/adapter/zStackAdapter.ts
@@ -148,6 +148,10 @@ class ZStackAdapter extends Adapter {
         }
     }
 
+    public async supportsLED(): Promise<boolean> {
+        return this.version.product !== ZnpVersion.zStack3x0;
+    }
+
     public async setLED(enabled: boolean): Promise<void> {
         await this.znp.request(Subsystem.UTIL, 'ledControl', {ledid: 3, mode: enabled ? 1 : 0});
     }

diff --git a/src/controller/controller.ts b/src/controller/controller.ts
@@ -238,10 +238,18 @@ class Controller extends events.EventEmitter {
         return Group.create(groupID);
     }
 
+    /**
+     *  Check if the adapters supports LED
+     */
+    public async supportsLED(): Promise<boolean> {
+        return this.adapter.supportsLED();
+    }
+
     /**
      *  Enable/Disable the LED
      */
     public async setLED(enabled: boolean): Promise<void> {
+        if (!(await this.supportsLED())) throw new Error(`Adapter doesn't support LED`);
         await this.adapter.setLED(enabled);
     }
 

diff --git a/test/adapter/z-stack/zStackAdapter.test.ts b/test/adapter/z-stack/zStackAdapter.test.ts
@@ -1610,6 +1610,12 @@ describe('zStackAdapter', () => {
         expect(mockZnpRequest).toBeCalledWith(Subsystem.UTIL, 'ledControl', {ledid: 3, mode: 1});
     });
 
+    it('Supports led', async () => {
+        basicMocks();
+        await adapter.start();
+        expect(await adapter.supportsLED()).toBeTruthy();
+    });
+
     it('Node descriptor', async () => {
         basicMocks();
         let result;

diff --git a/test/controller.test.ts b/test/controller.test.ts
@@ -21,7 +21,8 @@ const mockAdapterSupportsBackup = jest.fn().mockReturnValue(true);
 const mockAdapterReset = jest.fn();
 const mockAdapterStop = jest.fn();
 const mockAdapterStart = jest.fn().mockReturnValue('resumed');
-const mockSetLED = jest.fn();
+const mockAdapterSetLED = jest.fn();
+const mockAdapterSupportsLED = jest.fn().mockReturnValue(true);
 const mockAdapterBind = jest.fn();
 const mockSendZclFrameGroup = jest.fn();
 const mockAdapterUnbind = jest.fn();
@@ -130,7 +131,8 @@ jest.mock('../src/adapter/z-stack/adapter/zStackAdapter', () => {
             backup: () => {return {version: 'dummybackup'}},
             getCoordinatorVersion: () => {return {type: 'zStack', meta: {version: 1}}},
             getNetworkParameters: () => {return {panID: 1, extenedPanID: 3, channel: 15}},
-            setLED: mockSetLED,
+            setLED: mockAdapterSetLED,
+            supportsLED: mockAdapterSupportsLED,
             nodeDescriptor: async (networkAddress) => {
                 if (mockDevices[networkAddress].nodeDescriptor === 'xiaomi') {
                     await mockAdapterEvents['zclData']({
@@ -306,7 +308,17 @@ describe('Controller', () => {
     it('Disable led', async () => {
         await controller.start();
         await controller.setLED(false);
-        expect(mockSetLED).toBeCalledTimes(1);
+        expect(mockAdapterSetLED).toBeCalledTimes(1);
+    });
+
+    it('Throw error when not supports LED', async () => {
+        await controller.start();
+        mockAdapterSupportsLED.mockReturnValueOnce(false);
+        expect(await controller.supportsLED()).toBeFalsy();
+        mockAdapterSupportsLED.mockReturnValueOnce(false);
+        let error;
+        try {await controller.setLED(false)} catch (e) {error = e;}
+        expect(error).toStrictEqual(new Error(`Adapter doesn't support LED`));
     });
 
     it('Get coordinator version', async () => {