homebridge-eosstb 2.2.4 → 2.2.6

package/CHANGELOG.md

@@ -10,6 +10,20 @@ Please restart Homebridge after every plugin update.
 * Implement refreshToken capabilities
 
 
+## 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
+* Minor improvements to the Readme
+
+
 ## 2.2.4 (2023-03-11)
 * Bumped dependency "qs": "^6.11.1",
 * Bumped dependency "node": ">=16.19.1"

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.3, 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.4, 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.3). 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.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.
 
 
 
@@ -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.3) 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.4) 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.3) 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.4) 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`.
@@ -285,7 +285,7 @@ Mandatory config items must always exist. These are used to establish the sessio
 
 + **country**: Your country. Must be one of ch, nl, be-nl, be-fr, at or gb. Not case sensitive. This controls the country-specific logon sequence and the mqtt sessions. Mandatory.
 
-* **username**: Your login username for your TV account. Normally an email address. Mandatory.
+* **username**: Your login username for your TV account, same as used in the TV app on your iOS device. Often an email address, but some providers use a mobile phone number. Mandatory.
 
 * **password**: Your password associated with your TV account. Mandatory.
 

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
@@ -306,6 +307,9 @@ class stbPlatform {
 		this.api = api;
     	this.stbDevices = []; // store stbDevice in this.stbDevices
 
+		// 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; }
 		const configWarningText = '%s config incomplete: "{configItemName}" missing. Initialization aborted.';
@@ -334,7 +338,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
@@ -602,7 +605,6 @@ class stbPlatform {
 			if (!this.devices || !this.devices[0].settings) {
 				this.currentStatusFault = Characteristic.StatusFault.GENERAL_FAULT;
 				this.sessionWatchdogRunning = false;
-				if (this.config.debugLevel > 2) { this.log.warn('%s: session connected but no devices found. Exiting %s with sessionWatchdogRunning=%s', watchdogInstance, watchdogInstance, this.sessionWatchdogRunning); }
 				//this.log('Failed to find any devices. The backend systems may be down, or you have no supported devices on your customer account')
 				reject('No devices found. The backend systems may be down, or you have no supported devices on your customer account')
 
@@ -1000,7 +1002,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
 															});	
 														};
 													};
@@ -1009,7 +1011,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
 											});
 									};
 								})
@@ -1499,23 +1502,26 @@ class stbPlatform {
 				
 					// update all the devices in the array. Don't trust the index order in the Personalization Data message
 					//this.log('getPersonalizationData: this.stbDevices.length:', this.stbDevices.length)
-					this.devices.forEach((device) => {
-						if (this.config.debugLevel > 2) { // DEBUG
-							this.log.warn('getPersonalizationData: device settings for device %s:', device.deviceId);
-							this.log.warn(device.settings);
-							this.log.warn('getPersonalizationData: device capabilities for device %s:', device.deviceId);
-							this.log.warn(device.capabilities);
-						}
-						const deviceId = device.deviceId;
-						const deviceIndex = this.devices.findIndex(device => device.deviceId == deviceId)
-						if (deviceIndex > -1 && this.stbDevices[deviceIndex]) { 
-							this.stbDevices[deviceIndex].device = device;
-							this.stbDevices[deviceIndex].customer = this.customer; // store entire customer object
-
-							//   mqttDeviceStateHandler(deviceId, 			powerState, mediaState, recordingState, channelId, 	eventId, 	sourceType, profileDataChanged, statusFault, 	programMode, statusActive, currInputDeviceType, currInputSourceType) {
-							this.mqttDeviceStateHandler(device.deviceId, 	null, 		null, 		null, 			null, 		null, 		null, 		true, 				Characteristic.StatusFault.NO_FAULT ); // update this device
-						}
-					});
+					if (this.stbDevices.length > 0) {
+						this.devices.forEach((device) => {
+							if (this.config.debugLevel > 2) { // DEBUG
+								this.log.warn('getPersonalizationData: device settings for device %s:', device.deviceId);
+								this.log.warn(device.settings);
+								this.log.warn('getPersonalizationData: device capabilities for device %s:', device.deviceId);
+								this.log.warn(device.capabilities);
+							}
+							const deviceId = device.deviceId;
+							const deviceIndex = this.devices.findIndex(device => device.deviceId == deviceId)
+							if (deviceIndex > -1 && this.stbDevices[deviceIndex]) { 
+								this.stbDevices[deviceIndex].device = device;
+								this.stbDevices[deviceIndex].customer = this.customer; // store entire customer object
+	
+								//   mqttDeviceStateHandler(deviceId, 			powerState, mediaState, recordingState, channelId, 	eventId, 	sourceType, profileDataChanged, statusFault, 	programMode, statusActive, currInputDeviceType, currInputSourceType) {
+								this.mqttDeviceStateHandler(device.deviceId, 	null, 		null, 		null, 			null, 		null, 		null, 		true, 				Characteristic.StatusFault.NO_FAULT ); // update this device
+							}
+						});
+
+					}
 					
 
 					// profiles are an array named profiles, store entire array in this.profiles

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.4",
+  "version": "2.2.6",
   "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": [