homebridge-eosstb 2.2.11 → 2.2.12

package/CHANGELOG.md

@@ -9,6 +9,14 @@ Please restart Homebridge after every plugin update.
 * Add ability to log and read current program name
 
 
+## 2.2.12 (2023-10-28)
+* Updated iOS references to iOs 17.x in README.md
+* Added config option masterChannelRefreshCheckInterval to select desired master channel list refresh check interval (in seconds). Default 60s.
+* Bumped dependency "axios": "^1.6.0",
+* Bumped dependency "mqtt": "^5.1.3"
+* Bumped dependency "node": "^20.9.0"
+
+
 ## 2.2.11 (2023-08-05)
 * Updated iOS references in README.md
 * Bumped dependency "mqtt": "^5.0.2"

package/README.md

@@ -18,7 +18,7 @@
 
 `homebridge-eosstb` is a Homebridge plugin allowing you to control your set-top box (typically an ARRIS DCX960 / VIP5002W or HUMAX EOS1008R / 2008C) 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.
 
-| iOS/iPadOS 16 Accessory Tiles | Older iOS/iPadOS Accessory Tiles |
+| iOS/iPadOS 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"> |
 
@@ -64,7 +64,7 @@ This plugin was written and tested on the author's set-top box (ARRIS mediabox m
 ## Why I chose the Name EOSSTB
 I tried to find a good common name that works for this plugin for all countries. Each country uses a different marketing name for the box, so I could not use the local name. The EOS system, also known as the Horizon platform, originally used an ARRIS DCX960, but even this box comes in different types and with different firmware, so I decided not to use the model name. I stuck with the box identifier that appears in the mqtt messages: EOSSTB. 
 
-In March 2022, a newer version of the set-top box has started to appear in Telenet in Belgium: a HUMAX 2008C-STB-TN, which identifies itself as EOS2STB. This has since been seen in NL as a HUMAX 2008C-STB-ZG, and in CH as a HUMAX 2008C-STB-UPC/CH.
+In March 2022, a newer version of the set-top box appeared in Telenet in Belgium: a HUMAX 2008C-STB-TN, which identifies itself as EOS2STB. This has since been seen in NL as a HUMAX 2008C-STB-ZG, and in CH as a HUMAX 2008C-STB-UPC/CH.
 
 In January 2023, an ARRIS VIP5002W appeared, which identifies itself as an APLSTB. However, I will keep the plugin name unchanged at EOSSTB. 
 
@@ -72,7 +72,7 @@ In January 2023, an ARRIS VIP5002W appeared, which identifies itself as an APLST
 This plugin is not provided by Magenta or Telenet or Sunrise or Virgin Media or Ziggo any other affiliate of [UPC](https://en.wikipedia.org/wiki/UPC_Broadband). It is neither endorsed nor supported nor developed by [UPC](https://en.wikipedia.org/wiki/UPC_Broadband) or any affiliates. [UPC](https://en.wikipedia.org/wiki/UPC_Broadband) 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/iPadOS 14.0 (or later). Developed on iOS 14.1...16.6, earlier versions not tested.
+* An Apple iPhone or iPad with iOS/iPadOS 14.0 (or later). Developed on iOS 14.1...17.1, earlier versions not tested.
 * [Homebridge](https://homebridge.io/) v1.1.116 (or later). Developed on Homebridge 1.1.116....1.6.1, 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.
@@ -115,7 +115,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 16.6). Hopefully, Apple will add support for these features in the future. You can however use this data in Home Automations or 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 17.1). Hopefully, Apple will add support for these features in the future. You can however use this data in Home Automations or the Shortcuts app.
 
 
 
@@ -132,7 +132,7 @@ After installing, make sure you restart Homebridge.
 The set-top box accessory is exposed as a separate external accessory and each set-top box needs to be manually paired as follows:
 
 1. Open the **Home** app on your device.
-2. Tap **+** in the top right corner of the screen and then **Add Accessory** to start the process of adding a new accessory.
+2. Tap the **Home** tab, then tap **+** in the top right corner of the screen and then **Add Accessory** to start the process of adding a new accessory.
 4. **Add Accessory**: tap **More options...** to add the accessory manually.
 5. **Select an Accessory to Add to \<HomeName\>**: Select the accessory you want to add. You should see your set-top box here. If not, check your Homebridge config.
 6. Accept the **Uncertified Accessory** warning by tapping **Add Anyway**.
@@ -160,6 +160,8 @@ The following keys are supported by in the **Apple TV Remote** in the Control Ce
 
 | Key | Single Tap | Double Tap |
 | ------- | ----------- | ------- |
