homebridge-eosstb 2.2.5 → 2.2.8

package/CHANGELOG.md

@@ -10,6 +10,20 @@ Please restart Homebridge after every plugin update.
 * Implement refreshToken capabilities
 
 
+## 2.2.8 (2023-05-22)
+* Updated iOS version references
+* Fixed bug causing Homebridge crash when master channel list is not yet loaded
+* Fixed bug causing Homebridge crash when any error occurs in refresh of master channel list
+
+
+## 2.2.6 (2023-05-19)
+* Fixed some minor logging typos
+* Added logging of version info
+* Updated engine version references
+* Bumped dependency "axios": "^1.4.0",
+* Bumped dependency "qs": "^6.11.2",
+
+
 ## 2.2.5 (2023-03-28)
 * Improved robustness when no set-top boxes detected in the user profile
 * Updated iOS version references

package/README.md

@@ -72,8 +72,8 @@ 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.4, earlier versions not tested.
-* [Homebridge](https://homebridge.io/) v1.1.116 (or later). Developed on Homebridge 1.1.116....1.6.0, earlier versions not tested.
+* An Apple iPhone or iPad with iOS/iPadOS 14.0 (or later). Developed on iOS 14.1...16.5, 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.
 * An ARRIS DCX960 or HUMAX EOS1008R / 2008C / VIP5002W set-top box, provided by your TV provider as part of your TV subscription, called by the system an "EOSSTB", "EOS2STB" or "APLSTB" and marketed under different names in different countries. 
@@ -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.4). 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 16.5). Hopefully, Apple will add support for these features in the future. You can however use this data in Home Automations or the Shortcuts app.
 
 
 
@@ -136,7 +136,7 @@ The set-top box accessory is exposed as a separate external accessory and each s
 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**.
-7. **Enter HomeKit Setup Code**: Enter the **HomeKit Setup Code** (displayed in Homebridge under the QR code, format XXX-XX-XXX), or use the device's camera to scan the QR code in Homebridge and tap **Continue**.
+7. **Enter HomeKit Setup Code**: Enter the **HomeKit Setup Code** (displayed in Homebridge under the QR code, format XXXX-XXXX), or use the device's camera to scan the QR code in Homebridge and tap **Continue**.
 8. **Set-Top Box Location**: Select a room for your new accessory and tap **Continue**.
 9. **Set-Top Box Name**: Give your set-top box a different name if you wish (synchronised to your real set-top box, you can change this in the Home app later) and tap **Continue**.
 10. **Name TV Input Sources**: Re-name your TV input sources if you wish (you can change these in the Home app later) and tap **Continue**.
@@ -204,13 +204,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.4) 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 16.5) 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.4) 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.5) 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/index.js

@@ -14,6 +14,7 @@ const fsPromises = require('fs').promises;
 const path = require('path');
 const debug = require('debug')('eosstb'); // https://github.com/debug-js/debug
 // good example of debug usage https://github.com/mqttjs/MQTT.js/blob/main/lib/client.js
+const semver = require('semver')		// https://github.com/npm/node-semver
 
 const mqtt = require('mqtt');  			// https://github.com/mqttjs
 const qs = require('qs');				// https://github.com/ljharb/qs
