@mp-consulting/homebridge-philips-ambilight-tv 1.0.0

package/.claude/settings.local.json

@@ -0,0 +1,12 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npm run build:*)",
+      "Bash(git rev-list:*)",
+      "Bash(GIT_SEQUENCE_EDITOR=\"sed -i '''' ''s/^pick 9712d26/reword 9712d26/''\" git rebase -i 9712d26~1)",
+      "Bash(git filter-branch:*)",
+      "Bash(npm run lint:*)",
+      "Bash(npm pkg fix:*)"
+    ]
+  }
+}

package/.tool-versions

@@ -0,0 +1 @@
+nodejs 20.19.5

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2024-12-20
+
+### Added
+
+- Initial release
+- Power ON/OFF control with Wake-on-LAN support
+- Input source selection (HDMI ports, TV tuner, applications)
+- Volume control and mute functionality
+- Remote control support (D-Pad, Back, Menu, Play/Pause, Info)
+- Ambilight power control
+- Multi-TV support in a single platform
+- Custom UI for Homebridge Config UI X:
+  - TV discovery via mDNS (Bonjour)
+  - Guided pairing wizard with PIN entry
+  - Source editor with drag-and-drop reordering
+  - Source visibility toggle
+  - MAC address auto-detection
+- JointSpace API v6 client for Philips Android TVs
+- Digest authentication support
+- Input source persistence across restarts
+- Workaround for tvOS 18 HomeHub input source renaming bug
+- Comprehensive error handling and logging
+
+### Technical
+
+- TypeScript codebase with ESM modules
+- Separate API client library (`PhilipsTVClient`)
+- Shared code between plugin and custom UI
+- ESLint configuration with strict rules
+- Test script for TV API endpoints

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,158 @@
+<p align="center">
+<img src="homebridge-ui/public/ambilight-tv.jpg" width="300">
+</p>
+
+# Homebridge Philips Ambilight TV
+
+A Homebridge plugin to control Philips Android TVs with Ambilight as HomeKit Television accessories.
+
+## Features
+
+- Power ON/OFF with Wake-on-LAN support
+- Input source selection (HDMI, TV tuner, apps)
+- Volume control and mute
+- Remote control (D-Pad, Back, Menu, Play/Pause, etc.)
+- Ambilight power control
+- Multi-TV support
+- Custom UI for easy setup and configuration
+
+## Requirements
+
+- Philips Android TV with JointSpace API v6 (2016+ models)
+- TV and Homebridge on the same network
+- Node.js 20.18.0 or later
+
+## Installation
+
+### Via Homebridge UI (Recommended)
+
+1. Open the Homebridge UI
+2. Go to the Plugins tab
+3. Search for "homebridge-philips-ambilight-tv"
+4. Click Install
+
+### Via Command Line
+
+```bash
+npm install -g homebridge-philips-ambilight-tv
+```
+
+## Setup
+
+### Using the Custom UI (Recommended)
+
+1. Open the Homebridge UI and go to the plugin settings
+2. Click "Discover TVs" to find your TV on the network
+3. Select your TV and follow the pairing wizard
+4. Enter the PIN displayed on your TV screen
+5. Customize sources and save
+
+### Manual Configuration
+
+Add the following to your `config.json`:
+
+```json
+{
+  "platforms": [
+    {
+      "platform": "PhilipsAmbilightTV",
+      "devices": [
+        {
+          "name": "Living Room TV",
+          "ip": "192.168.1.10",
+          "mac": "AA:BB:CC:DD:EE:FF",
+          "username": "your_device_id",
+          "password": "your_auth_key"
+        }
+      ]
+    }
+  ]
+}
+```
+
+### Configuration Options
+
+| Key | Description | Required |
+| --- | --- | --- |
+| `platform` | Must be `PhilipsAmbilightTV` | Yes |
+| `devices` | Array of TV configurations | Yes |
+| `devices[].name` | Display name for the TV | Yes |
+| `devices[].ip` | IP address of your TV | Yes |
+| `devices[].mac` | MAC address (for Wake-on-LAN) | Yes |
+| `devices[].username` | Device ID from pairing | Yes |
+| `devices[].password` | Auth key from pairing | Yes |
+| `devices[].sources` | Custom source configuration | No |
+
+### Getting Credentials
+
+The `username` and `password` are obtained during the pairing process:
+
+1. Use the plugin's custom UI to pair (recommended)
+2. Or use the TV's built-in pairing API:
+   - Send a pairing request to `https://<TV_IP>:1926/6/pair/request`
+   - Complete the pairing with the PIN shown on TV
+   - The response contains your credentials
+
+## Editing Sources
+
+The plugin supports customizing which sources appear in HomeKit:
+
+1. Go to the plugin settings in Homebridge UI
+2. Click "Edit Sources" on your configured TV
+3. Drag and drop to reorder sources
+4. Toggle visibility for each source
+5. Click "Done" to save
+
+Note: HomeKit limits input sources to 45 total.
+
+## Troubleshooting
+
+### TV not discovered
+
+- Ensure the TV is powered on (not in standby)
+- Check that TV and Homebridge are on the same network/VLAN
+- Try entering the IP address manually
+
+### Pairing fails
+
+- Make sure no other device is pairing simultaneously
+- Try restarting the TV
+- Check the TV's network settings
+
+### TV not responding
+
+- Verify the TV's IP hasn't changed (consider a static IP)
+- Check if Wake-on-LAN is enabled in TV settings
+- Ensure the TV's API is accessible (port 1926)
+
+### Input sources not updating in Home app
+
+This is a known tvOS 18 bug. The plugin includes a workaround that may require removing and re-adding the TV in the Home app.
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/mickael/homebridge-philips-ambilight-tv.git
+
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Run with test config
+npm start
+
+# Test TV endpoints
+npm run test:tv
+```
+
+## License
+
+Apache-2.0
+
+## Credits
+
+- [Homebridge](https://homebridge.io/)
+- Philips JointSpace API documentation

package/config.schema.json

@@ -0,0 +1,193 @@
+{
+  "pluginAlias": "PhilipsAmbilightTV",
+  "pluginType": "platform",
+  "singular": true,
+  "strictValidation": false,
+  "customUi": true,
+  "schema": {
+    "type": "object",
+    "required": [
+      "devices"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "devices": {
+        "title": "TV Devices",
+        "type": "array",
+        "minItems": 1,
+        "items": {
+          "type": "object",
+          "required": [
+            "name",
+            "mac",
+            "ip",
+            "username",
+            "password"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "name": {
+              "title": "TV Name",
+              "type": "string",
+              "default": "My Philips TV",
+              "description": "The name of the TV as it will appear in HomeKit."
+            },
+            "mac": {
+              "title": "MAC Address",
+              "type": "string",
+              "pattern": "^([A-Fa-f0-9]{2}:){5}[A-Fa-f0-9]{2}$",
+              "placeholder": "AA:BB:CC:DD:EE:FF",
+              "description": "The MAC address of the TV (required for Wake-on-LAN)."
+            },
+            "ip": {
+              "title": "IP Address",
+              "type": "string",
+              "format": "ipv4",
+              "placeholder": "192.168.1.100",
+              "description": "The IP address of the TV on the local network."
+            },
+            "username": {
+              "title": "Username",
+              "type": "string",
+              "description": "The username obtained during TV pairing."
+            },
+            "password": {
+              "title": "Password",
+              "type": "string",
+              "description": "The password (auth key) obtained during TV pairing."
+            },
+            "pollingInterval": {
+              "title": "Polling Interval (ms)",
+              "type": "integer",
+              "default": 10000,
+              "minimum": 1000,
+              "maximum": 60000,
+              "description": "How often to poll the TV for state updates (in milliseconds)."
+            },
+            "wakeOnLanEnabled": {
+              "title": "Wake-on-LAN",
+              "type": "boolean",
+              "default": true,
+              "description": "Enable Wake-on-LAN to turn on the TV from standby."
+            },
+            "inputs": {
+              "title": "Custom Input Sources",
+              "type": "array",
+              "description": "Custom input sources to display in HomeKit. If not specified, apps will be fetched from the TV.",
+              "items": {
+                "type": "object",
+                "required": [
+                  "name",
+                  "type",
+                  "identifier"
+                ],
+                "properties": {
+                  "name": {
+                    "title": "Name",
+                    "type": "string",
+                    "description": "The display name for this input source."
+                  },
+                  "type": {
+                    "title": "Type",
+                    "type": "string",
+                    "enum": [
+                      "app",
+                      "source",
+                      "channel"
+                    ],
+                    "description": "The type of input source."
+                  },
+                  "identifier": {
+                    "title": "Identifier",
+                    "type": "string",
+                    "description": "The app package name, source ID, or channel number."
+                  },
+                  "displayOrder": {
+                    "title": "Display Order",
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "The order in which this input appears in HomeKit."
+                  }
+                }
+              }
+            },
+            "sources": {
+              "title": "Source Configuration",
+              "type": "array",
+              "description": "Source order and visibility settings (managed via the Sources UI).",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "title": "Source ID",
+                    "type": "string",
+                    "description": "The unique identifier for this source."
+                  },
+                  "order": {
+                    "title": "Display Order",
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "The order in which this source appears in HomeKit."
+                  },
+                  "visible": {
+                    "title": "Visible",
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Whether this source is visible in HomeKit."
+                  },
+                  "customName": {
+                    "title": "Custom Name",
+                    "type": "string",
+                    "description": "Optional custom name to display instead of the default."
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "layout": [
+    {
+      "type": "fieldset",
+      "title": "TV Devices",
+      "expandable": true,
+      "expanded": true,
+      "items": [
+        {
+          "key": "devices",
+          "type": "array",
+          "orderable": true,
+          "buttonText": "Add TV",
+          "items": [
+            "devices[].name",
+            "devices[].ip",
+            "devices[].mac",
+            "devices[].username",
+            "devices[].password",
+            {
+              "key": "devices[].pollingInterval",
+              "description": "Polling interval in milliseconds (default: 10000)"
+            },
+            "devices[].wakeOnLanEnabled",
+            {
+              "key": "devices[].inputs",
+              "type": "array",
+              "title": "Custom Input Sources (Optional)",
+              "expandable": true,
+              "expanded": false,
+              "buttonText": "Add Input",
+              "items": [
+                "devices[].inputs[].name",
+                "devices[].inputs[].type",
+                "devices[].inputs[].identifier",
+                "devices[].inputs[].displayOrder"
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/dist/api/PhilipsTVClient.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Philips TV API Client
+ * Handles all communication with the Philips TV JointSpace API (v6)
+ */
+import type { VolumeState, TVSource, TVApplication, TVChannel, RemoteKey, SystemInfo } from './types.js';
+/** Built-in HDMI sources for Android TV (Philips) */
+export declare const HDMI_SOURCES: Readonly<Record<string, string>>;
+/** Watch TV source URI */
+export declare const WATCH_TV_URI = "content://android.media.tv/channel";
+export interface PhilipsTVClientConfig {
+    ip: string;
+    mac: string;
+    username: string;
+    password: string;
+}
+export declare class PhilipsTVClient {
+    private readonly config;
+    constructor(config: PhilipsTVClientConfig);
+    private request;
+    private handleDigestAuth;
+    private parseJsonResponse;
+    private get;
+    private post;
+    getPowerState(): Promise<boolean>;
+    setPowerState(on: boolean): Promise<boolean>;
+    private tryWakeOnLan;
+    getVolume(): Promise<VolumeState | null>;
+    setVolume(volume: number): Promise<boolean>;
+    setMuted(muted: boolean): Promise<boolean>;
+    /**
+     * Fetches available sources from the TV API.
+     * Falls back to built-in sources if the API call fails.
+     */
+    getSources(): Promise<TVSource[]>;
+    /**
+     * Returns hardcoded built-in sources (Watch TV + HDMI ports).
+     * Use getSources() instead for dynamic source fetching.
+     */
+    getBuiltInSources(): TVSource[];
+    setSource(sourceUri: string): Promise<boolean>;
+    getApplications(): Promise<TVApplication[]>;
+    launchApplication(packageName: string): Promise<boolean>;
+    getCurrentActivity(): Promise<string | null>;
+    private launchIntent;
+    getChannels(): Promise<TVChannel[]>;
+    setChannel(ccid: number): Promise<boolean>;
+    sendKey(key: RemoteKey): Promise<boolean>;
+    getSystemInfo(): Promise<SystemInfo | null>;
+    isReachable(): Promise<boolean>;
+    getAmbilightPower(): Promise<boolean>;
+    setAmbilightPower(on: boolean): Promise<boolean>;
+    wakeUp(): Promise<void>;
+    private sleep;
+}