homebridge-eosstb 1.4.8 → 1.4.10

package/CHANGELOG.md

@@ -5,9 +5,16 @@ Please restart Homebridge after every plugin update.
 
 # Bug Fixes and Improvements
 
-## Current In-Work List (Future Releases)
-* In work: testing of Input Current Visibility State
-* In work: improve handling of channel names: characters not allowed in HomeKit are now replaced with whitespace
+## 1.4.10 (2022-10-14)
+* Incorporated an Important Notice to the logs
+* Disabled plugin for CH and NL as MQTT services are no longer available.
+* Bumped dependencies (node, tough-cookie)
+* Updated README.md to reference iOS 16.0
+
+
+## 1.4.9 (2022-08-23)
+* Bumped dependencies (node, tough-cookie, axios-cookiejar-support)
+* Updated default software version in config.schema.json
 
 
 ## 1.4.8 (2022-07-24)

package/README.md

@@ -1,13 +1,17 @@
 <p align="center">
-    <img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/DCX960andRemoteSmall.jpg" alt="Sunrise TV Box (ARRIS DCX960)" height="300" align="center"><br>
-    <img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/RoomWithEosstb.png" alt="RoomWithEosstb" height="300" align="center">
+    <img style="border:1px solid black;" src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/DCX960andRemoteSmall.jpg" alt="Sunrise TV Box (ARRIS DCX960)" height="300" align="center"><br>
+    <img style="border:5px solid black;" src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/RoomWithEosstb.png" alt="RoomWithEosstb" height="300" align="center">
     <img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/EosstbControls.png" alt="EosstbControls" height="300" align="center">
-    <img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/RemoteControl.png" alt="RemoteControl" height="300" align="center">
-
+    <img style="border:5px solid black;" src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/RemoteControl.png" alt="RemoteControl" height="300" align="center">
   </a>
 </p>
 
 # homebridge-eosstb