@@ -305,6 +306,10 @@ class stbPlatform {
 		this.config = config;
 		this.api = api;
     	this.stbDevices = []; // store stbDevice in this.stbDevices
+		this.masterChannelList = [];
+
+		// show some useful version info
+		this.log.info('%s v%s, node %s, homebridge v%s', packagejson.name, packagejson.version, process.version, this.api.serverVersion)
 
 		// only load if configured and mandatory items exist. Homebridge checks for platform itself, and name is not critical
 		if (!this.config) { this.log.warn('%s config missing. Initialization aborted.', PLUGIN_NAME); return; }
@@ -334,7 +339,6 @@ class stbPlatform {
 		//this.api.on('didFinishLaunching', () => {
 		this.api.on('didFinishLaunching', async () => {
 			if (this.config.debugLevel > 2) { this.log.warn('API event: didFinishLaunching'); }
-			this.log('%s v%s', PLUGIN_NAME, PLUGIN_VERSION);
 			debug('stbPlatform:apievent :: didFinishLaunching')
 
 			// call the session watchdog once to create the session initially
@@ -344,7 +348,23 @@ class stbPlatform {
 			this.checkSessionInterval = setInterval(this.sessionWatchdog.bind(this),SESSION_WATCHDOG_INTERVAL_MS);
 
 			// check for a channel list update every MASTER_CHANNEL_LIST_REFRESH_CHECK_INTERVAL_S seconds
-			this.checkChannelListInterval = setInterval(this.refreshMasterChannelList.bind(this),MASTER_CHANNEL_LIST_REFRESH_CHECK_INTERVAL_S * 1000);
+			//this.checkChannelListInterval = setInterval(this.refreshMasterChannelList.bind(this),MASTER_CHANNEL_LIST_REFRESH_CHECK_INTERVAL_S * 1000);
+
+
+			this.checkChannelListInterval = setInterval(() => {
+				// refreshMasterChannelList is an async function returning a promise, so handle any rejects
+				this.refreshMasterChannelList()
+					.then( response => {
+						if (this.config.debugLevel >= 0) { 
+							this.log.warn('stbPlatform: refreshMasterChannelList completed OK'); 
+						}
+					})
+					.catch(error => {
+						if (this.config.debugLevel >= 0) {
+							this.log.warn('stbPlatform: could not refresh master channel list:', error);
+						}
+					})
+			}, MASTER_CHANNEL_LIST_REFRESH_CHECK_INTERVAL_S * 1000 ) // need to pass ms
 
 			debug('stbPlatform:apievent :: didFinishLaunching end of code block')
 			//this.log('stbPlatform: end of code block');
@@ -999,7 +1019,7 @@ class stbPlatform {
 															.catch(error => {
 																//this.log.warn("Step 6 of 6: Unable to authorize with oauth code:", error.response.status, error.response.statusText);
 																this.log.debug("Step 6 of 6: Unable to authorize with oauth code:",error);
-																reject("Step 6 of 6: Step 6 of 6: Unable to authorize with oauth code: " + error.response.status + ' ' + error.response.statusText); // reject the promise and return the error
+																reject("Step 6 of 6: Unable to authorize with oauth code: " + error.response.status + ' ' + error.response.statusText); // reject the promise and return the error
 															});	
 														};
 													};
@@ -1008,7 +1028,8 @@ class stbPlatform {
 											.catch(error => {
 												//this.log.warn("Step 4 of 6: Unable to oauth authorize:", error.response.status, error.response.statusText);
 												this.log.debug("Step 4 of 6: Unable to oauth authorize:",error);
-												reject("Step 2 of 6: Step 4 of 6: Unable to oauth authorize: " + error.response.status + ' ' + error.response.statusText); // reject the promise and return the error
+												//reject("Step 4 of 6: Unable to oauth authorize: " + error.response.status + ' ' + error.response.statusText); // reject the promise and return the error
+												reject("Step 4 of 6: Unable to oauth authorize: " + error); // reject the promise and return the error
 											});
 									};
 								})
@@ -1366,6 +1387,7 @@ class stbPlatform {
 				url: url,
 				headers: {
 					accept: '*/*',
+					"x-oesp-token": this.session.accessToken, // to try and avoid the 401 auth issues
 					'x-oesp-username': this.session.username
 				}
 			};
@@ -1374,6 +1396,11 @@ class stbPlatform {
 					if (this.config.debugLevel > 0) { this.log.warn('refreshMasterChannelList: response: %s %s', response.status, response.statusText); }
 					//this.log(response.data);
 
+					// the header contains the following:
+					// Cache-Control: max-age=600, public, stale-if-error=43200
+					// this could be used to set expiry date...
+
+
 					// set the masterChannelListExpiryDate to expire at now + MASTER_CHANNEL_LIST_VALID_FOR_S
 					this.masterChannelListExpiryDate =new Date(new Date().getTime() + (MASTER_CHANNEL_LIST_VALID_FOR_S * 1000));
 					//this.log('MasterChannelList valid until',this.masterChannelListExpiryDate.toLocaleString())
@@ -1419,7 +1446,6 @@ class stbPlatform {
 
 
 
-
 	// load all recording states and bookings
 	// called when a mqtt topic is received indicating a recording settings change
 	async refreshRecordings(householdId, callback) {

package/package.json

@@ -3,20 +3,21 @@
   "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.5",
+  "version": "2.2.8",
   "platformname": "eosstb",
   "dependencies": {
     "axios-cookiejar-support": "^4.0.6",
-    "axios": "^1.3.4",
+    "axios": "^1.4.0",
     "debug": "^4.3.4",
     "mqtt": "^4.3.7",
-    "qs": "^6.11.1",
+    "qs": "^6.11.2",
+    "semver": "^7.5.1",
     "tough-cookie": "^4.1.2"
   },
   "deprecated": false,
   "engines": {
-    "homebridge": ">=1.6.0",
-    "node": ">=16.19.1"
+    "homebridge": "^1.6.1",
+    "node": "^18.16.0"
   },
   "homepage": "https://github.com/jsiegenthaler/homebridge-eosstb#readme",
   "keywords": [