From aaad0ebf61744bf177235bac7ffc298b454c222a Mon Sep 17 00:00:00 2001
From: swevictor <victor@hagelback.com>
Date: Sun, 16 Oct 2022 14:40:15 +0200
Subject: [PATCH] Add description to device types to improve clarity

---
 plejd/PlejdApi.js               | 19 ++++++++++++-------
 plejd/types/DeviceRegistry.d.ts |  2 ++
 2 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/plejd/PlejdApi.js b/plejd/PlejdApi.js
index c0887e4..4c847f8 100644
--- a/plejd/PlejdApi.js
+++ b/plejd/PlejdApi.js
@@ -451,9 +451,9 @@ class PlejdApi {
           // dimmable = settings.dimCurve !== 'NonDimmable';
 
           try {
-            const { name: typeName, type: deviceType } = this._getDeviceType(plejdDevice);
+            const decodedDeviceType = this._getDeviceType(plejdDevice);
 
-            let loadType = deviceType;
+            let loadType = decodedDeviceType.type;
             if (device.outputType === 'RELAY') {
               loadType = 'switch';
             } else if (device.outputType === 'LIGHT') {
@@ -474,7 +474,8 @@ class PlejdApi {
               roomName: roomTitle,
               state: undefined,
               type: loadType,
-              typeName,
+              typeDescription: decodedDeviceType.description,
+              typeName: decodedDeviceType.name,
               version: plejdDevice.firmware.version,
               uniqueId: uniqueOutputId,
             };
@@ -509,8 +510,9 @@ class PlejdApi {
           const uniqueInputId = this.deviceRegistry.getUniqueInputId(device.deviceId, input.input);
 
           try {
-            const { name: typeName, type, broadcastClicks } = this._getDeviceType(plejdDevice);
-            if (broadcastClicks) {
+            const decodedDeviceType = this._getDeviceType(plejdDevice);
+
+            if (decodedDeviceType.broadcastClicks) {
               /** @type {import('types/DeviceRegistry').InputDevice} */
               const inputDevice = {
                 bleInputAddress,
@@ -518,8 +520,9 @@ class PlejdApi {
                 name: device.title,
                 input: input.input,
                 roomId: device.roomId,
-                type,
-                typeName,
+                type: decodedDeviceType.type,
+                typeDescription: decodedDeviceType.description,
+                typeName: decodedDeviceType.name,
                 version: plejdDevice.firmware.version,
                 uniqueId: uniqueInputId,
               };
@@ -560,6 +563,7 @@ class PlejdApi {
           roomName: undefined,
           state: undefined,
           type: 'light',
+          typeDescription: 'A Plejd room',
           typeName: 'Room',
           uniqueId: roomId,
           version: undefined,
@@ -589,6 +593,7 @@ class PlejdApi {
         roomName: undefined,
         state: false,
         type: 'scene',
+        typeDescription: 'A Plejd scene',
         typeName: 'Scene',
         version: undefined,
         uniqueId: scene.sceneId,
diff --git a/plejd/types/DeviceRegistry.d.ts b/plejd/types/DeviceRegistry.d.ts
index 7a86661..5eba5c8 100644
--- a/plejd/types/DeviceRegistry.d.ts
+++ b/plejd/types/DeviceRegistry.d.ts
@@ -13,6 +13,7 @@ export interface OutputDevice {
   roomName: string | undefined;
   state: boolean | undefined;
   type: string;
+  typeDescription: string;
   typeName: string;
   version: string;
   uniqueId: string;
@@ -27,6 +28,7 @@ export interface InputDevice {
   input: number;
   roomId: string;
   type: string;
+  typeDescription: string;
   typeName: string;
   version: string;
   uniqueId: string;