Homebridge Xbox TV

Homebridge plugin for Microsoft game Consoles. Tested with Xbox One X/S and Xbox Series X.

Package Requirements

| Package | Installation | Role | Required | | --- | --- | --- | --- | | Homebridge | Homebridge Wiki | HomeKit Bridge | Required | | Homebridge UI | Homebridge UI Wiki | Homebridge Web User Interface | Required | | Xbox TV | Plug-In Wiki | Homebridge Plug-In | Required |

Warning

• For plugin < v4.1.0 use Homebridge UI <= v5.5.0.
• For plugin >= v4.1.0 use Homebridge UI >= v5.13.0.

About The Plugin

• Power ON/OFF short press tile in HomeKit app.
• Reboot Console with button, rquired webApiControl enabled.
• Record Game DVR with button, rquired webApiControl enabled.
• RC/Media/Volume control from RC app on iPhone/iPad and possible over web/local api.
• Speaker control from RC app on iPhone/iPad Speaker Service.
• Legacy Volume/Mute control is possible throught extra lightbulb/fan (slider).
• Apps, Inputs, Games can be switched if webApiControl is enabled and console is authorized.
• Siri can be used for all functions, some times need to be created legacy buttons/switches/sensors.
• Automations can be used for all functions, some times need to be created legacy buttons/switches/sensors.
• Support external integrations, RESTFul, MQTT.

Authorization Manager

• First of all please use built in Authorization Manager.
  • Start new authorization need remove old token first, to clear token use Authorization Manager GUI.
  • Make sure Your web browser do not block pop-up window, if Yes allow pop-up window for this app.

Configuration

• Device must have Instant-on power mode enabled
  • Profile & System > Settings > General > Power mode & startup
  • Console need to allow connect from any 3rd app. Allow Connections from any device should be enabled.
  • Profile & System > Settings > Devices & Connections > Remote features > Xbox app preferences.
• Run this plugin as a Child Bridge (Highly Recommended), this prevent crash Homebridge if plugin crashes.
• Install and use Homebridge UI to configure this plugin.
• The sample-config.json can be edited and used as an alternative (advanced users).

| Key | Description | | --- | --- | | name | Here set the accessory Name to be displayed in Homebridge/HomeKit. | | host | Here set the Hsostname or Address IP of Console.| | xboxLiveId | On your console select Profile > Settings > System > Console info, listed as Xbox network device ID. You can only find the Xbox network device ID in Settings on your console, this is different from your console serial number. | | displayType | Accessory type to be displayed in Home app: 0 - None/Disabled, 1 - Television , 2 - TV Set Top Box, 3 - TV Streaming Stick, 4 - Audio Receiver. | | webApi{} | Web Api object. | | webApi.enable | This enable console control over Web Api. Additional functions are available in Advanced Settings section. | | webApi.token | Required if webApiControl enabled, use Authorization Manager to get it. | | webApi.clientId | Here set your own Client Id from Azure AD or leave empty if you do not have own account. | | webApi.clientSecret | Here set your Client Secret from Azure AD or leave empty if you do not have own account. | | inputs{} | Inputs object. | | inputs.getFromDevice| If enabled, apps will be loaded from device, only available if webApiControl enabled. | | inputs.filterGames | If enabled, Games will be hidden and not displayed in the inputs list, only available if webApiControl enabled. | | inputs.filterApps | If enabled, Apps will be hidden and not displayed in the inputs list, only available if webApiControl enabled. | | inputs.filterSystemApps | If enabled, System Apps (Accessory, Microsoft Store, Television) will be hidden and not displayed in the inputs list, only available if webApiControl enabled. | | inputs.filterDlc | If enabled, Dlc will be hidden and not displayed in the inputs list, only available if webApiControl enabled. | | inputs.displayOrder | Here select display order of the inputs list, 0 -None, 1 -Ascending by Name, 2 - Descending by Name, 3 - Ascending by Reference, 4 - Ascending by Reference. | | inputs.data[] | Inputs data array. | | inputs.data[].name | Here set Input Name which You want expose to the Homebridge/HomeKit, Screensaver, Television, TV Settings, Dashboard, Accessory, Settings, Network Troubleshooter, Microsoft Store, Xbox Guide are created by default. | | inputs.data[].reference | Required to identify current running app. | | inputs.data[].oneStoreProductId | Required to switch apps. | | inputs.data[].contentType | Here select from available content types. | | buttons[] | Buttons array. | | buttons[].displayType | Here select display type in HomeKit app, possible 0 - None/Disabled, 1 - Outlet, 2 - Switch. | | buttons[].name | Here set Button Name which You want expose to the Homebridge/HomeKit. | | buttons[].mode | Here select button mode, 0 - Media Control, 1 - Game Pad Control, 2 - TV Remote Control, 3 - Console Control, 4 - Game/App Control. | | buttons[].mediaCommand | Here select media control command. | | buttons[].gamePadCommand | Here select game pad control command. | | buttons[].tvRemoteCommand | Here select tv remote control command. | | buttons[].consoleControlCommand | Here select console control command. | | buttons[].gameAppControlCommand | Here set oneStoreProductId, only possible if webApiControl enabled. | | buttons[].namePrefix | Here enable/disable the accessory name as a prefix for button name.| | sensors[] | Sensors array. | | sensors[].displayType | Here choose the sensor type to be exposed in HomeKit app, possible 0 - None/Disabled, 1 - Motion Sensor, 2 - Occupancy Sensor, 3 - Contact Sensor. | | sensors[].mode | Here choose the sensor mode, possible 0 - App / Games, 1 - Power, 2 - Volume, 3 - Mute, 4 - Screen Saver, 5 - Play State. | | sensors[].name | Here set own sensor Name which You want expose to the Homebridge/HomeKit. | | sensors[].reference | Here set mode Reference like Xbox.Dashboard_8wekyb3d8bbwe!Xbox.Dashboard.Application, sensor fired on switch to this reference. | | sensors[].pulse | Here enable sensor pulse, sensor send pulse and fired on every value change of selected mode. | | sensors[].namePrefix | Here enable the accessory name as a prefix for sensor name. | | sensors[].level | Here set Level between 0-100, sensor fired on this level. | | volume{} | Volume object. | | volume.displayType | Here choice what a additional volume control mode You want to use 0 - None/Disabled, 1 - Lightbulb, 2 - Fan, 3 - TV Speaker (only hardware buttons on R.C. app), 4 - TV Speaker / Lightbulb, 5 - TV Speaker / Fan. | | volume.name | Here set Your own volume control name or leave empty. | | volume.namePrefix | Here enable/disable the accessory name as a prefix for volume control name. | | infoButtonCommand | Here select the function of I button in RC app. | | log{} | Log object. | | log.deviceInfo | If enabled, log device info will be displayed by every connections device to the network. | | log.sSuccess | If enabled, success log will be displayed in console. | | log.info | If enabled, info log will be displayed in console. | | log.warn | If enabled, warn log will be displayed in console. | | log.error | If enabled, error log will be displayed in console. | | log.debug | If enabled, debug log will be displayed in console. | | restFul{} | RESTFul object. | | restFul.enable | If enabled, RESTful server will start automatically and respond to any path request. | | restFul.port | Here set the listening Port for RESTful server. | | mqtt{} | MQTT object. | | mqtt.enable | If enabled, MQTT Broker will start automatically and publish all awailable PV data. | | mqtt.host | Here set the IP Address or Hostname for MQTT Broker. | | mqtt.port | Here set the Port for MQTT Broker, default 1883. | | mqtt.clientId | Here optional set the Client Id of MQTT Broker. | | mqtt.prefix | Here set the Prefix for Topic or leave empty. | | mqtt.auth{} | MQTT authorization object. | | mqtt.auth.enable | Here enable authorization for MQTT Broker. | | mqtt.auth.user | Here set the MQTT Broker user. | | mqtt.auth.passwd | Here set the MQTT Broker password. | | reference, oneStoreProductId | If web Api enabled then all available in ./homebridge/xboxTv/inputs_xxxxxx file. |

