homebridge-deco 1.0.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 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
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (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 conspicuously 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

package/README.md

@@ -0,0 +1,290 @@
+# homebridge-deco
+
+[![npm version](https://badge.fury.io/js/homebridge-deco.svg)](https://badge.fury.io/js/homebridge-deco)
+
+**Homebridge plugin for TP-Link Deco mesh network system**
+
+This plugin exposes your TP-Link Deco mesh network to Apple HomeKit, allowing you to:
+- Monitor internet connectivity status
+- Control guest network on/off
+- Track individual Deco unit status (online/offline)
+- Monitor specific devices on your network (presence detection)
+
+## Features
+
+### Router Accessory (Default)
+- **Native HomeKit Router**: Your Deco appears as a proper Router in the Home app
+- Shows network status and information
+- Clean, native HomeKit integration
+
+### Optional Advanced Features (Off by Default)
+
+#### Network Status Sensor
+- Contact sensor showing internet connectivity
+- Alternative to the router accessory if you prefer sensor-based monitoring
+
+#### Guest Network Control
+- Switch to toggle guest network on/off
+- Useful for automations (e.g., turn off guest network at night)
+
+#### Individual Deco Unit Monitoring
+- Each mesh unit as a contact sensor (online/offline status)
+- Monitor mesh health and get offline notifications
+
+#### Device Presence Tracking
+- Track specific devices by MAC address
+- Appears as occupancy sensors
+- Perfect for "someone is home" automations
+
+## Requirements
+
+- **Node.js**: v20.18.0 or higher (v22.10.0+ or v24.0.0+ recommended)
+- **Homebridge**: v1.8.0 or higher (v2.0.0+ supported)
+- **TP-Link Account**: Your TP-Link cloud account credentials (same as Deco app)
+- **TP-Link Deco**: Tested with Deco PX50, should work with all Deco models
+
+## Installation
+
+### Via Homebridge Config UI X (Recommended)
+
+1. Search for "homebridge-deco" in the Plugins tab
+2. Click Install
+3. Configure your TP-Link account credentials
+4. Restart Homebridge
+
+### Via npm
+
+```bash
+npm install -g homebridge-deco
+```
+
+## Configuration
+
+### Basic Configuration
+
+Add this to your Homebridge `config.json`:
+
+```json
+{
+  "platforms": [
+    {
+      "name": "TP-Link Deco",
+      "platform": "TPLinkDeco",
+      "username": "your-tplink-email@example.com",
+      "password": "your-tplink-password",
+      "pollingInterval": 30
+    }
+  ]
+}
+```
+
+This will expose your Deco as a native Router in HomeKit. To enable advanced features:
+
+```json
+{
+  "platforms": [
+    {
+      "name": "TP-Link Deco",
+      "platform": "TPLinkDeco",
+      "username": "your-tplink-email@example.com",
+      "password": "your-tplink-password",
+      "pollingInterval": 30,
+      "exposeGuestNetwork": true,
+      "exposeDecoUnits": true
+    }
+  ]
+}
+```
+
+### Configuration Options
+
+| Option | Required | Default | Description |
+|--------|----------|---------|-------------|
+| `name` | Yes | - | Name of the platform |
+| `platform` | Yes | - | Must be "TPLinkDeco" |
+| `username` | Yes | - | Your TP-Link cloud account email |
+| `password` | Yes | - | Your TP-Link cloud account password |
+| `pollingInterval` | No | 30 | How often to check status (10-300 seconds) |
+| `exposeAsRouter` | No | true | Expose as native HomeKit Router (recommended) |
+| `exposeNetworkSensor` | No | false | Show network status as contact sensor |
+| `exposeGuestNetwork` | No | false | Show guest network control switch |
+| `exposeDecoUnits` | No | false | Show individual Deco units as sensors |
+| `exposeDeviceTrackers` | No | false | Enable device presence tracking |
+| `trackedDevices` | No | [] | List of devices to track (see below) |
+
+### Device Tracking Configuration
+
+To track specific devices on your network (requires `exposeDeviceTrackers: true`):
+
+```json
+{
+  "platforms": [
+    {
+      "name": "TP-Link Deco",
+      "platform": "TPLinkDeco",
+      "username": "your-tplink-email@example.com",
+      "password": "your-tplink-password",
+      "exposeDeviceTrackers": true,
+      "trackedDevices": [
+        {
+          "name": "John's iPhone",
+          "mac": "AA:BB:CC:DD:EE:FF"
+        },
+        {
+          "name": "Jane's iPad",
+          "mac": "11:22:33:44:55:66"
+        }
+      ]
+    }
+  ]
+}
+```
+
+**Finding MAC Addresses**: Open the Deco app → Clients → Select device → MAC address is displayed
+
+## Usage Examples
+
+### Automation Ideas
+
+1. **Internet Outage Notifications**
+   - Trigger: Network Status contact sensor becomes "Not Detected"
+   - Action: Send notification to your phone
+
+2. **Automatic Guest Network Schedule**
+   - Trigger: Time-based (e.g., 11 PM)
+   - Action: Turn off Guest Network switch
+
+3. **Someone Is Home**
+   - Trigger: Device Tracker (phone) shows "Occupied"
+   - Action: Turn on lights, adjust thermostat
+
+4. **Mesh Health Monitoring**
+   - Trigger: Any Deco unit contact sensor becomes "Not Detected"
+   - Action: Send alert notification
+
+## Exposed Accessories
+
+### Default Setup
+
+With default settings, you get:
+
+1. **Deco Router** (Router) - Native HomeKit router accessory
+   - Shows network information in the Home app
+   - Clean, integrated experience
+
+### Optional Accessories (when enabled)
+
+2. **Network Status** (Contact Sensor) - When `exposeNetworkSensor: true`
+   - Detected = Internet is online
+   - Not Detected = Internet is offline
+
+3. **Guest Network** (Switch) - When `exposeGuestNetwork: true`
+   - On = Guest network enabled
+   - Off = Guest network disabled
+
+4. **Deco [Unit Name]** (Contact Sensor) - When `exposeDecoUnits: true`
+   - One per mesh unit
+   - Detected = Unit is online, Not Detected = Unit is offline
+
+5. **[Device Name]** (Occupancy Sensor) - When `exposeDeviceTrackers: true`
+   - Per tracked device in config
+   - Occupied = Device is connected, Not Occupied = Device is not connected
+
+## Troubleshooting
+
+### Authentication Failures
+
+**Error**: "Failed to authenticate with TP-Link cloud"
+
+- Verify your email and password are correct
+- Make sure you can log into the Deco mobile app
+- Check if your TP-Link account requires 2FA (not currently supported)
+
+### No Devices Discovered
+
+**Error**: "Successfully discovered 0 Deco devices"
+
+- Ensure your Deco system is set up and online in the Deco app
+- Check that your Homebridge server has internet access
+- Try increasing the polling interval to 60+ seconds
+- Check Homebridge logs for detailed error messages
+
+### Accessories Not Updating
+
+- Check your polling interval isn't too long
+- Restart Homebridge to force a fresh discovery
+- Check network connectivity between Homebridge and internet
+
+### Debug Logging
+
+Enable debug mode in Homebridge to see detailed API communication:
+
+```bash
+homebridge -D
+```
+
+## Technical Details
+
+### API Communication
+
+This plugin uses the TP-Link cloud API (same as the mobile app) to communicate with your Deco network:
+- Authenticates using your TP-Link account credentials
+- Maintains a session token (refreshed every hour)
+- Polls for status updates at your configured interval
+- Supports both reading status and controlling settings
+
+### Reliability Features
+
+- **Automatic token refresh**: Handles session expiration transparently
+- **Error retry logic**: Recovers from temporary network issues
+- **Cached accessory state**: Preserves settings across Homebridge restarts
+- **Efficient polling**: Only fetches data at configured intervals
+
+## Known Limitations
+
+- Requires internet connection (uses TP-Link cloud API)
+- Cannot control individual Deco unit settings beyond what's exposed
+- Guest network control may not work on all Deco models
+- 2FA accounts are not currently supported
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/fabianoley/homebridge-deco.git
+cd homebridge-deco
+
+# Install dependencies
+npm install
+
+# Build the plugin
+npm run build
+
+# Link to Homebridge
+npm link
+
+# Watch for changes (auto-compile and restart)
+npm run watch
+```
+
+### Configuration for Development
+
+Edit `test/hbConfig/config.json` with your TP-Link credentials, then run:
+
+```bash
+npm run watch
+```
+
+## Contributing
+
+Found a bug or want a feature? Please open an issue on GitHub!
+
+## License
+
+Apache-2.0
+
+## Credits
+
+Created by Fabian Oley

package/config.schema.json

@@ -0,0 +1,89 @@
+{
+  "pluginAlias": "TPLinkDeco",
+  "pluginType": "platform",
+  "singular": true,
+  "strictValidation": false,
+  "schema": {
+    "type": "object",
+    "required": ["name", "username", "password"],
+    "additionalProperties": false,
+    "properties": {
+      "name": {
+        "title": "Name",
+        "type": "string",
+        "default": "TP-Link Deco"
+      },
+      "username": {
+        "title": "TP-Link Account Email",
+        "type": "string",
+        "required": true,
+        "description": "Your TP-Link cloud account email address"
+      },
+      "password": {
+        "title": "TP-Link Account Password",
+        "type": "string",
+        "required": true,
+        "description": "Your TP-Link cloud account password"
+      },
+      "pollingInterval": {
+        "title": "Polling Interval (seconds)",
+        "type": "integer",
+        "default": 30,
+        "minimum": 10,
+        "maximum": 300,
+        "description": "How often to check device status (10-300 seconds)"
+      },
+      "exposeAsRouter": {
+        "title": "Expose as Router (Recommended)",
+        "type": "boolean",
+        "default": true,
+        "description": "Expose Deco as a native HomeKit Router accessory"
+      },
+      "exposeNetworkSensor": {
+        "title": "Expose Network Status Sensor",
+        "type": "boolean",
+        "default": false,
+        "description": "Add a contact sensor for internet connectivity (alternative to router)"
+      },
+      "exposeGuestNetwork": {
+        "title": "Expose Guest Network Control",
+        "type": "boolean",
+        "default": false,
+        "description": "Add a switch to control guest network on/off"
+      },
+      "exposeDecoUnits": {
+        "title": "Expose Individual Deco Units",
+        "type": "boolean",
+        "default": false,
+        "description": "Add contact sensors for each Deco mesh unit status"
+      },
+      "exposeDeviceTrackers": {
+        "title": "Expose Connected Devices as Occupancy Sensors",
+        "type": "boolean",
+        "default": false,
+        "description": "Create occupancy sensors for tracking specific devices"
+      },
+      "trackedDevices": {
+        "title": "Tracked Device MAC Addresses",
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "title": "Device Name",
+              "type": "string"
+            },
+            "mac": {
+              "title": "MAC Address",
+              "type": "string",
+              "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$"
+            }
+          }
+        },
+        "condition": {
+          "functionBody": "return model.exposeDeviceTrackers === true;"
+        }
+      }
+    }
+  }
+}

package/dist/decoAPI.d.ts

@@ -0,0 +1,85 @@
+import type { Logging } from 'homebridge';
+interface DecoConfig {
+    username: string;
+    password: string;
+    log: Logging;
+}
+interface DecoDevice {
+    deviceId: string;
+    deviceName: string;
+    deviceModel: string;
+    deviceType: string;
+    role: string;
+    mac: string;
+    ip: string;
+    status: number;
+    ledOn: boolean;
+    signalLevel?: number;
+}
+interface ConnectedClient {
+    mac: string;
+    name: string;
+    ip: string;
+    online: boolean;
+    downSpeed: number;
+    upSpeed: number;
+    connectedNode: string;
+}
+interface NetworkStatus {
+    internetOnline: boolean;
+    guestNetworkEnabled: boolean;
+    devices: DecoDevice[];
+    clients: ConnectedClient[];
+}
+export declare class DecoAPI {
+    private readonly log;
+    private readonly username;
+    private readonly password;
+    private token;
+    private readonly baseUrl;
+    private termid;
+    private lastAuthTime;
+    private readonly authValidityMs;
+    constructor(config: DecoConfig);
+    /**
+     * Authenticate with TP-Link cloud service
+     */
+    authenticate(): Promise<boolean>;
+    /**
+     * Get list of Deco devices in the network
+     */
+    getDeviceList(): Promise<DecoDevice[]>;
+    /**
+     * Get network status including internet connectivity and guest network
+     */
+    getNetworkStatus(): Promise<NetworkStatus>;
+    /**
+     * Get list of connected clients
+     */
+    getClientList(): Promise<ConnectedClient[]>;
+    /**
+     * Get guest network status
+     */
+    getGuestNetworkStatus(): Promise<boolean>;
+    /**
+     * Toggle guest network on/off
+     */
+    setGuestNetwork(enabled: boolean): Promise<boolean>;
+    /**
+     * Check if a specific device (by MAC) is connected
+     */
+    isDeviceConnected(mac: string): Promise<boolean>;
+    /**
+     * Reboot a specific Deco device
+     */
+    rebootDevice(deviceId: string): Promise<boolean>;
+    /**
+     * Make HTTP request to TP-Link API
+     */
+    private makeRequest;
+    /**
+     * Ensure we have a valid authentication token
+     */
+    private ensureAuthenticated;
+}
+export {};