homebridge-myleviton 3.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (which shall not include Communications that are clearly marked or
+   otherwise designated in writing by the copyright owner as "Not a Work").
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based upon (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is clearly marked or otherwise designated
+   in writing by the copyright owner as "Not a Contribution".
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct or
+   contributory patent infringement, then any patent licenses granted to
+   You under this License for that Work shall terminate as of the date
+   such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2026 tbaur
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,112 @@
+# homebridge-myleviton
+
+[![Tests](https://github.com/tbaur/homebridge-myleviton/actions/workflows/test.yml/badge.svg)](https://github.com/tbaur/homebridge-myleviton/actions/workflows/test.yml)
+[![npm version](https://badgen.net/npm/v/homebridge-myleviton)](https://www.npmjs.com/package/homebridge-myleviton)
+[![npm downloads](https://badgen.net/npm/dt/homebridge-myleviton)](https://www.npmjs.com/package/homebridge-myleviton)
+[![Node.js](https://badgen.net/badge/node/%3E=20/green)](https://nodejs.org)
+[![Homebridge](https://badgen.net/badge/homebridge/%3E=1.6.0/purple)](https://homebridge.io)
+[![License: Apache-2.0](https://badgen.net/badge/license/Apache-2.0/blue)](LICENSE)
+
+Control your **My Leviton Decora Smart** WiFi devices through Apple HomeKit using Homebridge.
+
+## Features
+
+### Device Control
+- **Automatic Discovery** — Instantly finds all devices from your My Leviton account
+- **Full Dimmer Support** — On/off and brightness control (1-100%)
+- **Fan Speed Control** — 4-speed fan controllers (25/50/75/100%)
+- **Switches & Outlets** — On/off control for all switch and outlet types
+- **Motion Sensors** — D2MSD motion dimmers expose both dimmer and motion sensor
+
+### Reliability
+- **Automatic State Sync** — Polls device state every 30 seconds (configurable)
+- **Rate Limiting** — Prevents API throttling (300 requests/minute)
+- **Circuit Breaker** — Graceful degradation during API outages
+- **Auto-Reconnect** — Automatically recovers from connection issues
+- **State Persistence** — Faster startup with cached device data
+- **Token Auto-Refresh** — Seamless authentication management
+
+### Quality
+- **300+ Tests** — Comprehensive test suite with 95%+ code coverage
+- **Child Bridge Support** — Run as isolated bridge for maximum stability
+- **Flexible Logging** — Debug, info, warn, error levels + JSON structured logs
+- **No Analytics** — Zero tracking or data collection
+- **Well Documented** — Detailed docs for users and developers
+
+## Quick Start
+
+### 1. Install
+
+**Homebridge UI** (recommended):  
+Plugins → Search `homebridge-myleviton` → Install
+
+**Command line:**
+```bash
+npm install -g homebridge-myleviton
+```
+
+### 2. Configure
+
+Add to your Homebridge config:
+
+```json
+{
+  "platforms": [
+    {
+      "platform": "MyLevitonDecoraSmart",
+      "email": "your@email.com",
+      "password": "yourpassword"
+    }
+  ]
+}
+```
+
+### 3. Restart Homebridge
+
+Your devices will appear in the Home app automatically.
+
+## Supported Devices
+
+| Type | Examples |
+|------|----------|
+| **Dimmers** | DW6HD, D26HD, DW1KD, DW3HL, D23LP, DWVAA |
+| **Switches** | DW15S, D215S |
+| **Outlets** | DW15P, DW15A, DW15R, D215P |
+| **Fans** | DW4SF |
+| **Motion Dimmers** | D2MSD |
+
+## Configuration Options
+
+| Option | Required | Description |
+|--------|:--------:|-------------|
+| `email` | ✓ | My Leviton account email |
+| `password` | ✓ | My Leviton account password |
+| `loglevel` | | `debug`, `info` (default), `warn`, `error` |
+| `pollInterval` | | Seconds between state updates (default: 30) |
+| `excludedModels` | | Device models to skip, e.g. `["DW15P"]` |
+| `excludedSerials` | | Device serials to skip |
+
+## Not Working?
+
+1. **Check credentials** — Must match the My Leviton app exactly
+2. **Check device status** — Devices must be online in My Leviton app
+3. **Enable debug logs** — Set `"loglevel": "debug"` and restart
+4. **Restart Homebridge** — Required after any config change
+
+## Requirements
+
+- Homebridge 1.6.0+ or 2.0+
+- Node.js 20+
+- My Leviton account with registered devices
+
+## More Info
+
+- [Details](docs/README-DETAILED.md)
+- [Report Issues](https://github.com/tbaur/homebridge-myleviton/issues)
+- [Changelog](CHANGELOG.md)
+
+## License
+
+Copyright 2026 tbaur
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) file for details.

package/config.schema.json

@@ -0,0 +1,136 @@
+{
+  "pluginAlias": "MyLevitonDecoraSmart",
+  "pluginType": "platform",
+  "singular": true,
+  "headerDisplay": "Control your Leviton Decora Smart Wi-Fi switches, dimmers, outlets, and fan controllers through HomeKit.",
+  "footerDisplay": "---\n\n**Need Help?** Check out the [GitHub Repository](https://github.com/tbaur/homebridge-myleviton) for documentation, troubleshooting guides, and to report issues.",
+  "schema": {
+    "type": "object",
+    "properties": {
+      "email": {
+        "title": "Username ",
+        "type": "string",
+        "required": true,
+        "format": "email",
+        "placeholder": "you@example.com",
+        "description": "The email address you use to sign in to the My Leviton app",
+        "x-schema-form": {
+          "type": "username"
+        }
+      },
+      "password": {
+        "title": "Password ",
+        "type": "string",
+        "required": true,
+        "placeholder": "••••••••••••",
+        "description": "Your My Leviton account password (stored securely in your Homebridge config)",
+        "x-schema-form": {
+          "type": "password"
+        }
+      },
+      "loglevel": {
+        "title": "Log Level",
+        "type": "string",
+        "default": "info",
+        "oneOf": [
+          { "title": "Debug - Verbose logging for troubleshooting", "enum": ["debug"] },
+          { "title": "Info - Standard operational messages", "enum": ["info"] },
+          { "title": "Warn - Warnings and important notices", "enum": ["warn"] },
+          { "title": "Error - Only errors and critical issues", "enum": ["error"] }
+        ],
+        "description": "Controls how much detail appears in Homebridge logs. Use Debug when troubleshooting issues."
+      },
+      "pollInterval": {
+        "title": "Poll Interval",
+        "type": "integer",
+        "default": 30,
+        "minimum": 10,
+        "maximum": 300,
+        "description": "How often (in seconds) to check device states. Lower values = faster updates but more API calls. Default: 30 seconds."
+      },
+      "excludedModels": {
+        "title": "Excluded Models",
+        "type": "array",
+        "description": "Device models to exclude from HomeKit. Enter the model number (e.g., DW4BC for button controllers). Useful for devices you don't want to control via HomeKit.",
+        "items": {
+          "type": "string",
+          "title": "Model Number",
+          "placeholder": "e.g., DW4BC"
+        }
+      },
+      "excludedSerials": {
+        "title": "Excluded Serial Numbers",
+        "type": "array",
+        "description": "Specific devices to exclude by serial number. Find the serial in the My Leviton app under device settings.",
+        "items": {
+          "type": "string",
+          "title": "Serial Number",
+          "placeholder": "e.g., ABC123DEF456"
+        }
+      },
+      "structuredLogs": {
+        "title": "Enable Structured Logging (JSON)",
+        "type": "boolean",
+        "default": false,
+        "description": "Output logs in JSON format for integration with log management tools like Datadog, Splunk, or ELK stack."
+      }
+    }
+  },
+  "layout": [
+    {
+      "type": "fieldset",
+      "title": "Account Credentials",
+      "description": "Enter your My Leviton account details.",
+      "expandable": false,
+      "items": [
+        "email",
+        "password"
+      ]
+    },
+    {
+      "type": "fieldset",
+      "title": "General Settings",
+      "expandable": true,
+      "expanded": true,
+      "items": [
+        "loglevel",
+        "pollInterval"
+      ]
+    },
+    {
+      "type": "fieldset",
+      "title": "Device Exclusions",
+      "description": "Optionally exclude specific device types or individual devices from appearing in HomeKit.",
+      "expandable": true,
+      "expanded": false,
+      "items": [
+        {
+          "key": "excludedModels",
+          "type": "array",
+          "buttonText": "Add Model to Exclude",
+          "items": {
+            "type": "string"
+          }
+        },
+        {
+          "key": "excludedSerials", 
+          "type": "array",
+          "buttonText": "Add Serial to Exclude",
+          "items": {
+            "type": "string"
+          }
+        }
+      ]
+    },
+    {
+      "type": "fieldset",
+      "title": "Advanced Options",
+      "description": "Settings for power users and developers.",
+      "expandable": true,
+      "expanded": false,
+      "items": [
+        "structuredLogs"
+      ]
+    }
+  ]
+}

package/dist/api/cache.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Copyright (c) 2026 tbaur
+ *
+ * Licensed under the Apache License, Version 2.0
+ * See LICENSE file for full license text
+ *
+ * @fileoverview Response caching with TTL and LRU eviction
+ */
+/**
+ * Cache configuration
+ */
+export interface CacheConfig {
+    /** Time-to-live in milliseconds */
+    ttlMs: number;
+    /** Maximum number of entries */
+    maxSize: number;
+    /** Whether to update timestamp on access */
+    updateOnAccess?: boolean;
+}
+/**
+ * Default cache configuration
+ */
+export declare const DEFAULT_CACHE_CONFIG: CacheConfig;
+/**
+ * Response cache with TTL and optional LRU eviction
+ */
+export declare class ResponseCache<T = unknown> {
+    private readonly cache;
+    private readonly ttlMs;
+    private readonly maxSize;
+    private readonly updateOnAccess;
+    private hits;
+    private misses;
+    constructor(config?: Partial<CacheConfig>);
+    /**
+     * Check if entry is expired
+     */
+    private isExpired;
+    /**
+     * Evict oldest entries if over capacity
+     */
+    private evictIfNeeded;
+    /**
+     * Get cached value if still valid
+     * @returns Cached data or null if expired/missing
+     */
+    get(key: string): T | null;
+    /**
+     * Set cache value
+     */
+    set(key: string, data: T): void;
+    /**
+     * Check if key exists and is not expired
+     */
+    has(key: string): boolean;
+    /**
+     * Delete a specific key
+     */
+    delete(key: string): boolean;
+    /**
+     * Clear expired entries
+     */
+    clearExpired(): number;
+    /**
+     * Clear all cache entries
+     */
+    clear(): void;
+    /**
+     * Get number of entries
+     */
+    get size(): number;
+    /**
+     * Get cache hit ratio
+     */
+    get hitRatio(): number;
+    /**
+     * Get cache statistics
+     */
+    getStats(): {
+        size: number;
+        maxSize: number;
+        ttlMs: number;
+        hits: number;
+        misses: number;
+        hitRatio: number;
+    };
+    /**
+     * Reset statistics
+     */
+    resetStats(): void;
+    /**
+     * Get all keys
+     */
+    keys(): string[];
+    /**
+     * Get or set a value using a factory function
+     */
+    getOrSet(key: string, factory: () => Promise<T>): Promise<T>;
+}
+/**
+ * Get or create the global cache
+ */
+export declare function getResponseCache(config?: Partial<CacheConfig>): ResponseCache;
+/**
+ * Reset the global cache (for testing)
+ */
+export declare function resetGlobalCache(): void;
+//# sourceMappingURL=cache.d.ts.map

package/dist/api/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../src/api/cache.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,4CAA4C;IAC5C,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,WAIlC,CAAA;AAED;;GAEG;AACH,qBAAa,aAAa,CAAC,CAAC,GAAG,OAAO;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwC;IAC9D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IAGxC,OAAO,CAAC,IAAI,CAAI;IAChB,OAAO,CAAC,MAAM,CAAI;gBAEN,MAAM,GAAE,OAAO,CAAC,WAAW,CAAM;IAO7C;;OAEG;IACH,OAAO,CAAC,SAAS;IAIjB;;OAEG;IACH,OAAO,CAAC,aAAa;IAYrB;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IA2B1B;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI;IAQ/B;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAUzB;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAI5B;;OAEG;IACH,YAAY,IAAI,MAAM;IAWtB;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAGrB;IAED;;OAEG;IACH,QAAQ,IAAI;QACV,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,QAAQ,EAAE,MAAM,CAAA;KACjB;IAWD;;OAEG;IACH,UAAU,IAAI,IAAI;IAKlB;;OAEG;IACH,IAAI,IAAI,MAAM,EAAE;IAIhB;;OAEG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAUnE;AAOD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,aAAa,CAK7E;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC"}