homebridge-kasa-python 1.0.1 → 2.0.0

package/README.md

@@ -16,20 +16,32 @@
   <a href="https://www.npmjs.com/package/homebridge-kasa-python"><img src="https://badgen.net/npm/dt/homebridge-kasa-python" alt="npm downloads total"></a>
   <a href="https://www.npmjs.com/package/homebridge-kasa-python"><img src="https://badgen.net/npm/dm/homebridge-kasa-python" alt="npm downloads monthly"></a>
   <a href="https://www.paypal.me/ZeliardM/USD/"><img src="https://badgen.net/badge/donate/paypal/E69138" alt="donate"></a>
+  <a href="https://github.com/sponsors/ZeliardM"><img src="https://badgen.net/badge/donate/github/E69138" alt="donate"></a>
   <a href="https://pypi.org/project/python-kasa/"><img src="https://img.shields.io/badge/Python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue" alt="PyPI pyversions"></a>
 </p>
 
+<div align="center">
+
+> ## IMPORTANT!!!
+>This Plug-In Has Only Been Configured And Tested On Proxmox LXC. I Have Not Tested This On Any Other Platforms. If You Install It On Another Platform and It Works, Please Let Me Know So It Can Be Added To The List Of Supported Platforms.</p>
+>Updates To Code Require Cached Accessories To Be Removed To Update Naming Conventions For Homebridge 2.0 Update.
+
+</div>
+
 This is a [Homebridge](https://github.com/homebridge/homebridge) plug-in based on the Python-Kasa API Library to interact with TP-Link Kasa Devices.
 
-This plug-in automatically discovers your TP-Link Kasa Devices on your network and configures them to be used in HomeKit.
+This plug-in will automatically discover your TP-Link Kasa Devices on your network locally only and configure them to be used in HomeKit.
+
+Automatic Discovery is possible only for some devices, some newer devices require the Username and Password for your TP-Link Kasa Cloud Account. Credentials can be provided in the plug-in settings.
 
-Automatic Discovery is possible only for some devices, some newer devices require the Username and Password for your TP-Link Kasa Cloud Account.
+### Current Supported and Tested Devices
+-   I currently have used this plug-in with the HS300 (US) Power Strip and the KP115 (US) Plug. All other devices are yet to be tested and fully supported. If you have a device that is a plug or power strip and it does work as expected in HomeKit, please let me know and I can add it to the list of tested and supported devices. I don't have a lot of devices so cannot fully test everything.
 
 ### Features
 
--   Automatically discover TP-Link Kasa Devices on your network.
--   Change Device States for Plugs, Change Device State and Supports Dimming for Switches, Change Device State, and Supports Hue, Saturation, and Value (HSV), Color, and Temperature Adjustments for Bulbs that Support those options.
--   Supported Devices are listed below, Devices with an asterisks ('*') next to the specific firmware will require the Username and Password for your TP-Link Kasa Cloud Account to connect and function.
+-   Automatically discover TP-Link Kasa Devices locally only on your network.
+-   Change Device States for Plugs, Change Device States for Power Strips, Change Device State and Supports Dimming for Switches, Change Device State and Supports Hue, Saturation, and Value (HSV), Color, Color Temperature Adjustments, and Dimming for Bulbs and Light Strips that support those options.</p>*NOTE - Not All Functions Are Currently Supported, All Devices and Functions Could Be Supported By The Plug-In In The Furture.*</p>
+-   Supported Devices from the API are listed below, Devices with an asterisks ('*') next to the specific firmware will require the Username and Password for your TP-Link Kasa Cloud Account to connect and function correctly.</p>*NOTE - Not All Devices Listed Below Are Supported By This Plug-In. These Devices Are Supported By The Python-Kasa API And Could Be Supported By The Plug-In In The Future.*</p>
 <div align="center">
 <table style="border-collapse: collapse; border: 1px solid black;">
   <thead>
@@ -395,4 +407,7 @@ Automatic Discovery is possible only for some devices, some newer devices requir
     </tr>
   </tbody>
 </table>
-</div>
+</div>
+
+### Credits
+-   Huge thanks to GadgetReactor for the [Python-Kasa API](https://github.com/python-kasa/python-kasa), Donald Patrick Seal for the [Unofficial API documentation](https://github.com/plasticrake/tplink-smarthome-api), and Maximilian Leith for [Excellent Python Implementation](https://github.com/maxileith/homebridge-appletv-enhanced).

package/config.schema.json

@@ -37,27 +37,12 @@
         "description": "Enable to create a single power strip accessory with multiple outlets, used for models HS107, KP200, HS300, KP303, KP400, and EP40. Default: false",
         "default": false
       },
-      "discoveryPort": {
-        "title": "Port",
-        "type": "number",
-        "required": false,
-        "description": "Port to bind UDP socket for discovery. If port is not specified or is 0, the operating system will attempt to bind to a random port. Default: 0",
-        "placeholder": "0"
-      },
-      "broadcastAddress": {
-        "title": "Broadcast Address",
-        "type": "string",
-        "required": false,
-        "description": "Broadcast Address. If discovery is not working tweak to match your subnet, eg: 192.168.1.255",
-        "placeholder": "255.255.255.255",
-        "format": "ipv4"
-      },
       "pollingInterval": {
         "title": "Polling Interval (seconds)",
         "type": "integer",
         "required": false,
         "description": "How often to check device status in the background (seconds)",
-        "placeholder": "10"
+        "placeholder": "5"
       },
       "includeMacAddresses": {
         "title": "Include MAC Addresses",
@@ -92,12 +77,6 @@
               "required": true,
               "placeholder": "192.168.1.1",
               "format": "ipv4"
-            },
-            "port": {
-              "title": "Port",
-              "type": "string",
-              "required": false,
-              "placeholder": "9999"
             }
           }
         }
@@ -116,13 +95,6 @@
         "description": "Here you can specify a path that points to a python executable. The plugin uses the systems default python as default. Setting a specific python executable here may be required if your systems default python version is too current for the plugin.",
         "placeholder": "/path/to/python3"
       },
-      "timeout": {
-        "title": "Timeout (seconds)",
-        "type": "integer",
-        "required": false,
-        "description": "Communication Timeout (seconds)",
-        "placeholder": "15"
-      },
       "waitTimeUpdate": {
         "title": "Wait Time Update (milliseconds)",
         "type": "integer",
@@ -155,9 +127,7 @@
       "description": "Customize device discovery",
       "expandable": true,
       "items": [
-        "broadcastAddress",
         "pollingInterval",
-        "discoveryPort",
         {
           "key": "includeMacAddresses",
           "type": "array",
@@ -188,7 +158,7 @@
               "key": "devices",
               "type": "array",
               "buttonText": "Add Device",
-              "items": ["devices[].host", "devices[].port"]
+              "items": ["devices[].host"]
             },
             {
               "type": "help",
@@ -206,7 +176,6 @@
       "items": [
         "pythonExecutable",
         "forceVenvRecreate",
-        "timeout",
         "waitTimeUpdate"
       ]
     }

package/dist/accessoryInformation.d.ts

@@ -1,3 +1,3 @@
 import type { HAP, PlatformAccessory, Service } from 'homebridge';
 import type HomekitDevice from './devices/index.js';
-export default function accessoryInformation(hap: HAP): (accessory: PlatformAccessory, hkDevice: HomekitDevice) => Service | undefined;
+export default function accessoryInformation(hap: HAP): (accessory: PlatformAccessory, homekitDevice: HomekitDevice) => Service | undefined;

package/dist/accessoryInformation.js

@@ -1,23 +1,19 @@
 export default function accessoryInformation(hap) {
-    const { Characteristic } = hap;
-    return (accessory, hkDevice) => {
-        const infoService = accessory.getService(hap.Service.AccessoryInformation);
-        if (infoService === undefined) {
-            return undefined;
-        }
-        if (!infoService.getCharacteristic(Characteristic.FirmwareRevision)) {
-            infoService.addCharacteristic(Characteristic.FirmwareRevision);
-        }
-        if (!infoService.getCharacteristic(Characteristic.HardwareRevision)) {
-            infoService.addCharacteristic(Characteristic.HardwareRevision);
-        }
+    const { Characteristic, Service: { AccessoryInformation } } = hap;
+    return (accessory, homekitDevice) => {
+        const infoService = accessory.getService(AccessoryInformation) ?? accessory.addService(AccessoryInformation);
+        [Characteristic.Name, Characteristic.Manufacturer, Characteristic.Model, Characteristic.SerialNumber, Characteristic.FirmwareRevision]
+            .forEach(characteristic => {
+            if (!infoService.getCharacteristic(characteristic)) {
+                infoService.addCharacteristic(characteristic);
+            }
+        });
         infoService
-            .setCharacteristic(Characteristic.Name, hkDevice.name)
-            .setCharacteristic(Characteristic.Manufacturer, hkDevice.manufacturer)
-            .setCharacteristic(Characteristic.Model, hkDevice.model)
-            .setCharacteristic(Characteristic.SerialNumber, hkDevice.serialNumber)
-            .setCharacteristic(Characteristic.FirmwareRevision, hkDevice.firmwareRevision)
-            .setCharacteristic(Characteristic.HardwareRevision, hkDevice.hardwareRevision);
+            .setCharacteristic(Characteristic.Name, homekitDevice.name)
+            .setCharacteristic(Characteristic.Manufacturer, homekitDevice.manufacturer)
+            .setCharacteristic(Characteristic.Model, homekitDevice.model)
+            .setCharacteristic(Characteristic.SerialNumber, homekitDevice.serialNumber)
+            .setCharacteristic(Characteristic.FirmwareRevision, homekitDevice.firmwareRevision);
         return infoService;
     };
 }

package/dist/accessoryInformation.js.map

@@ -1 +1 @@
-{"version":3,"file":"accessoryInformation.js","sourceRoot":"","sources":["../src/accessoryInformation.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAC1C,GAAQ;IAKR,MAAM,EAAE,cAAc,EAAE,GAAG,GAAG,CAAC;IAE/B,OAAO,CAAC,SAA4B,EAAE,QAAuB,EAAE,EAAE;QAC/D,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC3E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpE,WAAW,CAAC,iBAAiB,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpE,WAAW,CAAC,iBAAiB,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACjE,CAAC;QACD,WAAW;aACR,iBAAiB,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;aACrD,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;aACrE,iBAAiB,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC;aACvD,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;aACrE,iBAAiB,CAChB,cAAc,CAAC,gBAAgB,EAC/B,QAAQ,CAAC,gBAAgB,CAC1B;aACA,iBAAiB,CAChB,cAAc,CAAC,gBAAgB,EAC/B,QAAQ,CAAC,gBAAgB,CAC1B,CAAC;QAEJ,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"accessoryInformation.js","sourceRoot":"","sources":["../src/accessoryInformation.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAC1C,GAAQ;IAER,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,EAAE,oBAAoB,EAAE,EAAE,GAAG,GAAG,CAAC;IAElE,OAAO,CAAC,SAA4B,EAAE,aAA4B,EAAE,EAAE;QACpE,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC,oBAAoB,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QAE7G,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,YAAY,EAAE,cAAc,CAAC,KAAK,EAAE,cAAc,CAAC,YAAY,EAAE,cAAc,CAAC,gBAAgB,CAAC;aACnI,OAAO,CAAC,cAAc,CAAC,EAAE;YACxB,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,CAAC;gBACnD,WAAW,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;YAChD,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,WAAW;aACR,iBAAiB,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC;aAC1D,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC;aAC1E,iBAAiB,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;aAC5D,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC;aAC1E,iBAAiB,CAAC,cAAc,CAAC,gBAAgB,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAEtF,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC"}

package/dist/categoriesParse.d.ts

@@ -0,0 +1,8 @@
+import KasaPythonPlatform from './platform.js';
+export declare class EnumParser {
+    private platform;
+    constructor(platform: KasaPythonPlatform);
+    private parseConstEnum;
+    private generateEnumObject;
+    parse(): Record<number, string> | null;
+}

package/dist/categoriesParse.js

@@ -0,0 +1,44 @@
+import ts from 'typescript';
+export class EnumParser {
+    platform;
+    constructor(platform) {
+        this.platform = platform;
+    }
+    parseConstEnum(sourceFile) {
+        const enums = {};
+        const visit = (node) => {
+            if (ts.isEnumDeclaration(node) &&
+                node.name.text === 'Categories' &&
+                node.modifiers?.some(modifier => modifier.kind === ts.SyntaxKind.ConstKeyword)) {
+                const enumName = node.name.text;
+                enums[enumName] = node.members.map(member => ({
+                    value: member.initializer && ts.isNumericLiteral(member.initializer) ? Number(member.initializer.text) : 0,
+                    name: ts.isIdentifier(member.name) ? member.name.text : '',
+                }));
+            }
+            ts.forEachChild(node, visit);
+        };
+        visit(sourceFile);
+        return enums;
+    }
+    generateEnumObject(enums) {
+        return Object.values(enums).reduce((acc, members) => {
+            members.forEach(member => {
+                acc[member.value] = member.name;
+            });
+            return acc;
+        }, {});
+    }
+    parse() {
+        const fileToParse = `${this.platform.storagePath}/node_modules/homebridge/node_modules/hap-nodejs/dist/lib/Accessory.d.ts`;
+        const program = ts.createProgram([fileToParse], {});
+        const sourceFile = program.getSourceFile(fileToParse);
+        if (!sourceFile) {
+            this.platform.log.error('Source file not found.');
+            return null;
+        }
+        const enums = this.parseConstEnum(sourceFile);
+        return this.generateEnumObject(enums);
+    }
+}
+//# sourceMappingURL=categoriesParse.js.map

package/dist/categoriesParse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"categoriesParse.js","sourceRoot":"","sources":["../src/categoriesParse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAG5B,MAAM,OAAO,UAAU;IACD;IAApB,YAAoB,QAA4B;QAA5B,aAAQ,GAAR,QAAQ,CAAoB;IAAG,CAAC;IAE5C,cAAc,CAAC,UAAyB;QAC9C,MAAM,KAAK,GAAsD,EAAE,CAAC;QAEpE,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,EAAE;YAC9B,IACE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC;gBAC1B,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY;gBAC/B,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAC9E,CAAC;gBACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAChC,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAC5C,KAAK,EAAE,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1G,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;iBAC3D,CAAC,CAAC,CAAC;YACN,CAAC;YACD,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,KAAK,CAAC,UAAU,CAAC,CAAC;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,kBAAkB,CAAC,KAAwD;QACjF,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;YAClD,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBACvB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;YAClC,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAA4B,CAAC,CAAC;IACnC,CAAC;IAEM,KAAK;QACV,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,0EAA0E,CAAC;QAC3H,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAEtD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAClD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;CACF"}

package/dist/config.d.ts

@@ -1,186 +1,43 @@
-import { ErrorObject as AjvErrorObject } from 'ajv';
+import { ErrorObject } from 'ajv';
 export declare class ConfigParseError extends Error {
-    readonly errors?: AjvErrorObject<string, Record<string, unknown>, unknown>[] | null | undefined;
-    readonly unknownError?: unknown | undefined;
-    /**
-     * Set by `Error.captureStackTrace`
-     */
-    readonly stack = "";
-    constructor(message: string, errors?: AjvErrorObject<string, Record<string, unknown>, unknown>[] | null | undefined, unknownError?: unknown | undefined);
+    errors?: (ErrorObject<string, Record<string, unknown>, unknown>[] | null) | undefined;
+    unknownError?: unknown;
+    constructor(message: string, errors?: (ErrorObject<string, Record<string, unknown>, unknown>[] | null) | undefined, unknownError?: unknown);
+    private formatMessage;
 }
 export interface DeviceConfigInput {
     host: string;
-    port?: number | undefined;
+    port?: number;
 }
 export interface KasaPythonConfigInput {
-    /**
-     * Username. If discovering devices is not working, try setting this to your Kasa Cloud Username.
-     * This is required for the following devices:
-     * EP25
-       - Hardware: 2.6 (US) / Firmware: 1.0.1
-       - Hardware: 2.6 (US) / Firmware: 1.0.2
-       HS100
-       - Hardware: 4.1 (UK) / Firmware: 1.1.0
-       KP125M
-       - Hardware: 1.0 (US) / Firmware: 1.1.3
-       HS220
-       - Hardware: 3.26 (US) / Firmware: 1.0.1
-       KS205
-       - Hardware: 1.0 (US) / Firmware: 1.0.2
-       - Hardware: 1.0 (US) / Firmware: 1.1.0
-       KS225
-       - Hardware: 1.0 (US) / Firmware: 1.0.2
-       - Hardware: 1.0 (US) / Firmware: 1.1.0
-       KS240
-       - Hardware: 1.0 (US) / Firmware: 1.0.4
-       - Hardware: 1.0 (US) / Firmware: 1.0.5
-       KH100
-       - Hardware: 1.0 (UK) / Firmware: 1.5.6
-       KE100
-       - Hardware: 1.0 (EU) / Firmware: 2.4.0
-       - Hardware: 1.0 (EU) / Firmware: 2.8.0
-       - Hardware: 1.0 (UK) / Firmware: 2.8.0
-     * @defaultValue ''
-     */
+    name?: string;
     username?: string;
-    /**
-     * Password. If discovering devices is not working, try setting this to your Kasa Cloud Password.
-     * This is required for the following devices:
-     * EP25
-       - Hardware: 2.6 (US) / Firmware: 1.0.1
-       - Hardware: 2.6 (US) / Firmware: 1.0.2
-       HS100
-       - Hardware: 4.1 (UK) / Firmware: 1.1.0
-       KP125M
-       - Hardware: 1.0 (US) / Firmware: 1.1.3
-       HS220
-       - Hardware: 3.26 (US) / Firmware: 1.0.1
-       KS205
-       - Hardware: 1.0 (US) / Firmware: 1.0.2
-       - Hardware: 1.0 (US) / Firmware: 1.1.0
-       KS225
-       - Hardware: 1.0 (US) / Firmware: 1.0.2
-       - Hardware: 1.0 (US) / Firmware: 1.1.0
-       KS240
-       - Hardware: 1.0 (US) / Firmware: 1.0.4
-       - Hardware: 1.0 (US) / Firmware: 1.0.5
-       KH100
-       - Hardware: 1.0 (UK) / Firmware: 1.5.6
-       KE100
-       - Hardware: 1.0 (EU) / Firmware: 2.4.0
-       - Hardware: 1.0 (EU) / Firmware: 2.8.0
-       - Hardware: 1.0 (UK) / Firmware: 2.8.0
-     * @defaultValue ''
-     */
     password?: string;
-    /**
-     * Create Multi-Outlet Devices as a Power Strip.
-     * Enable to create a single power strip accessory with multiple outlets, used for models HS107, KP200, HS300, KP303, KP400, and EP40.
-     * @defaultValue false
-     */
     powerStrip?: boolean;
-    /**
-     * Port to bind UDP socket for discovery.
-     * If port is not specified or is 0, the operating system will attempt to bind to a random port.
-     * @defaultValue 0
-     */
-    discoveryPort?: number;
-    /**
-     * Broadcast Address. If discovery is not working, tweak to match your subnet, eg: 192.168.1.255
-     * @defaultValue '255.255.255.255'
-     */
-    broadcastAddress?: string;
-    /**
-     * How often to check device status in the background (seconds)
-     * @defaultValue 10
-     */
     pollingInterval?: number;
-    /**
-     * Allow-list of MAC Addresses to include. If specified will ignore other devices.
-     * MAC Addresses are normalized, special characters are removed and made uppercase for comparison.
-     * Supports glob-style patterns
-     */
     includeMacAddress?: Array<string>;
-    /**
-     * Deny-list of MAC Addresses to exclude.
-     * MAC Addresses are normalized, special characters are removed and made uppercase for comparison.
-     * Supports glob-style patterns
-     */
     excludeMacAddresses?: Array<string>;
-    /**
-     * Manual list of devices Before resorting to manually specifying devices.
-     * Try setting the broadcast address and check your router/switch/firewall configuration.
-     * You must assign static IP addresses to your devices to use this configuration.
-     */
     devices?: Array<DeviceConfigInput>;
-    /**
-     * Force Venv Recreation
-     * Set this to force to recreate the virtual python environment with the next restart of the plugin.
-     * @defaultValue false
-     */
     forceVenvRecreate?: boolean;
-    /**
-     * Python Executable
-     * Here you can specify a path that points to a python executable. The plugin uses the systems default python as default. Setting a
-     * specific python executable here may be required if your systems default python version is too current for the plugin.
-     */
     pythonExecutable?: string;
-    /**
-     * Communication Timeout (seconds)
-     * @defaultValue 15
-     */
-    timeout?: number;
-    /**
-     * The time to wait to combine similar commands for a device before sending a command to a device (milliseconds)
-     * @defaultValue 100
-     */
     waitTimeUpdate?: number;
 }
-type KasaPythonConfigDefault = {
-    username: string;
-    password: string;
-    powerStrip: boolean;
-    discoveryPort: number;
-    broadcastAddress: string;
-    pollingInterval: number;
-    includeMacAddress?: Array<string>;
-    excludeMacAddresses?: Array<string>;
-    devices?: Array<{
-        host: string;
-        port?: number | undefined;
-    }>;
-    forceVenvRecreate: boolean;
-    pythonExecutable?: string;
-    timeout: number;
-    waitTimeUpdate: number;
-};
 export type KasaPythonConfig = {
+    name: string;
     username: string;
     password: string;
-    forceVenvRecreate: boolean;
-    pythonExecutable?: string;
-    waitTimeUpdate: number;
     powerStrip: boolean;
-    defaultSendOptions: {
-        timeout: number;
-    };
     discoveryOptions: {
-        port: number | undefined;
-        broadcastAddress: string;
         pollingInterval: number;
-        deviceOptions: {
-            defaultSendOptions: {
-                timeout: number;
-            };
-        };
         includeMacAddress?: Array<string>;
         excludeMacAddresses?: Array<string>;
         devices?: Array<{
             host: string;
-            port?: number | undefined;
         }>;
     };
+    forceVenvRecreate: boolean;
+    pythonExecutable?: string;
+    waitTimeUpdate: number;
 };
-export declare const defaultConfig: KasaPythonConfigDefault;
+export declare const defaultConfig: KasaPythonConfig;
 export declare function parseConfig(config: Record<string, unknown>): KasaPythonConfig;
-export {};

package/dist/config.js

@@ -1,98 +1,67 @@
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
-import * as fs from 'fs';
-import defaults from 'lodash.defaults';
-import * as path from 'path';
-import { fileURLToPath } from 'url';
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { isObjectLike } from './utils.js';
+let schemaCache;
 export class ConfigParseError extends Error {
     errors;
     unknownError;
-    /**
-     * Set by `Error.captureStackTrace`
-     */
-    stack = '';
     constructor(message, errors, unknownError) {
         super(message);
         this.errors = errors;
         this.unknownError = unknownError;
-        const errorsAsString = errors !== null && errors !== undefined
-            ? errors
-                .map((e) => {
-                let msg = `\`${e.instancePath.replace(/^\//, '')}\` ${e.message}`;
-                if ('allowedValues' in e.params) {
-                    msg += `. Allowed values: ${JSON.stringify(e.params.allowedValues)}`;
-                }
-                return msg;
-            })
-                .join('\n')
-            : '';
         this.name = 'ConfigParseError';
-        if (errorsAsString === '') {
-            this.message = message;
-        }
-        else {
-            this.message = `${message}:\n${errorsAsString}`;
+        this.message = this.formatMessage(message, errors, unknownError);
+        Error.captureStackTrace(this, this.constructor);
+    }
+    formatMessage(message, errors, unknownError) {
+        let formattedMessage = message;
+        if (errors && errors.length > 0) {
+            const errorsAsString = errors.map((e) => {
+                const allowedValues = 'allowedValues' in e.params ? `. Allowed values: ${JSON.stringify(e.params.allowedValues)}` : '';
+                return `\`${e.instancePath.replace(/^\//, '')}\` ${e.message}${allowedValues}`;
+            }).join('\n');
+            formattedMessage += `:\n${errorsAsString}`;
         }
         if (unknownError instanceof Error) {
-            this.message += `\nAdditional Error: ${unknownError.message}`;
+            formattedMessage += `\nAdditional Error: ${unknownError.message}`;
         }
         else if (unknownError) {
-            this.message += `\nAdditional Error: [Error details not available: ${unknownError}]`;
+            formattedMessage += `\nAdditional Error: [Error details not available: ${unknownError}]`;
         }
-        Error.captureStackTrace(this, this.constructor);
+        return formattedMessage;
     }
 }
 export const defaultConfig = {
+    name: 'kasa-python',
     username: '',
     password: '',
     powerStrip: false,
-    discoveryPort: 0,
-    broadcastAddress: '255.255.255.255',
-    pollingInterval: 10,
-    includeMacAddress: undefined,
-    excludeMacAddresses: undefined,
-    devices: undefined,
+    discoveryOptions: {
+        pollingInterval: 5,
+        includeMacAddress: undefined,
+        excludeMacAddresses: undefined,
+        devices: undefined,
+    },
     forceVenvRecreate: false,
     pythonExecutable: undefined,
-    timeout: 15,
     waitTimeUpdate: 100,
 };
-function isArrayOfStrings(value) {
-    return (Array.isArray(value) && value.every((item) => typeof item === 'string'));
-}
-function isDeviceConfigInput(value) {
-    return (isObjectLike(value) &&
-        'host' in value &&
-        typeof value.host === 'string' &&
-        (!('port' in value) || typeof value.port === 'number'));
-}
-function isArrayOfDeviceConfigInput(value) {
-    return (Array.isArray(value) && value.every((item) => isDeviceConfigInput(item)));
-}
-function isKasaPythonConfigInput(c) {
-    return (isObjectLike(c) &&
-        (!('username' in c) || typeof c.username === 'string') &&
-        (!('password' in c) || typeof c.password === 'string') &&
-        (!('powerStrip' in c) || typeof c.powerStrip === 'boolean') &&
-        (!('discoveryPort' in c) || typeof c.discoveryPort === 'number') &&
-        (!('broadcastAddress' in c) || typeof c.broadcastAddress === 'string') &&
-        (!('pollingInterval' in c) || typeof c.pollingInterval === 'number') &&
-        (!('includeMacAddress' in c) ||
-            isArrayOfStrings(c.includeMacAddress) ||
-            c.includeMacAddress === undefined) &&
-        (!('excludeMacAddresses' in c) ||
-            isArrayOfStrings(c.excludeMacAddresses) ||
-            c.excludeMacAddresses === undefined) &&
-        (!('devices' in c) ||
-            isArrayOfDeviceConfigInput(c.devices) ||
-            c.devices === undefined) &&
-        (!('forceVenvRecreate' in c) || typeof c.forceVenvRecreate === 'boolean') &&
-        (!('pythonExecutable' in c) ||
-            typeof c.pythonExecutable === 'string' ||
-            c.pythonExecutable === undefined) &&
-        (!('timeout' in c) || typeof c.timeout === 'number') &&
-        (!('waitTimeUpdate' in c) || typeof c.waitTimeUpdate === 'number'));
+function loadSchema() {
+    if (!schemaCache) {
+        try {
+            const __dirname = path.dirname(fileURLToPath(import.meta.url));
+            const schemaPath = path.join(__dirname, '../config.schema.json');
+            const schemaData = fs.readFileSync(schemaPath, 'utf8');
+            schemaCache = JSON.parse(schemaData);
+        }
+        catch (error) {
+            throw new ConfigParseError('Error reading schema', undefined, error);
+        }
+    }
+    return schemaCache;
 }
 export function parseConfig(config) {
     const ajv = new Ajv({ allErrors: true, strict: 'log' });
@@ -108,46 +77,29 @@ export function parseConfig(config) {
         'schema',
         'layout',
     ]);
-    let schema;
-    try {
-        const __dirname = path.dirname(fileURLToPath(import.meta.url));
-        const schemaPath = path.join(__dirname, '../config.schema.json');
-        const schemaData = fs.readFileSync(schemaPath, 'utf8');
-        schema = JSON.parse(schemaData);
-    }
-    catch (error) {
-        throw new ConfigParseError('Error reading schema', undefined, error);
-    }
+    const schema = loadSchema();
     const validate = ajv.compile(schema);
     const valid = validate(config);
     if (!valid) {
         throw new ConfigParseError('Error parsing config', validate.errors);
     }
-    if (!isKasaPythonConfigInput(config)) {
+    if (!isObjectLike(config)) {
         throw new ConfigParseError('Error parsing config');
     }
-    const c = defaults(config, defaultConfig);
-    const defaultSendOptions = {
-        timeout: c.timeout * 1000,
-    };
+    const c = { ...defaultConfig, ...config };
     return {
-        username: c.username,
-        password: c.password,
-        powerStrip: c.powerStrip,
-        forceVenvRecreate: c.forceVenvRecreate,
-        pythonExecutable: c.pythonExecutable,
-        waitTimeUpdate: c.waitTimeUpdate,
-        defaultSendOptions,
+        name: c.name ?? defaultConfig.name,
+        username: c.username ?? defaultConfig.username,
+        password: c.password ?? defaultConfig.password,
+        powerStrip: c.powerStrip ?? defaultConfig.powerStrip,
+        forceVenvRecreate: c.forceVenvRecreate ?? defaultConfig.forceVenvRecreate,
+        pythonExecutable: c.pythonExecutable ?? defaultConfig.pythonExecutable,
+        waitTimeUpdate: c.waitTimeUpdate ?? defaultConfig.waitTimeUpdate,
         discoveryOptions: {
-            port: c.discoveryPort,
-            broadcastAddress: c.broadcastAddress,
-            pollingInterval: c.pollingInterval * 1000,
-            deviceOptions: {
-                defaultSendOptions,
-            },
-            includeMacAddress: c.includeMacAddress,
-            excludeMacAddresses: c.excludeMacAddresses,
-            devices: c.devices,
+            pollingInterval: (c.discoveryOptions.pollingInterval ?? defaultConfig.discoveryOptions.pollingInterval) * 1000,
+            includeMacAddress: c.discoveryOptions.includeMacAddress ?? defaultConfig.discoveryOptions.includeMacAddress,
+            excludeMacAddresses: c.discoveryOptions.excludeMacAddresses ?? defaultConfig.discoveryOptions.excludeMacAddresses,
+            devices: c.discoveryOptions.devices ?? defaultConfig.discoveryOptions.devices,
         },
     };
 }