Package Health Score

65 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version			Vulnerabilities	License Risk
3.1.19	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.1.17	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.4	\|	08/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.14.3	\|	08/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.8.15	\|	12/2021	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (119)

GitHub Stars: 166
Forks: 15
Contributors: 20

Direct Usage Popularity

The npm package homebridge-xbox-tv receives a total of 119 downloads a week. As such, we scored homebridge-xbox-tv popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package homebridge-xbox-tv, we found that it has been starred 166 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: Yes

With more than 10 contributors for the homebridge-xbox-tv repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like homebridge-xbox-tv is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 4
Open PR: 1
Last Release: 8 days ago
Last Commit: 1 month ago

Further analysis of the maintenance status of homebridge-xbox-tv based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that homebridge-xbox-tv demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: ^18.20.4 || ^20.15.1 || ^22.7.0

Age: 5 years
Dependencies: 9 Direct
Versions: 5.83K
Install Size: 683 kB
Dist-tags: 2
# of Files: 33
Maintainers: 1
TS Typings: No

homebridge-xbox-tv has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

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
Config UI X	Config UI X Wiki	Homebridge Web User Interface	Recommended
Xbox TV	Plug-In Wiki	Homebridge Plug-In	Required

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 Config UI X 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.
`getInputsFromDevice`	If enabled, apps will be loaded from device, only available if `webApiControl` enabled.
`filterGames`	If enabled, Games will be hidden and not displayed in the inputs list, only available if `webApiControl` enabled.
`filterApps`	If enabled, Apps will be hidden and not displayed in the inputs list, only available if `webApiControl` enabled.
`filterSystemApps`	If enabled, System Apps (Accessory, Microsoft Store, Television) will be hidden and not displayed in the inputs list, only available if `webApiControl` enabled.
`filterDlc`	If enabled, Dlc will be hidden and not displayed in the inputs list, only available if `webApiControl` enabled.
`inputsDisplayOrder`	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.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.reference`	Required to identify current running app.
`inputs.oneStoreProductId`	Required to switch apps.
`inputs.contentType`	Here select from available content types.
`buttons.name`	Here set Button Name which You want expose to the Homebridge/HomeKit.
`buttons.command`	Here select button control mode or command, `Reboot` and `Switch App/Game`- only possible if `webApiControl` enabled.
`buttons.oneStoreProductId`	Here set Input oneStoreProductId, only possible if `webApiControl` enabled.
`buttons.displayType`	Here select display type in HomeKit app, possible `0 - None/Disabled`, `1 - Outlet`, `2 - Switch`.
`buttons.namePrefix`	Here enable/disable the accessory name as a prefix for button name.
`sensorPower`	If enabled, then the Power will be exposed as a `Contact Sensor`, fired if power ON.
`sensorInput`	If enabled, then the Input will be exposed as a `Contact Sensor`, fired on every Input change.
`sensorScreenSaver`	If enabled, then the Screen Saver will be exposed as a `Motion Sensor`, fired on change to Screen Saver.
`sensorInputs`	Her create custom Inputs sensor, sensors will be exposed as a `Contact Sensor`, fired if switch to it.
`sensorInputs.name`	Here set own Name which You want expose to the Homebridge/HomeKit for this sensor.
`sensorInputs.reference`	Here set Reference like `Xbox.Dashboard_8wekyb3d8bbwe!Xbox.Dashboard.Application` to be exposed as sensor (active on switch to this Input).
`sensorInputs.displayType`	Here select sensor type to be exposed in HomeKit app, possible `0 - None/Disabled`, `1 - Motion Sensor`, `2 - Occupancy Sensor`, `3 - Contact Sensor`.
`sensorInputs.namePrefix`	Here enable/disable the accessory name as a prefix for sensor name.
`webApiControl`	This enable console control over Web Api. Additional functions are available in `Advanced Settings` section.
`webApiPowerOnOff`	This enable `Power` control over Web Api.
`webApiToken`	Required if `webApiControl` enabled, use Authorization Manager to get it.
`webApiClientId`	Here set your own Client Id from Azure AD or leave empty if you do not have own account.
`webApiClientSecret`	Here set your Client Secret from Azure AD or leave empty if you do not have own account.
`volumeControlNamePrefix`	Here enable/disable the accessory name as a prefix for volume control name.
`volumeControlName`	Here set Your own volume control name or leave empty.
`volumeControl`	Here choice what a additional volume control mode You want to use (`0 - None/Disabled`, `1 - Lightbulb`, `2 - Fan`), not working yet.
`infoButtonCommand`	Here select the function of `I` button in RC app.
`enableDebugMode`	If enabled, deep log will be present in homebridge console.
`disableLogInfo`	If enabled, disable log info, all values and state will not be displayed in Homebridge log console.
`disableLogDeviceInfo`	If enabled, add ability to disable log device info by every connections device to the network.
`restFul`	This is RSTful server.
`enable`	If enabled, RESTful server will start automatically and respond to any path request.
`port`	Here set the listening `Port` for RESTful server.
`debug`	If enabled, deep log will be present in homebridge console for RESTFul server.
`mqtt`	This is MQTT Broker.
`enable`	If enabled, MQTT Broker will start automatically and publish all awailable PV data.
`host`	Here set the `IP Address` or `Hostname` for MQTT Broker.
`port`	Here set the `Port` for MQTT Broker, default 1883.
`clientId`	Here optional set the `Client Id` of MQTT Broker.
`prefix`	Here set the `Prefix` for `Topic` or leave empty.
`auth`	If enabled, MQTT Broker will use authorization credentials.
`user`	Here set the MQTT Broker user.
`passwd`	Here set the MQTT Broker password.
`debug`	If enabled, deep log will be present in homebridge console for MQTT.
`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 **
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}

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.

homebridge-xbox-tv dependencies

@homebridge/plugin-ui-utils async-mqtt elliptic hex-to-binary jsrsasign uuid ping express axios

FAQs

What is homebridge-xbox-tv?

Homebridge plugin to control Xbox game consoles. Visit Snyk Advisor to see a full health score report for homebridge-xbox-tv, including popularity, security, maintenance & community analysis.

Is homebridge-xbox-tv popular?

The npm package homebridge-xbox-tv receives a total of 119 weekly downloads. As such, homebridge-xbox-tv popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is homebridge-xbox-tv well maintained?

We found indications that homebridge-xbox-tv maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is homebridge-xbox-tv safe to use?

While scanning the latest version of homebridge-xbox-tv, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 3 November-2024, at 03:15 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

homebridge-xbox-tv

Homebridge plugin to control Xbox game consoles. For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (119)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

Homebridge Xbox TV

Package Requirements

About The Plugin

Authorization Manager

Configuration

Create App on Azure AD

RESTFul Integration

MQTT Integration

homebridge-xbox-tv dependencies

FAQs

What is homebridge-xbox-tv?

Is homebridge-xbox-tv popular?

Is homebridge-xbox-tv well maintained?

Is homebridge-xbox-tv safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (119)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Homebridge Xbox TV

Package Requirements

About The Plugin

Authorization Manager

Configuration

Create App on Azure AD

RESTFul Integration

MQTT Integration

homebridge-xbox-tv dependencies

FAQs

What is homebridge-xbox-tv?

Is homebridge-xbox-tv popular?

Is homebridge-xbox-tv well maintained?

Is homebridge-xbox-tv safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues