homebridge-eosstb 2.0.4 → 2.1.0

package/CHANGELOG.md

@@ -3,19 +3,24 @@ All notable changes to this project will be documented in this file.
 See the [Readme file](https://github.com/jsiegenthaler/homebridge-eosstb/blob/master/README.md) for full plugin documentation.
 Please restart Homebridge after every plugin update.
 
-# IMPORTANT NOTICE
-This (v2.x) is a major update over v1.x due to the change in endpoints in the backend systems that occured on 13.10.2022.
-Please report all bugs and problems.
-
-
 # Bug Fixes and Improvements
 
 ## Current To-Do and In-Work List (For Future Releases, in rough order of priority):
-* Work on ideas for showing radio channels and using them -> STARTED. Possible only with KeyMacros. How should these appear in the channel list?
-* Fix potential problem with getPersonalizationData failing after plugin has been running overnight with ERR_BAD_REQUEST
+* Add ability to log and read current program name
 * Implement refreshToken capabilities
 
 
+## 2.1.0 (2023-01-03)
+* Added KeyMacro support
+* Added custom characteristics: Current Channel Id and Current Channel Name, useful in automations
+* Added preparation for reading current program name (future feature)
+* Fixed bug where Input Device Type was not always correctly logged
+* Fixed bug where Input Source Type was not always correctly logged
+* Updated iOS version references
+* Bumped dependency "axios": "^1.2.2"
+* Bumped dependency "axios-cookiejar-support": "^4.0.6"
+
+
 ## 2.0.4 (2022-12-05)
 * Fixed model detection of HUMAX EOS1008R boxes
 * Fixed detection of Status Active to properly show mqtt active or not using Status Active in the Home app
@@ -41,10 +46,15 @@ Please report all bugs and problems.
 * Bumped Homebridge "homebridge": ">=1.6.0",
 
 
+## 2.0.2-beta.1 (2022-11-19)
+* Added custom characteristic Current Channel Id
+* Added custom characteristic Current Channel Name
+* Optimised some code
+
+
 ## 2.0.1 (2022-11-19)
 * Increased reliability of mqtt messages by setting QoS
-* Optimised the GB session code
-* Removed some left over debug code
+* Optimised the GB session code Removed some left over debug code
 
 
 ## 2.0.0 (2022-11-14)
@@ -52,4 +62,4 @@ Please report all bugs and problems.
 * Major startup speed improvements after Homebridge reboot
 * Improved mqtt performance
 * Added support of channel sort by most watched
-* And many more small bug fixes and improvements included
+* And many more small bug fixes and improvements included

package/README.md

@@ -70,7 +70,7 @@ 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](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.1, earlier versions not tested.
+* An Apple iPhone or iPad with iOS/iPadOS 14.0 (or later). Developed on iOS 14.1...16.2, 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.
 * 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.
@@ -83,9 +83,11 @@ This plugin is not provided by Magenta or Telenet or Sunrise or Virgin Media or
 
 * **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.
 
+* **Powerful Key Macros**: You can program key macros to control your set-top box. Key macros are powerful ways of accessing any content such as radio channels that cannot be accessed directly via a channel number.
+
 * **Siri Support** You can control your box with Siri (to the extent of what Apple Siri supports).
 
-* **Shortcuts Support** You can read and control your box with Shortcuts and HomeKit automations (to the extent of what Apple supports), allowing you to control switch-on and channel selection in Home Automations, Shorcuts and Personal Automations.
+* **Shortcuts Support** You can read and control your box with Shortcuts and HomeKit automations (to the extent of what Apple supports), allowing you to control switch-on and channel selection in Home Automations, Shortcuts and Personal Automations.
 
 * **Synchronised Set-Top Box Name**: Changing the name of the set-top box in the Home app changes it on the TV and backend systems in real time, and vice-versa. No reboot required. You can turn off the sync if desired in the config.
 
@@ -111,7 +113,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.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.
+* **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.2). Hopefully, Apple will add support for these features in the future. You can however use this data in Home Automations or the Shortcuts app.
 
 
 
@@ -172,7 +174,7 @@ The table shows the default key mappings. You can map any Apple TV Remote button
 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.
 
 
-## Using Profiles to better manage your Channel List
+## Using Profiles to Better Manage your Channel List
 Many TV providers provide hundreds of TV channels. The Home app is limited to 100 "services", which are TV channels or reserved for system control. This limits the maximum possible channels to 95, and thus the plugin will load the first 95 subscribed channels found, ignoring all non-subscribed channels. 
 
 If the channels you wish to have in the Home app are not within the first 95 subscribed channels in your TV providers channel list, then you can create a profile on the set-top box, and configure the profile with the channels you want, in the order you want. Enter the same profile name in the plugin config **Profile Name**, and the plugin will load the channels from that profile.
@@ -185,6 +187,10 @@ The profile used by the plugin does not have to be the same as the set-top box's
 ## Sorting the Channel list
 The config item **Channel Sort By** allows the channels to be sorted by **Channel Order** (the standard channel order as shown on the TV) or by **Most Watched**. Most Watched is reported by the backend systems and is profile-based. It is not clear how often this list is updated, however for a TV subscription with many channels, this may be a preferable option to show your most watched channels at the top of the channel list.
 
+## Using Key Macros to Access Extra Capabilities
+You can program key macros to access any function of your set-top box. This is particularly useful to select radio channels. Key macros are loaded at the end of the channel list. See the [Wiki Key Macros page](https://github.com/jsiegenthaler/homebridge-eosstb/wiki/Key-Macros) for full details. 
+
+
 
 ## Limitations
 ### Channel Count
@@ -195,17 +201,14 @@ Services used in this set-top box accessory are:
 3. Speaker service (for the controlling the TV accessory volume)
 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.
 
-### Web App Controllers Take Over Sometimes
-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 16.1) 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.2) 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.1) 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.2) 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`.
@@ -223,7 +226,7 @@ Example minimum (mandatory) configuration:
     ]
 ```
 
-Example extended configuration as used on the author with his Samsung TV (where x.x.x.x is the IP address of the TV). An extended configuration allows you to customise the behaviour of each set-top box device. You must identify the devices by their deviceId:
+Example extended configuration as used on the author with his EOSSTB set-top box. An extended configuration allows you to customise the behaviour of each set-top box device. You must identify the devices by their deviceId:
 
 ```js
     "platforms": [
@@ -257,6 +260,10 @@ Example extended configuration as used on the author with his Samsung TV (where
                     "maxChannels": 50
                 },
             "channels": [
+                {
+                    "channelKeyMacro": "TV MediaTopMenu wait(1000) ArrowRight ArrowRight Enter wait(1000) ArrowDown wait(1500) Enter wait(2000) Enter",
+                    "channelName": "Last Played Radio"
+                },
                 {
                     "channelId": "SV09690",
                     "channelName": "Netflix"
@@ -358,7 +365,9 @@ Some channels such as Netflix are actually apps on the set-top box, and not norm
 
 * **channelId**: The channelId, as defined by the TV provider. Unknown channelIds will appear in the Homebridge log.
 
-* **channelNames**: Allows you to add unknown channel names, or to rename any channel as you wish. Required as some channels (e.g., Netflix) are not published on the master channel list. If a channel displays in the Home app like this: "Channel SV09690", then check your TV to see the channel name, and add it to the config. An example is provided for Netflix. Optional, unknown channels are displayed as "Channel xxxxxxx" where xxxxxxx is the channelId.
+* **channelKeyMacro**: The channel key macro (key sequence) to send. If channelKeyMacro is present, channelId is ignored.
+
+* **channelNames**: Allows you to add unknown channel names, names for key macros, or to rename any channel as you wish. Required as some channels (e.g., Netflix) are not published on the master channel list. If a channel displays in the Home app like this: "Channel SV09690", then check your TV to see the channel name, and add it to the config. An example is provided for Netflix. Optional, unknown channels are displayed as "Channel xxxxxxx" where xxxxxxx is the channelId.
 
 
 * Telenet BE: 

package/config.schema.json

@@ -1118,6 +1118,7 @@
                     "type": "array",
                     "items": [
                         "channels[].channelId",
+                        "channels[].channelKeyMacro",
                         "channels[].channelName"
                     ]
                 }

package/index.js

@@ -28,7 +28,6 @@ const cookieJar = new tough.CookieJar();
 const axios = require('axios') //.default;	// https://github.com/axios/axios
 axios.defaults.xsrfCookieName = undefined; // change  xsrfCookieName: 'XSRF-TOKEN' to  xsrfCookieName: undefined, we do not want this default,
 const axiosWS = axios.create({
-	// axios-cookiejar-support v2.0.2 required config
 	jar: cookieJar, //added in axios-cookiejar-support v2.0.x, see https://github.com/3846masa/axios-cookiejar-support/blob/main/MIGRATION.md
 });
 
@@ -1350,6 +1349,7 @@ class stbPlatform {
 						if (this.config.debugLevel > 2) { this.log('Processing channel:',i,channel.logicalChannelNumber,channel.id, channel.name); } // for debug purposes
 						// log the detail of logicalChannelNumber 60 nicktoons, for which I have no subscription, as a test of entitlements
 						//if (this.config.debugLevel > 0) { if (channel.logicalChannelNumber == 60){ this.log('DEV: Logging Channel 60 to check entitlements :',channel); } }
+						//if (this.config.debugLevel > 0) { if (channel.logicalChannelNumber == 60){ this.log('DEV: Logging Channel 60 to check entitlements :',channel); } }
 						this.masterChannelList.push({
 							id: channel.id, 
 							name: cleanNameForHomeKit(channel.name),
@@ -1379,103 +1379,6 @@ class stbPlatform {
 		})
 	}
 
-	// load all available TV channels at regular intervals into an array
-	// new version using endpoints available from 13.10.2022
-	// the masterChannelList contains all possible channels, bith subscribed and non-subscribed channels
-	async refreshMasterChannelListPrev(callback) {
-		// called by refreshMasterChannelList (state handler), thus runs at polling interval
-
-		// exit immediately if the session does not exist
-		if (currentSessionState != sessionState.CONNECTED) { 
-			if (this.config.debugLevel > 1) { this.log.warn('refreshMasterChannelList: Session does not exist, exiting'); }
-			return false;
-		}
-
-		// exit immediately if channel list has not expired
-		if (this.masterChannelListExpiryDate > Date.now()) {
-			if (this.config.debugLevel > 1) { this.log.warn('refreshMasterChannelList: Master channel list has not expired yet. Next refresh will occur after %s', this.masterChannelListExpiryDate.toLocaleString()); }
-			return false;
-		}
-
-		if (this.config.debugLevel > 1) {
-			this.log.warn('refreshMasterChannelList: Refreshing master channel list...');
-		}
-
-		// only continue if a session was created. If the internet conection is down then we have no session
-		//if (currentSessionState != sessionState.CONNECTED) { return; }
-		
-		// channels can be retrieved for the country without having a mqtt session going  but then the list is not relevant for the user's locationId
-		// so you should add the user's locationId as a parameter, and this needs the accessToken
-		// syntax:
-		// https://prod.oesp.virginmedia.com/oesp/v4/GB/eng/web/channels?byLocationId=41043&includeInvisible=true&includeNotEntitled=true&personalised=true&sort=channelNumber
-		// https://prod.spark.sunrisetv.ch/eng/web/linear-service/v2/channels?cityId=401&language=en&productClass=Orion-DASH
-		/*
-		let url = countryBaseUrlArray[this.config.country.toLowerCase()] + '/channels';
-		url = url + '?byLocationId=' + this.session.locationId // locationId needed to get user-specific list
-		url = url + '&includeInvisible=true' // includeInvisible
-		url = url + '&includeNotEntitled=true' // includeNotEntitled
-		url = url + '&personalised=true' // personalised
-		url = url + '&sort=channelNumber' // sort
-		*/
-		//url = 'https://prod.spark.sunrisetv.ch/eng/web/linear-service/v2/channels?cityId=401&language=en&productClass=Orion-DASH'
-		let url = countryBaseUrlArray[this.config.country.toLowerCase()] + '/eng/web/linear-service/v2/channels';
-		url = url + '?cityId=' + this.customer.cityId; //+ this.customer.cityId // cityId needed to get user-specific list
-		url = url + '&language=en'; // language
-		url = url + '&entitled=true'; // testing! 760 with all, 
-		url = url + '&productClass=Orion-DASH'; // productClass, must be Orion-DASH
-		//url = url + '&includeNotEntitled=false' // includeNotEntitled testing to see if this parameter is accepted
-		if (this.config.debugLevel > 2) { this.log.warn('refreshMasterChannelList: loading inputs from',url); }
-
-		// call the webservice to get all available channels
-		const axiosConfig = {
-			method: 'GET',
-			url: url
-		};
-		axiosWS(axiosConfig)
-			.then(response => {
-				//this.log(response.data);
-				if (this.config.debugLevel > 2) { this.log.warn('refreshMasterChannelList: Processing %s channels...', response.data.length); }
-
-				// 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())
-			
-				// load the channel list with all channels found
-				this.masterChannelList = [];
-				const channels = response.data;
-				this.log.debug('Channels to process:',channels.length);
-				for(let i=0; i<channels.length; i++) {
-					const channel = channels[i];
-					// if (this.config.debugLevel > 0) { this.log('Loading channel:',i,channel.logicalChannelNumber,channel.id, channel.name); } // for debug purposes
-					// log the detail of logicalChannelNumber 60 nicktoons, for which I have no subscription, as a test of entitlements
-					//if (this.config.debugLevel > 0) { if (channel.logicalChannelNumber == 60){ this.log('DEV: Logging Channel 60 to check entitlements :',channel); } }
-					this.masterChannelList.push({
-						id: channel.id, 
-						name: cleanNameForHomeKit(channel.name),
-						logicalChannelNumber: channel.logicalChannelNumber, 
-						linearProducts: channel.linearProducts				
-					});
-				}
-					
-				if (this.config.debugLevel > 0) {
-					this.log.warn('refreshMasterChannelList: Master channel list refreshed with %s channels, valid until %s', this.masterChannelList.length, this.masterChannelListExpiryDate.toLocaleString());
-				}
-				return true;
-
-			})
-			.catch(error => {
-				let errText, errReason;
-				errText = 'Failed to refresh the master channel list - check your internet connection:'
-				if (error.isAxiosError) { 
-					errReason = error.code + ': ' + (error.hostname || ''); 
-					// if no connection then set session to disconnected to force a session reconnect
-					if (error.code == 'ENOTFOUND') { currentSessionState = sessionState.DISCONNECTED; }
-				}
-				this.log('%s %s', errText, (errReason || ''));
-				this.log.warn(`refreshMasterChannelList error:`, error);
-				return error;
-			});
-	}
 
 
 	// get Personalization Data via web request GET
@@ -1902,7 +1805,7 @@ class stbPlatform {
 								}
 
 								// variables for just in this function
-								var deviceId, stbState, currPowerState, currMediaState, currChannelId, currSourceType, profileDataChanged, currRecordingState, currStatusActive, currInputDeviceType, currInputSourceType;
+								var deviceId, stbState, currPowerState, currMediaState, currChannelId, currEventId, currSourceType, profileDataChanged, currRecordingState, currStatusActive, currInputDeviceType, currInputSourceType;
 
 								// handle personalizationService messages
 								// Topic: Topic: 107xxxx_ch/personalizationService
@@ -2048,6 +1951,7 @@ class stbPlatform {
 											// Careful: source is not always present in the data
 											if (playerState.source) {
 												currChannelId = playerState.source.channelId || NO_CHANNEL_ID; // must be a string
+												currEventId = playerState.source.eventId; // the title (program) id
 												if (parent.config.debugLevel > 0 && parent.masterChannelList) {
 													let currentChannelName; // let is scoped to the current {} block
 													let curChannel = parent.masterChannelList.find(channel => channel.id === currChannelId); 
@@ -2120,8 +2024,8 @@ class stbPlatform {
 
 
 								// update the device on every message
-								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
-								parent.mqttDeviceStateHandler(deviceId, currPowerState, currMediaState, currRecordingState, currChannelId, currSourceType, profileDataChanged, Characteristic.StatusFault.NO_FAULT, null, currStatusActive, currInputDeviceType, currInputSourceType);
+								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, eventid, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
+								parent.mqttDeviceStateHandler(deviceId, currPowerState, currMediaState, currRecordingState, currChannelId, currEventId, currSourceType, profileDataChanged, Characteristic.StatusFault.NO_FAULT, null, currStatusActive, currInputDeviceType, currInputSourceType);
 						
 								//end of try
 							} catch (err) {
@@ -2139,12 +2043,12 @@ class stbPlatform {
 						// https://github.com/mqttjs/MQTT.js#event-close
 						mqttClient.on('close', function () {
 							try {
-								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
+								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, eventId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
 								parent.currentMqttState = mqttState.closed;
 								parent.log('mqttClient: Connection closed');
 								currentSessionState = sessionState.DISCONNECTED; // to force a session reconnect
 								if (!isShuttingDown) {
-									parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
+									parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
 								}
 							} catch (err) {
 								parent.log.error("Error trapped in mqttClient close event:", err.message);
@@ -2157,10 +2061,10 @@ class stbPlatform {
 						// https://github.com/mqttjs/MQTT.js#event-reconnect
 						mqttClient.on('reconnect', function () {
 							try {
-								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
+								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, eventId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
 								parent.currentMqttState = mqttState.reconnected;
 								parent.log('mqttClient: Reconnect started');
-								parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
+								parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
 							} catch (err) {
 								parent.log.error("Error trapped in mqttClient reconnect event:", err.message);
 								parent.log.error(err);
@@ -2172,11 +2076,11 @@ class stbPlatform {
 						// https://github.com/mqttjs/MQTT.js#event-disconnect
 						mqttClient.on('disconnect', function () {
 							try {
-								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
+								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, eventId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
 								parent.currentMqttState = mqttState.disconnected;
 								parent.log('mqttClient: Disconnect command received');
 								currentSessionState = sessionState.DISCONNECTED; // to force a session reconnect
-								parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
+								parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
 							} catch (err) {
 								parent.log.error("Error trapped in mqttClient disconnect event:", err.message);
 								parent.log.error(err);
@@ -2188,11 +2092,11 @@ class stbPlatform {
 						// https://github.com/mqttjs/MQTT.js#event-disconnect
 						mqttClient.on('offline', function () {
 							try {
-								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
+								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, eventId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
 								parent.currentMqttState = mqttState.offline;
 								parent.log('mqttClient: Client is offline');
 								currentSessionState = sessionState.DISCONNECTED; // to force a session reconnect
-								parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
+								parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
 							} catch (err) {
 								parent.log.error("Error trapped in mqttClient offline event:", err.message);
 								parent.log.error(err);
@@ -2204,12 +2108,12 @@ class stbPlatform {
 						// https://github.com/mqttjs/MQTT.js#event-error
 						mqttClient.on('error', function(err) {
 							try {
-								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
+								// mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, eventId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType)
 								parent.currentMqttState = mqttState.error;
 								parent.log.warn('mqttClient: Error', (err.syscall || '') + ' ' + (err.code || '') + ' ' + (err.hostname || ''));
 								parent.log.warn('mqttClient: Error object:', err); 
 								currentSessionState = sessionState.DISCONNECTED; // to force a session reconnect
-								parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
+								parent.mqttDeviceStateHandler(null,	null, null,	null, null, null, null, null, Characteristic.StatusFault.GENERAL_FAULT); // set statusFault to GENERAL_FAULT
 								mqttClient.end();
 								return false;
 							} catch (err) {
@@ -2256,15 +2160,15 @@ class stbPlatform {
 
 	// handle the state change of the device, calling the updateDeviceState of the relevant device
 	// handles multiple devices by deviceId, should the user have more than one device
-	mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType) {
+	mqttDeviceStateHandler(deviceId, powerState, mediaState, recordingState, channelId, eventId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType) {
 		try {
 			if (this.config.debugLevel > 1) { 
-				this.log.warn('mqttDeviceStateHandler: calling updateDeviceState with deviceId %s, powerState %s, mediaState %s, channelId %s, sourceType %s, profileDataChanged %s, statusFault %s, programMode %s, statusActive %s, currInputDeviceType %s, currInputSourceType %s', deviceId, powerState, mediaState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType); 
+				this.log.warn('mqttDeviceStateHandler: calling updateDeviceState with deviceId %s, powerState %s, mediaState %s, channelId %s, eventId %s, sourceType %s, profileDataChanged %s, statusFault %s, programMode %s, statusActive %s, currInputDeviceType %s, currInputSourceType %s', deviceId, powerState, mediaState, channelId, eventId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType); 
 			}
 			const deviceIndex = this.devices.findIndex(device => device.deviceId == deviceId)
 			if (deviceIndex > -1 && this.stbDevices.length > 0) { 
 				//this.log.warn('mqttDeviceStateHandler: stbDevices found, calling updateDeviceState');
-				this.stbDevices[deviceIndex].updateDeviceState(powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType); 
+				this.stbDevices[deviceIndex].updateDeviceState(powerState, mediaState, recordingState, channelId, eventId, sourceType, profileDataChanged, statusFault, programMode, statusActive, currInputDeviceType, currInputSourceType); 
 			}
 		} catch (err) {
 			this.log.error("Error trapped in mqttDeviceStateHandler:", err.message);
@@ -2406,45 +2310,121 @@ class stbPlatform {
 		try {
 			if (this.config.debugLevel > 0) { this.log.warn('sendKey: keySequence %s, deviceName %s, deviceId %s', keySequence, deviceName, deviceId); }
 			if (mqttUsername) {
+				let hasJustBooted = false; // indicates if the box just booted up during this keyMacro
+				let keyCanBeSkippedAfterBootup = false; // indicates if the current key can be skipped
+				let firstNonSkippableKeyFound = false; // indicates if a non-skippable key was found
+				let defaultWaitDelayActive = false;	// indicates if the default wait delay is being used
 
 				let keyArray = keySequence.trim().split(' ');
-				if (keyArray.length > 1) { this.log('sendKey: processing keySequence %s for %s %s', keySequence, deviceName, deviceId); }
+				if (keyArray.length > 1) { this.log('sendKey: processing keySequence for %s: "%s"', deviceName, keySequence); }
 				// supported key1 key2 key3 wait() wait(100)
 				for (let i = 0; i < keyArray.length; i++) {
 					const keyName = keyArray[i].trim();
 					this.log('sendKey: processing key %s of %s: %s', i+1, keyArray.length, keyName);
+					const defaultWaitDelay = 200; // default 200ms
+					const maxWaitDelay = 20000; // default 200ms
+					const waitReadyDelayStep = 500; // the ms wait time in each waitReady loop
+					const maxWaitReadyLoops = maxWaitDelay / waitReadyDelayStep; // the max loop iterations to wait for ready
+					const currKeyIsEscapeOrTvOrWait = 
+						keyName.toLowerCase().startsWith('wait(') 		// current key is a wait
+						|| keyName.toLowerCase() == 'escape'			// or current key is an Escape
+						|| keyName.toLowerCase() == 'tv';				// or current key is TV
+					if (!firstNonSkippableKeyFound && !currKeyIsEscapeOrTvOrWait) {
+						firstNonSkippableKeyFound = true;				// first non-escape or non-wait key found
+					} 
+					keyCanBeSkippedAfterBootup = false; 				// reset for each key
+					defaultWaitDelayActive = false;						// reset for each key
+
+
+					// for all keys except Power:
+					// check if box is ready (up and running), if not, loop until we hit maxWaitDelay, waiting waitReadyDelayStep ms each loop
+					// loop only while i < maxWaitReadyLoops and current media state = STOP
+					// The device changes CurrentMediaState from STOP to PLAY when it has powered up and is streaming TV
+					// CurrentMediaState=STOP only occurs when the set-top box is turned off, so is a good indicator that it is streaming content
+					// TEST THIS WITH NETFLIX!
+					if (keyName.toLowerCase() != 'power') {
+						const deviceIndex = this.devices.findIndex(device => device.deviceId == deviceId)
+						// detect CurrentMediaState=STOP to show box has just booted
+						if (this.stbDevices[deviceIndex].currentMediaState == Characteristic.CurrentMediaState.STOP) { 
+							this.log('sendKey: key %s: waiting for ready for %s', i+1, deviceName);
+							for (let j=0; 
+								j<maxWaitReadyLoops
+								&& this.stbDevices[deviceIndex].currentMediaState == Characteristic.CurrentMediaState.STOP;
+								j++) {
+								hasJustBooted  = true; 				// indicates that the box just booted up during this keyMacro
+								await waitprom(waitReadyDelayStep); // wait waitReadyDelayStep ms on each loop
+								this.log.debug('sendKey: key %s: loop %s: wait %s ms done, hasJustBooted %s, currentMediaState %s', i+1, j, hasJustBooted, waitReadyDelayStep, currentMediaStateName[this.stbDevices[deviceIndex].currentMediaState]);
+							}
+							this.log.debug('sendKey: key %s: waiting one more delay of %s ms', i+1, waitReadyDelayStep);
+							await waitprom(waitReadyDelayStep); // wait waitReadyDelayStep ms one last time to ensure we have one wait after change from STOP to PLAY
+							this.log('sendKey: key %s: waiting for ready done, hasJustBooted %s, currentMediaState %s', i+1, hasJustBooted, currentMediaStateName[this.stbDevices[deviceIndex].currentMediaState]);
+						}
+					}
+
 					
-					// if a wait appears, use it
-					let waitDelay; // default
-					if (keyName.toLowerCase().startsWith('wait(')) {
-						this.log.debug('sendKey: reading delay from %s', keyName);
+
+					// check if current key can be skipped.
+					// leading Escape and wait keys can be skipped after a bootup to speed up the selection of a radio channel using a scene
+					// any skipping must stop when the first non-Escape and non-wait key is found
+					this.log.debug('sendKey: key %s: keyArray.length %s, prevKey %s, currKey %s, nextKey %s', i+1, keyArray.length, keyArray[i-1], keyArray[i], keyArray[i+1])
+					if (	hasJustBooted 						// box has just booted
+							&& currKeyIsEscapeOrTvOrWait		// current key is escape or tv or wait
+							&& !firstNonSkippableKeyFound		// have not yet found the first non-skippable key
+						) {
+						keyCanBeSkippedAfterBootup = true; 		// we can skip this key as it is a wait or escape 
+					}
+
+
+					// to help with debug
+					this.log.debug('sendKey: key %s: hasJustBooted %s, currKeyIsEscapeOrTvOrWait %s, firstNonSkippableKeyFound %s, keyCanBeSkippedAfterBootup %s', i+1, hasJustBooted, currKeyIsEscapeOrTvOrWait, firstNonSkippableKeyFound, keyCanBeSkippedAfterBootup);
+
+
+					// process any wait command if found
+					// but ignore if keyCanBeSkippedAfterBootup
+					let waitDelay;
+					if (keyName.toLowerCase().startsWith('wait(') && !keyCanBeSkippedAfterBootup) {
+						this.log.debug('sendKey: key %s: reading delay from %s', i+1, keyName);
+						// accepts wait(), wait(n)
 						waitDelay = keyName.toLowerCase().replace('wait(', '').replace(')','');
-						if (waitDelay == ''){ waitDelay = 100; } // default 100ms
-						this.log.debug('sendKey: delay read as %s', waitDelay);
+						if (waitDelay == ''){ waitDelay = defaultWaitDelay; } // default wait
+						if (waitDelay > maxWaitDelay){ waitDelay = maxWaitDelay; } // max wait
+						this.log.debug('sendKey: key %s: delay read as %s', i+1, waitDelay);
 					}
-					// else if not first key and previous key was not wait, and next key is not wait, then set a default delay of 100 ms
-					 else if (i>0 && i<keyArray.length-1 && !(keyArray[i-1] || '').toLowerCase().startsWith('wait(') && !(keyArray[i+1] || '').toLowerCase().startsWith('wait(')) {
-						this.log.debug('sendKey: not first key and neiher previous key %s nor next key %s is wait(). Setting default wait of 100 ms', keyArray[i-1], keyArray[i+1]);
-						waitDelay = 100;
+					// else if not key can be skipped, and not first key and previous key was not wait, and current key is not wait, then set a default delay of defaultWaitDelay ms
+					else if (	!keyCanBeSkippedAfterBootup
+								&& i>0 
+								//&& i<keyArray.length-1 
+								&& !(keyArray[i-1] || '').toLowerCase().startsWith('wait(') && !(keyArray[i] || '').toLowerCase().startsWith('wait(')
+							) {
+						this.log.debug('sendKey: key %s: not keyCanBeSkippedAfterBootup and not first key and neither previous key %s nor current key %s is wait(). Setting default wait of %s ms', i+1, keyArray[i-1], keyArray[i], defaultWaitDelay);
+						defaultWaitDelayActive = true;
+						waitDelay = defaultWaitDelay;
 					} 
+
 		
-					// add a wait if waitDelay is defined
+					// add a wait if a waitDelay is set
+					//this.log('sendKey: key %s: waitDelay', i+1, waitDelay);
 					if (waitDelay) {
-						this.log('sendKey: waiting %s ms', waitDelay);
+						if (!defaultWaitDelayActive) { this.log('sendKey: key %s: waiting %s ms', i+1, waitDelay); } // reduce logging in minimum mode if default wait
 						await waitprom(waitDelay);
-						this.log.debug('sendKey: wait %s done', waitDelay);
+						this.log.debug('sendKey: key %s: wait done', i+1);
 					}
+
 		
-					// send the key if not a wait()
-					if (!keyName.toLowerCase().startsWith('wait(')) {
-						this.log('sendKey: sending key %s to %s %s', keyName, deviceName, deviceId);
+					// send the key
+					if (hasJustBooted && keyCanBeSkippedAfterBootup) {
+						// when a box has just booted, leading Escapes and waits can be skipped until the first non-Escape and non-wait comand
+						this.log('sendKey: key %s: box has just booted, skipping key %s', i+1, keyName);
+					} else if (!keyName.toLowerCase().startsWith('wait(')) {
+						// send the key if not a wait
+						this.log('sendKey: key %s: sending key %s to %s %s', i+1, keyName, deviceName, deviceId);
 						// the web client uses qos:2, so we should as well
 						this.mqttPublishMessage(
 							mqttUsername + '/' + deviceId, 
 							'{"id":"' + makeFormattedId(32) + '","type":"CPE.KeyEvent","source":"' + mqttClientId + '","status":{"w3cKey":"' + keyName + '","eventType":"keyDownUp"}}',
 							{ qos:2, retain:true }
 						);
-						this.log.debug('sendKey: send %s done', keyName);
+						this.log.debug('sendKey: key %s: send %s done', i+1, keyName);
 
 					}
 		
@@ -2790,6 +2770,7 @@ class stbDevice {
 		this.currentPowerState = Characteristic.Active.INACTIVE;
 		this.previousPowerState = Characteristic.Active.INACTIVE;
 		this.currentChannelId = NO_CHANNEL_ID; // string eg SV09038
+		this.lastKeyMacroChannelId = null; // string eg $KeyMacro1
 		this.currentClosedCaptionsState = Characteristic.ClosedCaptions.DISABLED;
 		this.previousClosedCaptionsState = Characteristic.ClosedCaptions.DISABLED;
 		this.currentMediaState = Characteristic.CurrentMediaState.STOP;
@@ -3105,6 +3086,40 @@ class stbDevice {
 		this.televisionService.getCharacteristic(Characteristic.RemoteKey)
 			.on('set', this.setRemoteKey.bind(this));
 
+
+
+			
+		// Custom characteristics
+		// these are visible in Shortcuts with the name "Custom"
+		var hapCharacteristic = {};
+		const BASE_UUID =   "-0000-3C36-E400-3C36E4FF0012"; // a random UUID used only for my plugin's characteristics, based on 3C36E4-EOSSTB-003656123456
+		// 											 export const BASE_UUID = "-0000-1000-8000-0026BB765291"; // Apple HomeKit base UUID
+
+		// add a custom hap characteristic for the current channel id, appears as Custom in shortcuts
+		// var hapCharacteristic = new Characteristic(characteristic.displayName, characteristic.UUID, characteristic.props);
+		hapCharacteristic = new Characteristic("Current Channel Id", "00000001" + BASE_UUID, {
+			format: Characteristic.Formats.STRING,
+			perms: [Characteristic.Perms.PAIRED_READ, Characteristic.Perms.NOTIFY]
+		})
+		hapCharacteristic.value = ''; // add a default empty value 
+		hapCharacteristic.on('get', this.getCurrentChannelId.bind(this));
+		this.televisionService.addCharacteristic(hapCharacteristic); // add the Characteristic to the televisionService
+		// once added, it can be retrieved with
+		//this.televisionService.getCharacteristic('Current Channel Id')
+
+		// add a custom hap characteristic for the current channel name, appears as Custom in shortcuts
+		// var hapCharacteristic = new Characteristic(characteristic.displayName, characteristic.UUID, characteristic.props);
+		hapCharacteristic = new Characteristic("Current Channel Name", "00000002" + BASE_UUID, {
+			format: Characteristic.Formats.STRING,
+			perms: [Characteristic.Perms.PAIRED_READ, Characteristic.Perms.NOTIFY]
+		})
+		hapCharacteristic.value = ''; // add a default empty value 
+		hapCharacteristic.on('get', this.getCurrentChannelName.bind(this));
+		this.televisionService.addCharacteristic(hapCharacteristic); // add the Characteristic to the televisionService
+		// once added, it can be retrieved with
+		//this.televisionService.getCharacteristic('Current Channel Name')
+
+
 		//this.log('DEBUG:  this.televisionService')
 		//this.log(this.televisionService)
 
@@ -3278,19 +3293,20 @@ class stbDevice {
   	//+++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 	// update the device state changed to async
-	//async updateDeviceState(powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, callback) {
-	async updateDeviceState(powerState, mediaState, recordingState, channelId, sourceType, profileDataChanged, statusFault, programMode, statusActive, inputDeviceType, inputSourceType, callback) {
+	//async updateDeviceState(powerState, mediaState, recordingState, channelId, eventId, sourceType, profileDataChanged, callback) {
+	async updateDeviceState(powerState, mediaState, recordingState, channelId, eventId, sourceType, profileDataChanged, statusFault, programMode, statusActive, inputDeviceType, inputSourceType, callback) {
 			try {
 			// runs at the very start, and then every few seconds, so don't log it unless debugging
 			// doesn't get the data direct from the settop box, but rather: gets it from the this.currentPowerState and this.currentChannelId variables
 			// which are received by the mqtt messages, which occurs very often
 			if (this.config.debugLevel > 0) {
-				this.log.warn('%s: updateDeviceState: powerState %s, mediaState %s [%s], recordingState %s [%s], channelId %s, sourceType %s, profileDataChanged %s, statusFault %s [%s], programMode %s [%s], statusActive %s [%s], inputDeviceType %s [%s], inputSourceType %s [%s]', 
+				this.log.warn('%s: updateDeviceState: powerState %s, mediaState %s [%s], recordingState %s [%s], channelId %s, eventId %s, sourceType %s, profileDataChanged %s, statusFault %s [%s], programMode %s [%s], statusActive %s [%s], inputDeviceType %s [%s], inputSourceType %s [%s]', 
 					this.name, 
 					powerState, 
 					mediaState, currentMediaStateName[mediaState], 
 					recordingState, recordingStateName[recordingState], // custom characteristic
 					channelId,
+					eventId,
 					sourceType,
 					profileDataChanged,
 					statusFault, Object.keys(Characteristic.StatusFault)[statusFault + 1], 
@@ -3316,6 +3332,7 @@ class stbDevice {
 			if (mediaState != null) { this.currentMediaState = mediaState; }
 			if (recordingState != null) { this.currentRecordingState = recordingState; }
 			if (channelId != null) { this.currentChannelId = channelId; }
+			if (eventId != null) { this.currentEventId = eventId; }
 			if (sourceType != null) { this.currentSourceType = sourceType; }
 			this.profileDataChanged = profileDataChanged || false;
 			if (statusFault != null) { this.currentStatusFault = statusFault; }
@@ -3323,6 +3340,12 @@ class stbDevice {
 			if (statusActive != null) { this.currentStatusActive = statusActive; }
 			if (inputDeviceType != null) { this.currentInputDeviceType = inputDeviceType; }
 			if (inputSourceType != null) { this.currentInputSourceType = inputSourceType; }
+
+			// force the keyMacro channel if a keyMacro was last selected as the input
+			if (this.lastKeyMacroChannelId) { 
+				this.currentChannelId = this.lastKeyMacroChannelId; 
+			}
+
 			
 			
 			
@@ -3567,6 +3590,7 @@ class stbDevice {
 				}
 
 
+
 				// +++++++++++++++ Input Service characteristics ++++++++++++++
 				/*
 				inputService
@@ -3581,34 +3605,38 @@ class stbDevice {
 				*/
 				// check for change of InputDeviceType state: (a characteristic of Input Source)
 
-				let curInp = this.inputServices.findIndex( InputSource => InputSource.subtype == 'input_' + this.currentChannelId ) + 1;
+				//this.log('looking for input subtype ', 'input_' + this.currentChannelId)
+				let currInputIndex = this.inputServices.findIndex( InputSource => InputSource.subtype == 'input_' + this.currentChannelId );
+				let currinputNumber = currInputIndex + 1;
+				if (currInputIndex < 0) { currInputIndex = null; currinputNumber = null; }
+				//this.log('found input index %s input %s subtype %s', currInputIndex, currInputIndex+1, (this.inputServices[currInputIndex] || {}).subtype)
 				if (this.previousInputDeviceType !== this.currentInputDeviceType) {
 					this.log('%s: Input Device Type changed on input %s %s from %s [%s] to %s [%s]', 
 						this.name,
-						curInp,
+						currinputNumber,
 						this.currentChannelId,
 						this.previousInputDeviceType, Object.keys(Characteristic.InputDeviceType)[this.previousInputDeviceType + 1],
 						this.currentInputDeviceType, Object.keys(Characteristic.InputDeviceType)[this.currentInputDeviceType + 1]
 						);
 				}
 				//this.televisionService.getCharacteristic(Characteristic.InputDeviceType).updateValue(this.currentInputDeviceType);
-				this.inputServices[curInp].getCharacteristic(Characteristic.InputDeviceType).updateValue(this.currentInputDeviceType);
+				if (currInputIndex) { this.inputServices[currInputIndex].getCharacteristic(Characteristic.InputDeviceType).updateValue(this.currentInputDeviceType); }
 				this.previousInputDeviceType = this.currentInputDeviceType;
 
 				// check for change of InputSourceType state: (a characteristic of Input Source)
 				if (this.previousInputSourceType !== this.currentInputSourceType) {
 					this.log('%s: Input Source Type changed on input %s %s from %s [%s] to %s [%s]',
 						this.name,
-						curInp,
+						currinputNumber,
 						this.currentChannelId,
 						this.previousInputSourceType, Object.keys(Characteristic.InputSourceType)[this.previousInputSourceType + 1],
 						this.currentInputSourceType, Object.keys(Characteristic.InputSourceType)[this.currentInputSourceType + 1]);
 				}
 				// [12/11/2022, 12:22:37] [homebridge-eosstb] This plugin generated a warning from the characteristic 'Input Source Type': Characteristic not in required or optional characteristic section for service Television. Adding anyway.. See https://homebridge.io/w/JtMGR for more info.
-				this.inputServices[curInp].getCharacteristic(Characteristic.InputSourceType).updateValue(this.currentInputSourceType); // generates Homebridge warning
+				if (currInputIndex) { this.inputServices[currInputIndex].getCharacteristic(Characteristic.InputSourceType).updateValue(this.currentInputSourceType); } // generates Homebridge warning
 				this.previousInputSourceType = this.currentInputSourceType;
-				//this.log('++++DEBUG: this.inputServices[curInp]')
-				//this.log(this.inputServices[curInp])
+				//this.log('++++DEBUG: this.inputServices[currInputIndex]')
+				//this.log(this.inputServices[currInputIndex])
 
 				// +++++++++++++++ end of Input Service characteristics ++++++++++++++
 
@@ -3680,7 +3708,6 @@ class stbDevice {
 					maxSources = Math.min(configDevice.maxChannels || maxSources, maxSources);
 				}
 			}
-			//this.log("%s: Setting maxSources to %s", this.name, maxSources);
 
 
 			// get a user configured Profile, if it exists, otherwise we will use the default Profile for the channel list
@@ -3845,58 +3872,98 @@ class stbDevice {
 			// clear the array
 			this.channelList = [];
 
-			// limit the amount to load
-			const maxChs = Math.min(subscribedChIds.length, maxSources);
+			// check for any custom keymacros, they consume slots at the end of the channelList
+			this.log.debug("%s: Checking for KeyMacros", this.name);
+			let keyMacros = [];
+			if (this.config.channels) {
+				keyMacros = this.config.channels.filter(channel => {
+					if (channel.channelKeyMacro) { return true; }
+				})
+				this.log.debug("%s: Found keyMacros: %s", this.name, keyMacros.length);
+			}
+
+			// limit the amount to load to all the channels and all the keyMacros
+			// keyMacros will occupy top slots of channel list
+			const maxChs = Math.min(subscribedChIds.length + keyMacros.length, maxSources);
+			const firstKeyMacroSlot = Math.max(maxChs - keyMacros.length,0); // never go below index 0
+			//this.log("%s: Loading %s channels, starting at channel 1", this.name, subscribedChIds.length);
+			this.log("%s: Loading %s key macros, starting at channel %s ", this.name, keyMacros.length, firstKeyMacroSlot+1);
+
+			// show log of what will be loaded, very useful for debugging
 			this.log("%s: Refreshing channels 1 to %s", this.name, maxChs);
 			if (maxChs < maxSources) {
 				this.log("%s: Hiding     channels %s to %s", this.name, maxChs + 1, maxSources);
 			}
 
-
 			// loop and load all channels from the subscribedChIds in the order defined by the array
 			//this.log("Loading all subscribed channels")
-			subscribedChIds.forEach((subscribedChId, i) => {
+			for ( let i = 0; i < maxChs; i++ ) {
+			//subscribedChIds.forEach((subscribedChId, i) => {
 				//this.log("In forEach loop, processing index %s %s", i, subscribedChId)
 
 				// find the channel to load.
 				var channel = {};
 				var customChannel = {};
-				
-				// first look in the config channels list for any user-defined custom channel name
-				if (this.config.channels) {
-					customChannel = this.config.channels.find(channel => channel.id === subscribedChId);
-					if ((customChannel || {}).name) { 
-						customChannel.name = cleanNameForHomeKit(customChannel.name)
-						this.log("%s: Found %s in config channels, setting name to %s", this.name, subscribedChId, customChannel.name);
-					} else {					
-						customChannel = {}; 
+				let k = 0;
+
+				// load a channel if we are in the range of channel numbers not assigned to keymacros
+				if ( i < firstKeyMacroSlot ) {
+					// this slot needs to be occupied by a channel
+
+					// first look in the config channels list for any user-defined custom channel name
+					if (this.config.channels) {
+						customChannel = this.config.channels.find(channel => channel.id === subscribedChIds[i]);
+						if ((customChannel || {}).name) { 
+							customChannel.name = cleanNameForHomeKit(customChannel.name)
+							this.log("%s: Found %s in config channels, setting name to %s", this.name, customChannel.id, customChannel.name);
+						} else {					
+							customChannel = {}; 
+						}
 					}
-				}
 
-				// check if the subscribedChId exists in the master channel list, if not, push it, using the user-defined name if one exists, and channelNumber >10000
-				this.log.debug("%s: Index %s: Finding %s in master channel list", this.name, i, subscribedChId);
-				channel = this.platform.masterChannelList.find(channel => channel.id === subscribedChId); 
-				if (!channel) {
-					const newChName = customChannel.name || "Channel " + subscribedChId; 
-					this.log("%s: Unknown channel %s [%s] discovered. Adding to the master channel list", this.name, subscribedChId, newChName);
-					this.platform.masterChannelList.push({
-						id: subscribedChId, 
-						name: newChName,
-						logicalChannelNumber: 10000 + this.platform.masterChannelList.length, // integer
-						linearProducts: this.platform.entitlements.entitlements[0].id // must be a valid entitlement id
-					});
-					// refresh channel as the not found channel will now be in the masterChannelList
-					channel = this.platform.masterChannelList.find(channel => channel.id === subscribedChId); 
-					channel.configuredName = channel.name; // set a configured name same as name 
+
+					// check if the subscribedChId exists in the master channel list, if not, push it, using the user-defined name if one exists, and channelNumber >10000
+					this.log.debug("%s: Index %s: Finding %s in master channel list", this.name, i, subscribedChIds[i]);
+					channel = this.platform.masterChannelList.find(channel => channel.id === subscribedChIds[i]); 
+					if (!channel) {
+						const newChName = customChannel.name || "Channel " + subscribedChIds[i]; 
+						this.log("%s: Unknown channel %s [%s] discovered. Adding to the master channel list", this.name, subscribedChIds[i], newChName);
+						this.platform.masterChannelList.push({
+							id: subscribedChIds[i], 
+							name: newChName,
+							logicalChannelNumber: 10000 + this.platform.masterChannelList.length, // integer
+							linearProducts: this.platform.entitlements.entitlements[0].id // must be a valid entitlement id
+						});
+						// refresh channel as the not found channel will now be in the masterChannelList
+						channel = this.platform.masterChannelList.find(channel => channel.id === subscribedChIds[i]); 
+						channel.configuredName = channel.name; // set a configured name same as name 
+					} else {
+						// show some useful debug data
+						this.log.debug("%s: Index %s: Found %s %s in master channel list", this.name, i, channel.id, channel.name);
+					}
+					this.log.debug("%s: Index %s: Loading channel %s %s", this.name, i, i+1, channel.name);
+				
 				} else {
-					// show some useful debug data
-					this.log.debug("%s: Index %s: Found %s %s in master channel list", this.name, i, channel.id, channel.name);
+
+					// this slot needs to be occupied by a keyMacro
+					k = i - firstKeyMacroSlot
+					this.log.debug("%s: Index %s: Loading channel %s keyMacro %s %s", this.name, i, i+1, k+1, keyMacros[k].channelName);
+					this.log,debug("%s: Index %s: Load this keyMacro: %s", this.name, i, keyMacros[k]);
+					channel = {
+						"id": '$KeyMacro' + (k+1),
+						"name": keyMacros[k].channelName,
+						"logicalChannelNumber": 20000 + i,
+						"linearProducts": 0,
+						"keyMacro": keyMacros[k].channelKeyMacro,
+					  }
 				}
 
-				// load this channel as an input
-				//this.log("loading input %s of %s", i + 1, maxSources)
+
+				// load this channel/keyMacro as an input
+				//this.log("loading input %s of %s", i + 1, maxChs)
 				//this.log.warn("%s: Index %s: Checking if %s %s can be loaded", this.name, i, channel.id, channel.name);
-				if (i < maxSources) {
+				if (i < maxChs) {
+					this.log.debug("%s: Index %s: Refreshing channel", this.name, i);
 
 					// add the user-defined name if one exists
 					if (customChannel && customChannel.name) { channel.name = customChannel.name; }
@@ -3930,8 +3997,6 @@ class stbDevice {
 						}
 						this.inputServices[i].name = channel.configuredName;
 						this.inputServices[i].subtype = 'input_' + channel.id; // string, input_SV09038 etc
-						//this.inputServices[i].subtype = 'input_' + i+1; // integer, generates input_1 for index 0
-						//this.log.warn("DEBUG: input %s subtype set to %s %s",i+1, channel.id, this.inputServices[i].subtype);
 
 						// Name can only be set for SharedProfile where order can never be changed
 						if (this.profileid == 0) {
@@ -3942,9 +4007,13 @@ class stbDevice {
 							.updateCharacteristic(Characteristic.CurrentVisibilityState, channel.visibilityState)
 							.updateCharacteristic(Characteristic.IsConfigured, Characteristic.IsConfigured.CONFIGURED);
 						//inputService.updateCharacteristic(Characteristic.CurrentVisibilityState, Characteristic.TargetVisibilityState.SHOWN);
+						//this.log.warn('this.inputServices[i]')
+						//this.log.warn(this.inputServices[i])
 					}
 				}
-			});
+
+
+			};
 
 			// after loading all the channels, reset the ActiveIdentifier (uint32) to the right Identifier (uint32), as it may have moved slots
 			// subtype: 'input_SV09038',
@@ -3960,33 +4029,6 @@ class stbDevice {
 				}
 			}
 
-			// load any custom key macros: in work, not for publich consumption yet
-			if (this.config.channels && 1==0) {
-				this.config.channels.forEach((customChannel, i) => {
-				this.log("In forEach loop, processing config channel index %s %s", i, customChannel)
-
-				this.log(customChannel)
-				// first look in the config channels list for any user-defined custom channel name
-				if (customChannel.channelKeyMacro){
-					this.log("%s: Found Key Macro in config channels:", this.name, customChannel.channelKeyMacro, customChannel.channelName)
-					let i = this.inputServices.length
-					this.log("inputService %s is set to", i-1);
-					this.log(this.inputServices[i-1]);
-					this.inputServices[i]
-						.name = customChannel.channelName
-						//.subtype = 'input_KM' + 20000 + i; // string, input_KM20000 + channel offset. KM=KeyMacro
-					this.inputServices[i].updateCharacteristic(Characteristic.Name, customChannel.channelName) // stays unchanged at Input 01 etc
-						.updateCharacteristic(Characteristic.ConfiguredName, customChannel.channelName)
-						.updateCharacteristic(Characteristic.CurrentVisibilityState, Characteristic.CurrentVisibilityState.SHOWN)
-						.updateCharacteristic(Characteristic.IsConfigured, Characteristic.IsConfigured.CONFIGURED);
-					
-					this.log("inputService %s is set to", i);
-					this.log(this.inputServices[i]);
-
-				}
-				})
-			}
-
 
 
 			// save to disk
@@ -4001,7 +4043,7 @@ class stbDevice {
 						var appsToload = this.platform.profiles[this.profileId].recentlyUsedApps;
 						appsToload.forEach( (appId, i) => {
 							this.log("loading app", i, appId);
-							if (i <= maxSources) {
+							if (i <= maxChs) {
 								// get the channel
 								var foundIndex = this.platform.masterChannelList.findIndex(channel => channel.id === appId);
 								//this.log("foundIndex", foundIndex);
@@ -4056,7 +4098,7 @@ class stbDevice {
 
 			}
 
-			this.log("%s: Channel list refreshed with %s channels", this.name, Math.min(maxChs, maxSources));
+			this.log("%s: Channel list refreshed with %s channels (including %s key macros)", this.name, Math.min(maxChs, maxSources), keyMacros.length);
 			return false;
 
 		} catch (err) {
@@ -4361,17 +4403,20 @@ class stbDevice {
 	async setInput(input, callback) {
 		input = input ?? {} // ensure input is never null or undefined
 		if (this.config.debugLevel > 1) { this.log.warn('%s: setInput input %s %s',this.name, input.id, input.name); }
-		callback(null); // for rapid response
-		var currentChannelName = NO_CHANNEL_NAME;
-		const channel = this.platform.masterChannelList.find(channel => channel.id === this.currentChannelId);
-		if (channel) { currentChannelName = channel.name; }
-
-		//this.log.warn("setInput: go to input %s", input)
-		//this.log.warn(channel)
-
-		// robustness: only try to switch channel if an input.id exists
-		if (input.id){
-			this.log('%s: Change channel from %s [%s] to %s [%s]', this.name, this.currentChannelId, currentChannelName, input.id, input.name);
+		callback(); // for rapid response
+		// get current channel, also finds keyMacro channels
+		let channel = this.channelList.find(channel => channel.id === this.currentChannelId);
+		// if not found look in the master channel list
+		if (!channel) { channel = this.platform.masterChannelList.find(channel => channel.id === this.currentChannelId); }
+
+		// robustness: only try to switch channel if an input.id exists. Handle KeyMacros
+		this.log('%s: Change channel from %s [%s] to %s [%s]', this.name, this.currentChannelId, (channel || {}).name || NO_CHANNEL_NAME, input.id, input.name);
+		if (input.id && input.id.startsWith('$KeyMacro')){
+			this.lastKeyMacroChannelId = input.id; // remember last keyMacro id
+			this.platform.sendKey(this.deviceId, this.name, input.keyMacro);
+			
+		} else if (input.id){
+			this.lastKeyMacroChannelId = null; // clear last keyMacro channelId
 			this.platform.switchChannel(this.deviceId, this.name, input.id, input.name);
 		} else {
 			this.log.warn('%s: setInput called with no input.id', this.name);
@@ -4384,18 +4429,13 @@ class stbDevice {
 	async getInputName(inputId, callback) {
 		// fired by the user changing a channel name in Home app accessory setup
 		//if (this.config.debugLevel > 1) { this.log.warn('%s: getInputName inputId %s', this.name, inputId); }
-
-		// need to read from stored cache, currently not implemented, TO-DO
-		var chName = NO_CHANNEL_NAME; // must have a value
-		if (this.channelList[inputId-1]) {
-			chName = this.channelList[inputId-1].configuredName;
-		}
+		const inputName =(this.channelList[inputId-1] || {}).configuredName || ''; // Empty string if not found
 		if (this.config.debugLevel > 1) { 
-			this.log.warn("%s: getInputName for input %s returning '%s'", this.name, inputId, chName);
+			this.log.warn("%s: getInputName for input %s returning '%s'", this.name, inputId, inputName);
 		}
-		callback(null, chName);
+		callback(null, inputName);
 	};
-
+	
 	// set input name (change the TV channel name)
 	async setInputName(inputId, newInputName, callback) {
 		// fired by the user changing a channel name in Home app accessory setup
@@ -4427,10 +4467,39 @@ class stbDevice {
 			//this.log('%s: Renamed channel %s from %s to %s (valid only for HomeKit)', this.name, inputId+1, oldInputName, newInputName);
 			this.log('%s: Renamed channel %s to %s (valid only for HomeKit)', this.name, inputId+1, newInputName);
 		}
-		callback(null);
+		callback();
 	};
 
 
+	// get current channel id (the TV channel identifier, a string)
+	// added in v2.1.0
+	// custom characteristic, returns a string, the event updates the characteristic value automatically
+	async getCurrentChannelId(callback, currentChannelId) {
+		// fired by the user reading the Custom characteristic in Shortcuts
+		// fired when the accessory is first created and HomeKit requests a refresh
+		// fired when the icon is clicked in the Home app and HomeKit requests a refresh
+		// fired when the Home app is opened
+		currentChannelId = this.currentChannelId || '';  // this.currentChannelId is a string eg SV09038. Empty string if not found
+		if (this.config.debugLevel > 1) { this.log.warn("%s: getCurrentChannelId returning '%s'", this.name, currentChannelId); }
+		callback(null, currentChannelId);
+	};
+
+
+	// get current channel name (the TV channel name)
+	// added in v2.1.0
+	// custom characteristic, returns a string, the event updates the characteristic value automatically
+	async getCurrentChannelName(callback, currentChannelName) {
+		// fired by the user reading the Custom characteristic in Shortcuts
+		// fired when the accessory is first created and HomeKit requests a refresh
+		// fired when the icon is clicked in the Home app and HomeKit requests a refresh
+		// fired when the Home app is opened
+		const curChannel = this.platform.masterChannelList.find(channel => channel.id === this.currentChannelId );  // this.currentChannelId is a string eg SV09038
+		// consider setting to Radio if radio is playing
+		currentChannelName = (curChannel || {}).name || ''; // Empty string if not found
+		if (this.config.debugLevel > 1) { this.log.warn("%s: getCurrentChannelName returning '%s'", this.name, currentChannelName); }
+		callback(null, currentChannelName);
+	};
+
 
 	// get input visibility state (of the TV channel in the accessory)
 	async getInputVisibilityState(inputId, callback) {
@@ -4442,7 +4511,7 @@ class stbDevice {
 		// }
 		const visibilityState = this.inputServices[inputId-1].getCharacteristic(Characteristic.CurrentVisibilityState).value;
 		if (this.config.debugLevel > 2) {
-			this.log.warn('%s: getInputVisibilityState for input %s returning %s [%s]', this.name, inputId, visibilityState, Object.keys(Characteristic.CurrentVisibilityState)[visibilityState + 1]);
+			this.log.warn('%s: getInputVisibilityState input %s returning %s [%s]', this.name, inputId, visibilityState, Object.keys(Characteristic.CurrentVisibilityState)[visibilityState + 1]);
 		}
 		callback(null, visibilityState);
 	}
@@ -4460,7 +4529,7 @@ class stbDevice {
 		//not yet active
 		//this.platform.persistConfig(this.deviceId, this.channelList);
 
-		callback(null); // for rapid response
+		callback(); // for rapid response
 	}
 
 
@@ -4481,7 +4550,7 @@ class stbDevice {
 		if(this.currentClosedCaptionsState !== targetClosedCaptionsState){
 			this.log("setClosedCaptions: not yet implemented");
 		}
-		callback(null);
+		callback();
 	}
 
 
@@ -4512,7 +4581,7 @@ class stbDevice {
 		if(this.customPictureMode !== targetPictureMode){
 			this.log("setPictureMode: not yet implemented");
 		}
-		callback(null);
+		callback();
 	}
 
 

package/package.json

@@ -3,11 +3,11 @@
   "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.0.4",
+  "version": "2.1.0",
   "platformname": "eosstb",
   "dependencies": {
-    "axios-cookiejar-support": "^4.0.3",
-    "axios": "^1.2.1",
+    "axios-cookiejar-support": "^4.0.6",
+    "axios": "^1.2.2",
     "debug": "^4.3.4",
     "mqtt": "^4.3.7",
     "qs": "^6.11.0",