README

UPC TV Box (ARRIS DCX960)
RoomWithEosstb EosstbControls RemoteControl

homebridge-eosstb

homebridge-eosstb is a Homebridge plugin allowing you to control your set-top box (typically an ARRIS DCX960) running on the Magenta AT / Telenet BE / UPC CH / Virgin Media GB & IE / Ziggo NL Horizon TV platform with Apple HomeKit using the Home app and the Apple TV Remote in the Control Center.

This plugin displays your set-top box as a Set-Top Box accessory with power, channel and remote-control capabilities on your iOS device (iPhone, iPad, iMac, etc.).

You need a subscription to the online TV service from your local TV provider. The username and password are the same as used in the TV provider's TV app on your iOS device (the app varies by country; in Switzerland it is Sunrise UPC TV).

Supports multiple set-top boxes, should you have more than one.

If you like this plugin, consider making a donation or buying me a coffee!

Readme Applicability

Due to the adding of features and functions, this Readme applies from v1.1.0. For prior versions, please see the eosstb release history on npm.

Works in Your Country (If you are with Magenta / Telenet / Sunrise UPC / Virgin Media / Vodafone / Ziggo)

As UPC operates in multiple countries under multiple brands, this plugin will work in a number of countries that use the Horizon TV platform. The known countries that use the same TV platform with the ARRIS DCX960 set-top box are:

Country	TV Provider	Web App	Box Name	Plugin Status
BE	Telenet	Telenet TV	Telenet TV-Box	Fully Working
CH	Sunrise UPC	Sunrise UPC TV	UPC TV Box*	Fully Working
GB	Virgin Media	Magenta TV	Virgin TV 360 and Virgin TV 360 Mini	Fully Working
IE	Virgin Media	Virgin TV Anywhere	360 Box	Fully Working
NL	Ziggo	Ziggo Go	Mediabox Next	Fully Working
-------	-----------	-------	--------	-------------
AT	Magenta	Magenta TV	Entertain Box 4K	Testers Wanted
CZ	Vodafone CZ	Horizon Go	Vodafone TV	Testers Wanted
DE	Vodafone DE	Horizon Go	GigaTV Cable Box	Testers Wanted
HU	Vodafone Hungary	Horizon Go	??	Testers Wanted
PL	UPC PL	Horizon Go	Horizon decoder	Testers Wanted
RO	Vodafone Romania	Horizon Go	Vodafone TV	Testers Wanted
SK	UPC Broadband Slovakia	Horizon Go	Horizon TV	Testers Wanted

If you subscribe to a TV service from one of these countries, you are lucky, this plugin will work for you.

May also work with other UPC countries, if you know of any, let me know.

Made in Switzerland

This plugin was written and tested on the author's set-top box (ARRIS mediabox model DCX960/KK0L/A816/0000) running on Sunrise UPC TV in Switzerland. It has also been extensively tested on Telenet in Belgium, Virgin Media in Great Britain and Ireland, and Ziggo in the Netherlands.

Why I chose the Name EOSSTB

I tried to find a good common name that works for this plugin for all countries. Each country uses a different marketing name for the box, so I could not use the local name. The EOS system, also known as the Horizon platform, uses an ARRIS DCX960, but even this box comes in different types and with different firmware, so I decided not to use the model name. I stuck with the box identifier that appears in the mqtt messages: EOSSTB.

Disclaimer (The Legal Stuff)

This plugin is not provided by Magenta or Telenet or UPC or Virgin Media or Ziggo any other affiliate of UPC. It is neither endorsed nor supported nor developed by UPC or any affiliates. UPC can change their systems at any time and that might break this plugin. But I hope not.

Requirements

An Apple iPhone or iPad with iOS 14.0 (or later). Developed on iOS 14.1...15.3, earlier versions not tested.
Homebridge v1.4.0 (or later). Developed on Homebridge 1.1.116....1.3.9, earlier versions not tested.
A TV subscription from one of the supported countries and TV providers.
An online account for viewing TV in the web app (often part of your TV package), see the table above.
The ARRIS DCX960 mediabox, provided by your TV provider as part of your TV subscription, called by the system an "EOSSTB" and marketed under different names in different UPC countries.
The ARRIS DCX960 should be set to Standby power consumption = Fast start to ensure it is always online and can respond to switch-on requests from HomeKit.
For GB and IE users: the ARRIS DCX960 must be running the TV 360 software, and not the older TiVo V6 software as found in GB and IE. TiVo V6 is not supported by this plugin, but GB users can upgrade to TV 360 by contacting Virgin Media.