+# IMPORTANT NOTICE: CURRENTLY DISABLED FOR CH AND NL COUNTRIES DUE TO BACKEND CHANGES
+It appears that the system backend has changed. First noted on Thursday 13 October 2022.
+Unfortunately this means the plugin will no longer work, it has been disabled for the affected countries.
+The author is investigating, stay tuned.
+
 
 [![npm](https://badgen.net/npm/dt/homebridge-eosstb)](https://www.npmjs.com/package/homebridge-eosstb)
 [![npm](https://badgen.net/npm/dm/homebridge-eosstb)](https://www.npmjs.com/package/homebridge-eosstb)
@@ -19,7 +23,11 @@
 
 `homebridge-eosstb` is a Homebridge plugin allowing you to control your set-top box (typically an ARRIS DCX960 or HUMAX 2008C-STB-TN) running on the Magenta AT / Telenet BE / Sunrise CH / Virgin Media GB & IE / Ziggo NL Horizon TV platform with Apple HomeKit using the Home app and the Apple TV Remote in the Control Center.
 
-<img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/EosstbAccessoryTile.png" alt="EosstbAccessoryTile" height="80" align="left">
+| iOS 16 Accessory Tiles | Older iOS/iPadOS Accessory Tiles |
+|   :---:   |   :---:   |
+| <img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/EosstbAccessoryTile.png" alt="EosstbAccessoryTile" height="60" align="center"> | <img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/EosstbAccessoryTileiOS15.png" alt="EosstbAccessoryTileiOS15" height="80" align="center"> |
+
+
 This plugin displays your set-top box as a Set-Top Box accessory with power, channel and remote-control capabilities on your iOS device (iPhone, iPad, iMac, etc.).
 
 
@@ -31,11 +39,23 @@ Supports multiple set-top boxes, should you have more than one.
 If you like this plugin, consider making a donation or buying me a coffee!<br>
 <a target="blank" href="https://www.paypal.com/donate?hosted_button_id=CNEDGHRUER468"><img src="https://img.shields.io/badge/PayPal-Donate-blue.svg?logo=paypal"/></a>  <a target="blank" href="https://ko-fi.com/jsiegenthaler"><img src="https://img.shields.io/badge/Ko--Fi-Buy%20me%20a%20coffee-29abe0.svg?logo=ko-fi"/></a>
 
+# BACKEND CHANGES CAUSED THIS PLUGIN TO STOP WORKING AS OF 13 OCTOBER 2022
+It appears that the system backend has changed. First noted on Thursday 13 October 2022. I have had reports from the following countries so far:
+
+* NL: Plugin backend logon failure: Failed to create session - check your eosstb username and password: 401 Unauthorized
+* CH: Plugin backend logon failure: Failed to create session - check your eosstb username and password: 401 Unauthorized
+
+Initial investigations reveal that the change will need a large rewrite of the plugin. This may take some time.
+
+Please disable this plugin on your Homebridge until such time as I can issue a new version that works.
+
+
+
 ## Readme Applicability
 Due to the adding of features and functions, this Readme applies from v1.1.0. For prior versions, please see the [eosstb release history on npm](https://www.npmjs.com/package/homebridge-eosstb?activeTab=versions).
 
 # Works in Your Country (If you are with Magenta / Sunrise / Telenet / Virgin Media / Vodafone / Ziggo)
-As UPC operates in multiple countries under multiple brands, this plugin will work in a number of countries that use the Horizon TV platform. The known countries that use the same TV platform with the ARRIS DCX960 or HUMAX 2008C-STB-TN set-top box are:
+As UPC (the operator of the Horizon TV platform) operates in multiple countries under multiple brands, this plugin will work in a number of countries that use the Horizon TV platform. The known countries that use the same TV platform with the ARRIS DCX960 or HUMAX 2008C-STB-TN set-top box are:
 
 | Country | TV Provider | Web App | Box Name | Plugin Status |
 | ------- | ----------- | ------- | -------- | ------------- |
@@ -70,16 +90,16 @@ In March 2022, a newer version of the set-top box has started to appear in Telen
 This plugin is not provided by Magenta or Telenet or Sunrise or Virgin Media or Ziggo any other affiliate of UPC. It is neither endorsed nor supported nor developed by UPC or any affiliates. UPC can change their systems at any time and that might break this plugin. But I hope not.
 
 ## Requirements
-* An Apple iPhone or iPad with iOS 14.0 (or later). Developed on iOS 14.1...15.6, earlier versions not tested.
+* An Apple iPhone or iPad with iOS 14.0 (or later). Developed on iOS 14.1...16.0, earlier versions not tested.
 * [Homebridge](https://homebridge.io/) v1.5.0 (or later). Developed on Homebridge 1.1.116....1.5.0, earlier versions not tested.
 * A TV subscription from one of the supported countries and TV providers.
 * An online account for viewing TV in the web app (often part of your TV package), see the table above.
 * The ARRIS DCX960 or HUMAX 2008C-STB-TN mediabox, provided by your TV provider as part of your TV subscription, called by the system an "EOSSTB" or "EOS2STB" and marketed under different names in different countries. 
-* The set-top box should be set to **Standby power consumption** = **Fast start** to ensure it is always online and can respond to switch-on requests from HomeKit.
+* The set-top box should be set to **SYSTEM** > **Standby power consumption** = **Fast start** to ensure it is always online and can respond to switch-on requests from HomeKit.
 * For GB and IE users: if using an ARRIS DCX960, it must be running the TV 360 software, and not the older TiVo V6 software as found in GB and IE. TiVo V6 is not supported by this plugin, but GB users can [upgrade to TV 360 by contacting Virgin Media](https://www.virginmedia.com/shop/customer/virgin-tv-360-upgrade).
 
 ## Features
-<img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/EosstbControls.png" alt="EosstbControls" height="300" align="right">
+<img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/EosstbControls.png" alt="EosstbControls" height="400" align="right">
 
 * **Full Remote-Control Support**: The Apple TV Remote in your iOS device can control your set-top box; including power, menu navigation, play, pause, fast-forward, rewind, channel up/down, volume and mute commands. All keys are fully configurable for single-tap and double-tap.
 
@@ -109,7 +129,7 @@ This plugin is not provided by Magenta or Telenet or Sunrise or Virgin Media or
 
 * **Fully Configurable**: A large amount of configuration items exist to allow you to configure your plugin the way you want.
 
-* **Future Feature Support**: The plugin also supports current and target media state as well as closed captions, even though the Home app accessory cannot currently display or control this data in the home app (as at iOS 15.6). Hopefully, Apple will add support for these features in the future. You can however use this data in the Shortcuts app.
+* **Future Feature Support**: The plugin also supports current and target media state as well as closed captions, even though the Home app accessory cannot currently display or control this data in the home app (as at iOS 16.0). Hopefully, Apple will add support for these features in the future. You can however use this data in the Shortcuts app.
 
 
 
@@ -137,7 +157,7 @@ The set-top box accessory is exposed as a separate external accessory and each s
 11. **Set-Top Box Automations**: Switch on any suggested automations if you wish (you can change these in the Home app later) and tap **Continue**.
 12. **Set-Top Box Added to \<HomeName\>**: Tap **Done** to finish the setup.
 
-<img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/EosstbAccessoryTile.png" alt="EosstbAccessoryTile" height="80" align="left">
+<img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/EosstbAccessoryTile.png" alt="EosstbAccessoryTile" height="60" align="left">
 Your new accessory will appear shortly in the room that you selected. It may show **Updating...** for a few minutes as it loads all the data.
 
 You can force a Home app refresh by switching to another room and then back again.
@@ -150,8 +170,7 @@ Make sure you select the correct device from the drop-down list at the top of th
 
 The following keys are supported by in the **Apple TV Remote** in the Control Center:
 
-<img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/RemoteControl.png" alt="RemoteControl" height="300" align="right">
-<img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/SelectingDeviceForRemoteControl.png" alt="SelectingDeviceForRemoteControl" height="300" align="right">
+<img src="https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/pics/RemoteControl.png" alt="RemoteControl" height="400" align="right">
 
 | Key | Single Tap | Double Tap |
 | ------- | ----------- | ------- |
@@ -183,13 +202,13 @@ Services used in this set-top box accessory are:
 The eosstb plugin emulates the TV service web app. If the web app is started on a web browser on a laptop or PC, the backend systems may prefer the web app to HomeKit, and disconnect HomeKit from the mqtt session. The mqtt session will try and reconnect if it gets disconnected.
 
 ### Media State (Play/Pause) Limitations
-The eosstb plugin can detect the current and target media state and shows STOP, PLAY, PAUSE or LOADING (loading is displayed when fast-forwarding or rewinding) in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the media state (as at iOS 15.5) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.
+The eosstb plugin can detect the current and target media state and shows STOP, PLAY, PAUSE or LOADING (loading is displayed when fast-forwarding or rewinding) in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the media state (as at iOS 16.0) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.
 
 ### Recording State Limitations
 The eosstb plugin can detect the current recording state of the set-top box, both for local HDD-based recording (for boxes that have a HDD fitted) and for network recording. The plugin shows IDLE, ONGOING_NDVR or ONGOING_LOCALDVR in the Homebridge logs. DVR means digital video recorder; N for network and LOCAL for local HDD based recording. The Apple Home app cannot natively do anything with the recording state but a eosstb config option **customPictureMode** allows you to use the PictureMode to read the recording state in  Shortcuts or Automations.
 
 ### Closed Captions Limitations
-The eosstb plugin can detect the closed captions state (**Subtitle options** in the set-top box menu) and shows ENABLED or DISABLED in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the closed captions state (as at iOS 15.5) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.
+The eosstb plugin can detect the closed captions state (**Subtitle options** in the set-top box menu) and shows ENABLED or DISABLED in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the closed captions state (as at iOS 16.0) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.
 
 ## Configuration
 Add a new platform to the platforms section of your homebridge `config.json`.

package/config.schema.json

@@ -158,8 +158,8 @@
                     "firmwareRevision": {
                         "title": "Firmware",
                         "type": "string",
-                        "description": "The firmware version to display in the Home app. Numbers only eg 4.40. Default: plugin version.",
-                        "placeholder": "4.40",
+                        "description": "The firmware version to display in the Home app. Numbers only eg 4.41. Default: plugin version.",
+                        "placeholder": "4.41",
                         "pattern": "^(\\d+)((\\.{1}\\d+)*)(\\.{0})$"
                     },       
                     

package/index.js

@@ -317,6 +317,19 @@ class stbPlatform {
 			if (this.config.debugLevel > 2) { this.log.warn('API event: didFinishLaunching'); }
 			this.log('%s v%s', PLUGIN_NAME, PLUGIN_VERSION);
 
+			switch(this.config.country) {
+				case 'ch': case 'nl':
+					this.log.warn('-- IMPORTANT NOTICE --');
+					this.log.warn('The %s plugin can no longer be used in your country due to changes in the backend systems.', PLUGIN_NAME);
+					this.log.warn('The backend change means that the accessory will show No Response in HomeKit.');
+					this.log.warn('The auther is investigating how to adapt the plugin.');
+					this.log.warn('You can leave this plugin installed so as not to miss any future updates.');
+					this.log.warn('Please monitor https://github.com/jsiegenthaler/homebridge-eosstb for more information.');
+					this.log.warn('Any and all assistance is welcome!');
+					return;
+				default:
+				}
+
 			// call the session watchdog now to create the session
 			this.sessionWatchdog.bind(this);
 

package/package.json

@@ -3,19 +3,19 @@
   "displayName": "Homebridge EOSSTB",
   "description": "homebridge-plugin - Add your set-top box to Homekit (for Magenta AT, Telenet BE, Sunrise CH, Virgin Media GB & IE, Ziggo NL)",
   "author": "Jochen Siegenthaler (https://github.com/jsiegenthaler/)",
-  "version": "1.4.8",
+  "version": "1.4.10",
   "platformname": "eosstb",
   "dependencies": {
-    "axios-cookiejar-support": "^4.0.2",
+    "axios-cookiejar-support": "^4.0.3",
     "axios": "^0.27.2",
     "mqtt": "^4.3.7",
     "qs": "^6.11.0",
-    "tough-cookie": "^4.0.0"
+    "tough-cookie": "^4.1.2"
   },
   "deprecated": false,
   "engines": {
     "homebridge": ">=1.5.0",
-    "node": ">=16.16.0"
+    "node": ">=16.17.1"
   },
   "homepage": "https://github.com/jsiegenthaler/homebridge-eosstb#readme",
   "keywords": [