Create App on Azure AD

• Go to Azure Portal
• Register new App + New registration
  • Enter a name for your app
  • Set Supported account types to Personal Microsoft accounts only
  • Click register
  • Choose Redirect URIs -> Add a Redirect URI
  • Click Add a platform -> Mobile and desktop applications
  • Enter custom redirect URI http://localhost:8888/auth/callback
• From the overview of your app page, copy Application (client) ID to webApiClientId
• Save restart plugin and authorize console again and have fun.

RESTFul Integration

• POST data as a JSON Object {Power: true}, content type must be application/json
• Path status response all available paths.

| Method | URL | Path | Response | Type | | --- | --- | --- | --- | --- | | GET | http//ip:port | info, state, consoleslist, profile, apps, storages, status. | {"power": true, "app": Xbox.Dashboard_8wekyb3d8bbwe!Xbox.Dashboard.Application} | JSON object. |

| Method | URL | Key | Value | Type | Description | | --- | --- | --- | --- | --- | --- | | POST | http//ip:port | Power | true, false | boolean | Power state. | | | http//ip:port | App | Xbox.Dashboard_8wekyb3d8bbwe!Xbox.Dashboard.Application | string | Set app. | | | http//ip:port | RcControl | fastForward | string | Send RC command. | | | http//ip:port | Volume | up, down | string | Set volume. | | | http//ip:port | Mute | true, false | boolean | Set mute. |

MQTT Integration

• Subscribe data as a JSON Object {App: "Xbox.Dashboard_8wekyb3d8bbwe!Xbox.Dashboard.Application"}

| Method | Topic | Message | Type | | --- | --- | --- | --- | | Publish | Info, State, Consoles List, Profile, Apps, Storages, Status | {"power": true, "app": Xbox.Dashboard_8wekyb3d8bbwe!Xbox.Dashboard.Application} | JSON object. |

| Method | Topic | Key | Value | Type | Description | | --- | --- | --- | --- | --- | --- | | Subscribe | Set | Power | true, false | boolean | Power state. | | | Set | App | Xbox.Dashboard_8wekyb3d8bbwe!Xbox.Dashboard.Application | string | Set app. | | | Set | RcControl | fastForward | string | Send RC command. | | | Set | Volume | up, down | string | Set volume. | | | Set | Mute | true, false | boolean | Set mute. |