Features

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.
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 Siri supports), allowing you to control switch-on and channel selection in Home Automations, Shorcuts 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.
Synchronised Current Channel: Changing the channel on the set-top box changes the displayed channel in the Home app in real time, and vice-versa.
Synchronised Channel List Order: Changing the order of channels in a profile on your set-top box changes the channel list order in the Home app in real time. No reboot required. Note that the Shared Profile channel list order cannot be changed.
Master Channel List Refreshed Regularly: The master channel list is refreshed at the correct intervals requested by the TV provider, minimising network traffic.
Ignores Not-Subscribed Channels: Only the channels you subscribe to are shown in the Home app, saving you valuable slots in the limited Home app channel list.
Optional Channel Numbers: If you wish, you can display a channel number before the channel name. As this consumes some space on the Home app tile, it is off by default.
Intelligent Profile Support: If the master channel list is too large for the Home app, then the plugin will choose the best fitting profile, should you have any user profiles stored on your set-top box. The best fitting user profile is the first user profile found that fits fully within the available channel list space. Of course, you can specify your own profile which overrides this intelligent selection.
Intelligent Mute: Clicking Volume Down on your iOS device three times in rapid succession sends a Mute command to your TV. A subsequent press of Volume Up or Volume Down cancels the mute (TV dependent). The triple-press timing is configurable.
Robust Session Handler: If the web session or mqtt sessions are lost, the plugin will automatically try to reconnect.
Informative Log Entries: The plugin logs show lots of information about your session and the state of the set-top box. Log levels are configurable with debugLevel.
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 14.x). Hopefully, Apple will add support for these features in the future. You can however use this data in the Shortcuts app.

Installation

Homebridge UI: the easiest way to install is to search for eosstb in the Homebridge UI, and then click INSTALL.

Manual install:

sudo npm install -g homebridge-eosstb

After installing, make sure you restart Homebridge.

Adding the Set-Top Box to the Home App

The set-top box accessory is exposed as a separate external accessory and each set-top box needs to be manually paired as follows:

Open the Home app on your device.
Tap + in the top right corner of the screen and then Add Accessory to start the process of adding a new accessory.
Add Accessory: tap More options... to add the accessory manually.
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.
Accept the Uncertified Accessory warning by tapping Add Anyway.
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.
Set-Top Box Location: Select a room for your new accessory and tap Continue.
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.
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.
Set-Top Box Automations: Switch on any suggested automations if you wish (you can change these in the Home app later) and tap Continue.
Set-Top Box Added to <HomeName>: Tap Done to finish the setup.

Your new accessory will appear shortly in the room that you selected. It may show **Updating...** for a few minutes as it loads all the data.

You can force a Home app refresh by switching to another room and then back again.

Remote Control Supported Keys

To access the Apple TV Remote, open your Control Center by swiping down from the top (newer iPhones and iPads) or up from the bottom of the screen (older iPhones). If you do not see the remote-control icon, you will need to activate it in Settings > Control Centre and ensure that the Apple TV Remote is in the list of INCLUDED CONTROLS. Make sure you select the correct device from the drop-down list at the top of the Apple TV Remote:

The following keys are supported by in the Apple TV Remote in the Control Center:

Key	Single Tap	Double Tap
Up	ArrowUp	ChannelUp
Down	ArrowDown	ChannelDown
Left	ArrowLeft	MediaRewind
Right	ArrowRight	MediaFastForward
Select	Enter	Enter
PlayPause	MediaPlayPause	MediaPlayPause
Back	Escape	Escape
Info	MediaTopMenu	Guide
Volume Up	volUpCommand	-
Volume Down	volDownCommand	3 clicks = mute

The table shows the default key mappings. You can map any Apple TV Remote button to any EOSSTB remote control button, see the Wiki for all of the known KeyEvents.

