Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/funkeyflo/ps5-mqtt
Integrate your PlayStation 5 with Home Assistant
https://github.com/funkeyflo/ps5-mqtt
home-assistant home-automation homeassistant mqtt playstation playstation-5 ps5
Last synced: about 12 hours ago
JSON representation
Integrate your PlayStation 5 with Home Assistant
- Host: GitHub
- URL: https://github.com/funkeyflo/ps5-mqtt
- Owner: FunkeyFlo
- License: mit
- Created: 2022-06-27T20:51:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T23:50:12.000Z (6 days ago)
- Last Synced: 2024-12-22T02:04:07.647Z (about 12 hours ago)
- Topics: home-assistant, home-automation, homeassistant, mqtt, playstation, playstation-5, ps5
- Language: TypeScript
- Homepage:
- Size: 1.61 MB
- Stars: 371
- Watchers: 10
- Forks: 34
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
PS5 MQTT
Integrate your Sony Playstation 5 devices with Home Assistant using MQTT.
![Supports aarch64 Architecture][aarch64-shield]
![Supports amd64 Architecture][amd64-shield]
![Supports armhf Architecture][armhf-shield]
![Supports armv7 Architecture][armv7-shield]
![Supports i386 Architecture][i386-shield]
[][discord]
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FFunkeyFlo%2Fps5-mqtt)
## Features
The following features have been implemented or are planned for future implementation.
| Feature | Implemented |
| -------------------------------------------------- | ----------- |
| Power; Wake/Standby (rest mode) | ✔ |
| Discover Playstation 5 devices on local network | ✔ |
| [Web UI for acquiring credentials][credentials-ui] | ✔ |
| Match [PSN account activity][1.0.0] to device | ✔ |
## Installation
1. Install an [MQTT broker][mqtt-broker], if you haven't already.
2. Add the repository to Home Assistant using the repository's url or by pressing the *add-repostory* button above.
3. Install the PS5 MQTT add-on. **Not the edge version!**.
4. Configure the add-on as described in the [documentation][ha-docs].
5. Start the add-on.
6. Use the web-ui to authenticate with each PlayStation device.
The MQTT entities will be created automatically when a new device is discovered on your network.
*Note: this does require MQTT auto-discovery to be enabled.*
## Using the add-on with Home Assistant Core (`Docker`)
This bit of [documentation][docker-docs] should get you on your way! 😻
## Support the project!
**If you enjoy the project please consider helping me and my family stay warm this winter! :cold_face:**
**Donate so I can keep paying my gas bill, whilst working on this awesome project! :fire:**
## Example usage
## FAQ
### The log is showing 403 errors when I try to turn my ps5 on or off!
Double check that you've enabled all required remote play features [as described in the remote play documentation][ps5-rp].
### Can devices be powered on/off from/to other modes than rest mode?
**No.** The underlying remote play protocol from sony does not support this.
### Why does this add-on only support Awake/Standby on Playstation 4?
There already is a great [Home Assistant integration][ha-ps4] that supports more functionality for PS4 devices like starting games. However, users have reported that this add-on detects Awake/Standby changes faster than the existing integration. So if you want you can use this add-on next to the existing integration or instead of it, if you are only interested in Standby/Awake.
### Can I get the yaml code for button in the [example image](#example-usage)?
**No.** I based my personal custom button cards on [this project][matt8707-dash]. *But* I *heavily* modified them and added loads of custom stuff that is not suitable for sharing at this time as it will likely raise more questions than provide answers.
## Thanks & Credits
The initial MQTT implementation for tracking device power was based on the work done by [andrew-codes][ac-user] and can be found in [this repository][ac-repo].
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
[credentials-ui]: https://community.home-assistant.io/t/ps5-mqtt-control-playstation-5-devices-using-mqtt/441141#impressions-1
[discord]: https://discord.gg/BnmvYHvz5N
[docker-docs]: ./docs/DOCKER.md
[ha-docs]: ./add-ons/ps5-mqtt/DOCS.md
[ac-repo]: https://github.com/andrew-codes/home-automation
[ac-user]: https://github.com/andrew-codes
[matt8707-dash]: https://community.home-assistant.io/t/a-different-take-on-designing-a-lovelace-ui/162594
[mqtt-broker]: https://www.home-assistant.io/docs/mqtt/broker/
[ha-ps4]: https://www.home-assistant.io/integrations/ps4/
[ps5-rp]: https://remoteplay.dl.playstation.net/remoteplay/lang/en/ps5_mobile.html#section3
[1.0.0]: https://github.com/FunkeyFlo/ps5-mqtt/releases/tag/v1.0.0