+| Mute | (see note) | (see note) |
+| Power | (see note) | (see note) |
 | Up | ArrowUp | ChannelUp |
 | Down | ArrowDown | ChannelDown |
 | Left | ArrowLeft | MediaRewind |
@@ -171,6 +173,8 @@ The following keys are supported by in the **Apple TV Remote** in the Control Ce
 | Volume Up | volUpCommand | - |
 | Volume Down | volDownCommand | 3 clicks = mute |
 
+NOTE: The Mute and Power buttons appear in the Remote Control as of iOS 17.1, however they are disabled. Currently, I do not know how to enable these buttons. If you have any information about these buttons, please get in touch with me.
+
 The table shows the default key mappings. You can map any Apple TV Remote button to any set-top box remote control button, see the Wiki for all of the known [KeyEvents](https://github.com/jsiegenthaler/homebridge-eosstb/wiki/KeyEvents).
 
 The volume controls do not control the set-top box directly, as the set-top box has no volume capability. The set-top box physical remote actually sends IR commands to your TV. If you can control your TV volume via a network connection then the volume controls can be used to send volume commands to your TV via the raspberry pi. This is what the author uses.
@@ -204,13 +208,13 @@ Services used in this set-top box accessory are:
 4. Input service. The input (TV channels) utilises one service per input. The maximum possible channels (inputs) are thus 100 - 3 = 97. I have limited the inputs to maximum 95, but you can override this in the config (helpful to reduce log entries when debugging). The inputs are hard limited to 95 inputs.
 
 ### Media State (Play/Pause) Limitations
-The eosstb plugin can detect the target and current media state and shows STOP, PLAY, PAUSE or LOADING (loading is displayed only for current media state 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.6) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.
+The eosstb plugin can detect the target and current media state and shows STOP, PLAY, PAUSE or LOADING (loading is displayed only for current media state when fast-forwarding or rewinding) in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the media state (as at iOS 17.1) 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 the eosstb plugin uses it to set the inUse charateristic if the set-top box is turned on or is recording to the local HDD. This is useful 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 16.6) 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 17.1) 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`.
@@ -300,7 +304,7 @@ Mandatory config items must always exist. These are used to establish the sessio
 
 * **triplePressTime**: The amount of time in ms to detect triple-tap of a button. Used for triple-tap or triple-press features, such as triple-press of Volume Down generates Mute. Optional, defaults to 800ms.
 
-* **masterChannelListValidFor**: Amount of time in seconds that the master channel list stays valid for. Default 1800s.
+* **masterChannelListValidFor**: Amount of time in seconds that the master channel list stays valid for. Default 60s.
 
 * **debugLevel**: Controls the amount of debug data shown in the Homebridge logs, independent of the debug setting in Homebridge. Extra debug messages above level 0 are shown in the Homebridge log in the warning colour, normally yellow. Supported values are: 0=No debug logging, 1=Minimum, 2=Enhanced, 3=Verbose. Optional. Defaults to 0 if not found. Warning: a lot of log entries can occur at the higher debug levels.
 

package/index.js

@@ -838,7 +838,12 @@ class stbPlatform {
 				method: 'POST',
 				url: countryBaseUrlArray[this.config.country.toLowerCase()] + '/auth-service/v1/authorization',
 				headers: {
-					"x-device-code": "web" // mandatory
+					"accept": "*/*", // added 07.08.2023
+					"content-type": "application/json; charset=utf-8", // added 07.08.2023
+					"x-device-code": "web", // mandatory
+					//'x-oesp-username': this.session.username , // added 07.08.2023
+					//"x-profile": profile.profileId,  // added 07.08.2023
+					//"x-tracking-id": this.customer.hashedCustomerId, // hashed customer id  // added 07.08.2023
 				}, 
 				jar: cookieJar,
 				data: {

package/package.json

@@ -3,13 +3,13 @@
   "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": "2.2.11",
+  "version": "2.2.12",
   "platformname": "eosstb",
   "dependencies": {
     "axios-cookiejar-support": "^4.0.7",
-    "axios": "^1.4.0",
+    "axios": "^1.6.0",
     "debug": "^4.3.4",
-    "mqtt": "^5.0.2",
+    "mqtt": "^5.1.3",
     "qs": "^6.11.2",
     "semver": "^7.5.4",
     "tough-cookie": "^4.1.3"
@@ -17,7 +17,7 @@
   "deprecated": false,
   "engines": {
     "homebridge": "^1.6.1",
-    "node": "^18.17.0"
+    "node": "^20.9.0"
   },
   "homepage": "https://github.com/jsiegenthaler/homebridge-eosstb#readme",
   "keywords": [