The volume controls do not control the set-top box directly, as the set-top box has no volume capability. The set-top box physical remote actually sends IR commands to your TV. If you can control your TV volume via a network connection then the volume controls can be used to send volume commands to your TV via the raspberry pi. This is what the author uses.

Limitations

Channel Count

Due to HomeKit limitations, the maximum services for a single accessory are 100. Over this value the Home app will no longer respond. Services used in this set-top box accessory are:

Information service (Name, model, serial number of the accessory)
Television service (for controlling the TV accessory)
Speaker service (for the controlling the TV accessory volume)
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 14.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 a eosstb config option customPictureMode allows you to use the PictureMode to read the recording state in Shortcuts or Automations.

Closed Captions Limitations

The eosstb plugin can detect the closed captions state (Subtitle options in the set-top box menu) and shows ENABLED or DISABLED in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the closed captions state (as at iOS 14.4) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.

Configuration

Note that the config changed from 0.1.13 to 1.0.0. If you are updating, please make sure your config matches the examples shown here.

Add a new platform to the platforms section of your homebridge config.json.

Example minimum (mandatory) configuration:

    "platforms": [
        {
            "country": "ch",
            "username": "yourTvProviderUsername",
            "password": "yourTvProviderPassword",
            "platform": "eosstb"
        }
    ]

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:

    "platforms": [
        {
            "platform": "eosstb",
            "name": "EOS",
            "country": "ch",
            "username": "yourTvProviderUsername",
            "password": "yourTvProviderPassword",
            "triplePressTime": 800,
            "debugLevel": 0,
            "devices": [
                {
                    "deviceId": "3C36E4-EOSSTB-00365657xxxx",
                    "name": "Sunrise UPC TV",
                    "syncName": true,
                    "profile": "Dad",
                    "accessoryCategory": "settopbox",
                    "playPauseButton": "MediaPlayPause",
                    "backButton": "Escape",
                    "infoButton": "MediaTopMenu",
                    "volUpCommand": "samsungctl --host x.x.x.x --name HomeKit --timeout 0.2 KEY_VOLUP",
                    "volDownCommand": "samsungctl --host x.x.x.x --name HomeKit --timeout 0.2 KEY_VOLDOWN",
                    "muteCommand": "samsungctl --host x.x.x.x --name HomeKit --timeout 0.2 KEY_MUTE",
                    "manufacturer": "ARRIS",
                    "modelName": "DCX960",
                    "serialNumber": "123456",
                    "firmwareRevision": "4.31",
                    "showChannelNumbers": false,
                    "maxChannels": 50
                },
            "channels": [
                {
                    "channelId": "SV09690",
                    "channelName": "Netflix"
                }
            ]
        }
    ]

Platform Config Items

Unless otherwise stated, all config items are case sensitive.

Mandatory

Mandatory config items must always exist. These are used to establish the session to the EOS / Horizon platform. If any mandatory config items are missing, a warning is shown and initialization is aborted.

platform: the name of the platform. Mandatory, must be eosstb.

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.
password: Your password associated with your TV account. Mandatory.

Optional

name: The platform name that appears in the Homebridge logs. In many countries the platform is called Horizon, but you can name it to anything. Optional, defaults to "EOSSTB".
triplePressTime: The amount of time in ms to detect triple-press of a button. Used for triple-press features, such as triple-press of Volume Down generates Mute. Optional, defaults to 800ms.
debugLevel: Controls the amount of debug data shown in the Homebridge logs, independent of the debug setting in Homebridge. Extra debug messages above level 0 are shown in the Homebridge log in the warning colour, normally yellow. Supported values are: 0=No debug logging, 1=Minimum, 2=Enhanced, 3=Verbose. Optional. Defaults to 0 if not found. Warning: a lot of log entries can occur at the higher debug levels.

Device Config Items

Most people will be happy with the default device config. If you do not need to change anything, you can omit the device config section. If you want to configure your devices differently, do so here. Multiple devices are supported, each device can be configured separately. The devices are identified by their physical deviceId. You will see that there is no option to set the name in the config, as the name of the set-top box displayed in the Home app is always synchronised to the physical set-top box. You can change the set-top box name in the Home app.

Mandatory

deviceId: The unique set-top box physical device id, in Switzerland, Belgium and the Netherlands this is in the format 3C36E4-EOSSTB-001234567890. Other countries may be the same. Required to identify the set-top box in your network, as multiple boxes can exist. Review the Homebridge log to see your deviceId, it is displayed shortly after a Homebridge restart. Mandatory for a device configuration.

Optional

Name and Icon

name: The device name. Set to anything you want. If syncName is true, the name will also be synced to the set-top box. Note that the set-top box name must be between 3 and 14 characters long; shorter names are expanded, longer names are truncated. Optional, defaults to the current set-top box name.
syncName: You can choose to sync the HomeKit name with the physical set-top box name. If you set syncName to false, you can name the set-top box in HomeKit differently to the physical set-top box. Optional, defaults to true.
accessoryCategory: The accessory category. This changes the image on the tile in the Home app. Allows you to use a TV or an Audio Receiver or a Set-Top Box (default). Available values are: Set-Top-Box = any of "settopbox", "stb". TV = any of "television", "tv". Audio Receiver = any of "receiver", "audio-receiver", "avr". Not case sensitive. Optional, defaults to Set-Top Box if the value is not recognised.

Accessory information

manufacturer: You can add a manufacturer name if you wish. Defaults to the detected device and platform type, otherwise to the eosstb platform name. Optional.
serialNumber: You can add a serial number if you wish. Defaults to the set-top box serial number id, otherwise to the physical deviceId. Optional.
modelName: You can add a model name if you wish. Defaults to the detected device model and device type, otherwise to the eosstb plugin name. Optional.
firmwareRevision: You can add a firmware revision if you wish. Must be numeric (non-numeric values are not displayed in the Home app). Defaults to the eosstb plugin version. Optional.

Channel Display

profile: The profile name to use to load the channel list for the device. Optional, defaults to the Shared Profile. If using the Shared Profile, the device loads the first 95 channels found. Most TV providers offer many more than 95 channels: my provider has 483, of which I am entitled to 287. To ensure you have a useful channel list on your Home app, create a profile on your set-top box, and enter the profile name in the config. The channels will then be loaded from the profile. If your profile is changed to the set-top box, the changes will be pushed to HomeKit.
showChannelNumbers: Shows or hides the channel numbers in the channel selector in HomeKit. Values: true or false (default). If channel numbers are displayed, there is less room for the channel name. Optional, defaults to false.
maxChannels: The maximum number of channels to load. Optional, defaults to 95. Note: re-pairing the accessory in the Home app might be needed after changing maxChannels.

Remote Control Button Mapping

playPauseButton: The command issued to the set-top box when the Play/Pause button (> ||) in the iOS remote is tapped. Normally MediaPause. Optional, defaults to MediaPause if not found.
backButton: The command issued to the set-top box when the BACK button in the iOS remote is tapped. Normally Escape. Optional, defaults to Escape if not found.
infoButton: The command issued to the set-top box when the Info button (i) in the iOS remote is tapped. As the iOS remote has no Menu button, the Info button should be used to access the menu. This is why the Info button is set to MediaTopMenu. Optional, defaults to MediaTopMenu if not found.

Remote Control Volume Commands

volUpCommand: The bash command to increase the volume of the TV. This command is sent when the iOS remote is open and you press the Volume Up button on your device. Optional.
volDownCommand: The bash command to decrease the volume of the TV. This command is sent when the iOS remote is open and you press the Volume Down button on your device. Optional.
muteCommand: The bash command to mute the TV. Whilst not supported natively in the Apple iOS remote, I have integrated it with a triple-press on the Volume Down button. Mute is also supported in Homebridge. Optional.

Extra Functions

customPictureMode: Allows the customisation of Picture Mode. Optional, defaults to normal Picture Mode if not found. Possible values are: recordingState: The Picture Mode reflects the recording state of the set-top box. Values are: 0 = Idle (not recording), 1 = Ongoing nDVR (network digital video recording), 2 = Ongoing localDVR (local hard-drive based digital video recording). It can be useful to know if the set-top box is currently recording to the hard drive for users want to control the power to the set-top box, so that they do not switch it off when a local recording is in progress.

Channel Config Items

Some channels such as Netflix are actually apps on the set-top box, and not normal linear TV channels. They appear in the channel list on the TV, and can be added to favourites from the TV menu (but not from the web app menu). However, they are not broadcast as a normal linear TV channel in the master channel list. Therefore, the name cannot be determined from the profile favourite channel list, and the name appears as "Channel xxxxxx" where xxxxxx is the channelId. To overcome this, add the channelId and the channelName to the channels section in the config as per the examples below.

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.
Telenet BE:

    "channels": [
        {
            "channelId": "netflix",
            "channelName": "Netflix"
        }
    ]

Virgin Media GB:

   "channels": [
       {
           "channelId": "1755",
           "channelName": "Netflix"
       },
       {
           "channelId": "2054",
           "channelName": "Prime Video"
       }
   ]

UPC CH:

    "channels": [
        {
            "channelId": "SVO9690",
            "channelName": "Netflix"
        }
    ]

Ziggo NL:

    "channels": [
        {
            "channelId": "NL_000073_019506",
            "channelName": "Netflix"
        }
    ]

Set-Top Box KeyEvent Commands

See the Wiki for a collection of known key event commands that control the set-top box.

Special Commands

The volume and mute commands do not control the set-top box directly, but can be used to control the TV or Receiver volume (network remote control required).

Volume

VolumeUp and VolumeDown: When the iOS remote is displayed, the iOS device volume controls can be used to control the volume of your TV. However, this is not done via the set-top box, but instead via a command using a command line interface (CLI) to your TV. Your TV must be capable of being controlled remotely via any machine that can accept a bash command, such as a raspberry pi. The author has a Samsung Home Theater HT-D5500 and runs Homebridge on a raspberry pi, and thus uses samsungctl which allows KEY_VOLUP, KEY_VOLDOWN and KEY_MUTE to be easily sent to the Samsung Home Theater. If you already have volume buttons in Homebridge for your TV, you can control Homebridge via the command line. See the examples in issue 506 in the Homebridge issues log and scroll to the bottom to see some working command lines. Once you know what bash command works, configure it in volUpCommand and volDownCommand.

Mute

Mute is not supported natively by the iOS remote, but I have added it with a triple-press detection on the volume down button. Press the button three times within 800ms, and the Mute command will be sent using the command stored in the muteCommand config item.

View TV Settings

You can use View TV Settings to open the set-top box main menu at the PROFILES menu. Usage: in the Home app, tap-and-wait on the set-top box tile to open the channel changer, then tap on the cogwheel to open the settings for the accessory, and scroll down to View TV Settings.

Siri

See the Wiki for details on how to control the set-top box with Siri.

Shortcuts

See the Wiki for details on how to read and control the set-top box in the Shortcuts app.

Thanks to

homebridge-yamaha-avr
https://openbase.io/js/homebridge-denon-tv/documentation
NextRemoteJs
ziggonext-python by Rudolf Offereins Rudolf is the best!
My helpers in Belgium: Wesley Liekens and Anthony Dekimpe for helping me get the session code working for Telenet
My helpers in Great Britain and Ireland (you know who you are) for helping me get the session code working for Virgin Media
Liberty Global for making such a useful Horizon TV platform and lovely set-top boxes

Usage no npm install needed!

README

homebridge-eosstb

Readme Applicability

Works in Your Country (If you are with Magenta / Telenet / Sunrise UPC / Virgin Media / Vodafone / Ziggo)

Made in Switzerland

Why I chose the Name EOSSTB

Disclaimer (The Legal Stuff)

Requirements

Features

Installation

Adding the Set-Top Box to the Home App

Remote Control Supported Keys

Limitations

Channel Count

Web App Controllers Take Over Sometimes

Media State (Play/Pause) Limitations

Recording State Limitations

Closed Captions Limitations

Configuration

Platform Config Items

Mandatory

Optional

Device Config Items

Mandatory

Optional

Name and Icon

Accessory information

Channel Display

Remote Control Button Mapping

Remote Control Volume Commands

Extra Functions

Channel Config Items

Set-Top Box KeyEvent Commands

Special Commands

Volume

Mute

View TV Settings

Siri

Shortcuts

Thanks to