Add PlayStation 5 status, Wake, and Standby controls to Home Assistant
PS5 MQTT discovers PlayStation consoles on your local network, authenticates each console through its web interface, and publishes compatible entities through MQTT discovery. This tutorial covers the Home Assistant add-on workflow for Home Assistant OS and Home Assistant Supervised, including MQTT preparation, the supported broker options, PlayStation Remote Play settings, console registration, entity verification, and troubleshooting. Home Assistant Container and Core do not include the add-on manager, so they require the project's separate standalone deployment path rather than the add-on steps shown here.
📋 What's in this guide
How PS5 MQTT fits into Home Assistant
PS5 MQTT is an open-source project that integrates Sony PlayStation 5 devices with Home Assistant through MQTT. Its documented features include discovering PlayStation 5 consoles on the local network, acquiring console credentials through a web UI, matching PlayStation Network account activity to a device, and controlling the supported Wake and Standby states.
The installation has four distinct layers. The PlayStation 5 must permit Remote Play and network wake behavior. PS5 MQTT must discover and authenticate the console. An MQTT broker must accept connections from PS5 MQTT and Home Assistant. Finally, Home Assistant's MQTT integration must process discovery messages and create the corresponding device and entities.
A healthy broker does not prove that the PlayStation can be discovered or controlled. Likewise, finding the console does not prove that Home Assistant received its MQTT discovery messages. Verify the installation one layer at a time.
Choose the correct Home Assistant installation path
This tutorial's detailed installation procedure applies to Home Assistant OS and Home Assistant Supervised. These installation types include the Supervisor and add-on manager needed to install the PS5 MQTT repository as a third-party add-on.
Home Assistant Container and Home Assistant Core do not include the Supervisor or add-on store. They cannot install a Home Assistant add-on from the Settings menu. The PS5 MQTT project links to a separate Docker-oriented path for Core and Container users, but that is a standalone service deployment with its own container networking, persistence, startup, and MQTT configuration requirements.
| Home Assistant installation | Add-on store available | Path for PS5 MQTT |
|---|---|---|
| Home Assistant OS | Yes | Follow the complete add-on procedure in this guide |
| Home Assistant Supervised | Yes | Follow the complete add-on procedure in this guide |
| Home Assistant Container | No | Use the separate Docker deployment documented by the PS5 MQTT project |
| Home Assistant Core | No | Run PS5 MQTT as a separately managed service using the project's Core or Docker instructions |
If you are unsure which installation you have, open Settings, select System, and inspect the installation information. The presence of Settings > Add-ons is also a practical indication that the add-on workflow is available.
Home Assistant documents the process for installing community repositories in its third-party add-on instructions. A third-party add-on is not maintained or supported by the Home Assistant project, so review its repository, documentation, configuration, and update notes before installation.
The Supervisor supplies networking, storage, lifecycle management, and ingress behavior to add-ons. A standalone container must reproduce the requirements documented for that deployment. If you use Home Assistant Container or Core, follow the current Docker documentation linked from the PS5 MQTT repository instead of guessing volume mappings, ports, environment variables, or network mode.
Prepare MQTT before installing PS5 MQTT
PS5 MQTT requires an MQTT broker. The broker is a separate service that routes messages between MQTT clients. Home Assistant's MQTT integration is a client integration, not a broker by itself.
Home Assistant OS and Supervised users commonly install the official Mosquitto broker add-on, but PS5 MQTT can use another broker that is reachable from both PS5 MQTT and Home Assistant. Use the connection values that belong to your actual broker. Do not assume that an example hostname is correct for an external broker or a different deployment model.
Install or identify the broker
If you use the Mosquitto broker add-on, open Settings > Add-ons > Add-on Store, locate Mosquitto broker, and install it. Start the broker and enable its start-on-boot option if you want MQTT services to recover automatically after the host restarts.
If a broker is already running elsewhere, record its hostname or IP address, listener port, and credentials. Confirm that it accepts connections from the Home Assistant host. Broker authentication, TLS, listener binding, and network policy are controlled by the broker and may differ from one installation to another.
Configure the Home Assistant MQTT integration
Open Settings > Devices & services. If Home Assistant has discovered the broker, an MQTT discovery card may be waiting for configuration. Otherwise, select Add Integration, search for MQTT, and enter the broker details requested by Home Assistant.
After setup, an MQTT entry should appear on the Integrations page without a failed setup message. Open that entry to inspect its devices and entities. Home Assistant's current MQTT behavior and configuration options are documented in the Home Assistant MQTT integration documentation.
Check discovery
PS5 MQTT depends on MQTT discovery for automatic entity creation. Discovery is enabled by default for normal Home Assistant MQTT integration setups, but it can be disabled or assigned a different discovery prefix in custom configurations.
Use the same discovery prefix on both sides. The standard Home Assistant prefix is homeassistant. If you previously customized the MQTT integration's discovery prefix, the PS5 MQTT setting must match it. A broker connection can succeed while entity creation fails because the two applications publish and listen under different discovery prefixes.
Define concrete MQTT success criteria
- The broker remains running without repeated startup failures.
- The MQTT integration appears under Settings > Devices & services.
- The integration does not report a persistent authentication or connection failure.
- The credentials intended for PS5 MQTT are accepted by the broker.
- MQTT discovery is enabled, and its prefix matches the value used by PS5 MQTT.
Create credentials appropriate for your broker and deployment. Do not publish them in screenshots, issue reports, automation examples, or public configuration repositories. Replace usernames, passwords, hostnames, and account identifiers with redacted placeholders before sharing diagnostic material.
Enable the required PlayStation 5 settings
Configure the console before attempting registration. PS5 MQTT relies on Sony's Remote Play behavior for registration and supported power operations. Missing console settings commonly surface later as discovery, registration, or HTTP 403 command errors.
Enable Remote Play
On the PS5, open Settings > System > Remote Play and turn on Enable Remote Play. If the console provides account-specific Remote Play controls, make sure the account being used for registration is permitted.
Keep the console connected in rest mode
Open Settings > System > Power Saving > Features Available in Rest Mode and enable Stay Connected to the Internet. Without network connectivity in rest mode, the console cannot receive a network wake request.
Allow network wake
In the same Features Available in Rest Mode screen, enable Enable Turning On PS5 from Network. This is required for Wake behavior from a supported rest-mode state.
Sony documents the broader setup and operating requirements in its PS Remote Play documentation. Menu wording can vary slightly with console software and display language, but the required functions are Remote Play, internet connectivity while in rest mode, and permission to turn on the console from the network.
PS5 MQTT documents Wake and Standby support. Do not use a fully powered-off console as the first wake test. Place the console in rest mode, confirm that its network connection remains available, and then test Wake.
Install and configure the PS5 MQTT add-on
The project documents a six-part installation sequence: install an MQTT broker, add the repository, install the normal add-on, configure it, start it, and authenticate every PlayStation device. Use the regular PS5 MQTT add-on rather than the edge build for this standard installation.
Confirm that MQTT is ready
Verify that the broker is running and that the MQTT integration is configured under Settings > Devices & services. Resolve broker authentication or connectivity failures before installing PS5 MQTT.
Add the PS5 MQTT repository
Open Settings > Add-ons > Add-on Store. Open the menu in the upper-right corner, select Repositories, and enter https://github.com/FunkeyFlo/ps5-mqtt. Add the repository, close the repository dialog, and refresh the add-on store if the new entries do not appear immediately.
Install the regular PS5 MQTT add-on
Select PS5 MQTT from the repository and install it. Do not select the edge version for the standard workflow. Wait for installation to complete before opening the Configuration tab.
Enter the documented MQTT options
Configure the mqtt block with the broker host, port, user, password, and protocol. Use values accepted by your broker. For a normal unencrypted MQTT listener, the protocol value is mqtt. Do not select a secure protocol unless the broker listener and the installed add-on documentation explicitly support and configure it.
Save and start the add-on
Save the configuration, return to the add-on's Info page, and select Start. Open the Log tab and confirm that the process stays running and does not repeatedly report malformed configuration, broker authentication failure, DNS failure, or connection refusal.
Open the web UI and register each console
Use Open Web UI from the add-on page. Complete the account and console registration flow for every PlayStation you want PS5 MQTT to manage. Entity creation occurs after a console is discovered and MQTT discovery messages reach Home Assistant.
MQTT option reference
| Option | Required value | Guidance |
|---|---|---|
mqtt.host |
Broker hostname or IP address | Use a name resolvable from the add-on or an address reachable from the Home Assistant host. The Mosquitto add-on commonly uses its internal service hostname, while an external broker uses its own LAN name or address. |
mqtt.port |
Broker listener port | Use the port configured on the broker. Port 1883 is conventional for unencrypted MQTT, but the broker configuration remains authoritative. |
mqtt.user |
Broker username | Enter an account the broker permits to connect, publish, and subscribe to the required topics. |
mqtt.password |
Broker password | Enter the corresponding secret. Replace it with a redacted placeholder in screenshots or support requests. |
mqtt.protocol |
Protocol supported by the configured listener | Use mqtt for a standard MQTT listener. Do not infer TLS support from the port number alone. |
A redacted configuration for a conventional broker connection has this shape:
mqtt:
host: core-mosquitto
port: 1883
user: ps5_mqtt
password: REDACTED_BROKER_PASSWORD
protocol: mqttThe hostname in this example is appropriate only when the broker is available through that internal add-on service name. Replace it for an external broker. Replace the username and password with credentials that exist in your broker. If the configuration editor generated the structure for you, edit the values without renaming documented keys.
Add-on schemas can change between releases. Before saving, compare the option names and allowed values above with the Documentation tab presented by the installed PS5 MQTT add-on and the current project repository. Home Assistant will reject values that do not match the installed schema.
Authenticate the PlayStation 5
Authentication has two purposes. PS5 MQTT must identify the PlayStation Network account used by the console, and it must register as a Remote Play client with the individual device. Keep the PS5 awake and connected to the same trusted local network while completing the initial process.
Open the local PS5 MQTT web interface
From the PS5 MQTT add-on page, select Open Web UI. Use Home Assistant's provided add-on route rather than guessing a container address or port.
Complete the PlayStation Network account step
Follow the authentication instructions displayed by the current PS5 MQTT web UI. Sign in only through the Sony account flow or provide the account authentication value specifically requested by the installed version. Do not place PlayStation credentials or reusable authentication material in add-on logs, screenshots, or issue reports.
Select the discovered console
Wait for the intended PS5 to appear in the local device list and select it. If multiple consoles appear, compare the device details shown in the interface before proceeding. If nothing appears, stop and troubleshoot local discovery.
Generate the PS5 link code
On the console, open Settings > System > Remote Play > Link Device. The PS5 displays a temporary eight-digit registration code. Leave this screen open because the code expires.
Enter the link code in PS5 MQTT
Enter the eight-digit code in the registration field shown by the PS5 MQTT web UI and submit it before expiration. If it expires, request a new code on the console and repeat this step.
Wait for registration and discovery to complete
Confirm that the web interface reports the console as registered or authenticated. Then inspect the add-on log for a successful device connection and MQTT publication rather than immediately closing every setup screen.
Repeat for additional consoles
Generate a new Link Device code and complete registration separately for each additional PlayStation. Do not assume that registering one device authorizes every console on the account.
The current project evidence does not establish a supported standalone bind address, fixed public port, external reverse-proxy behavior, or independent authentication layer for the credential-acquisition interface. Do not expose it directly to the public internet. Remote users should normally interact with the resulting entities through a separately secured Home Assistant interface.
Verify logs, devices, entities, states, and commands
A green add-on status is only the first success criterion. Verify the full path from the physical console to Home Assistant and back to the console.
Check the PS5 MQTT log
Open Settings > Add-ons > PS5 MQTT > Log. Confirm that the add-on remains running, connects to the broker, discovers the intended console, and does not enter a restart loop.
Check the MQTT integration
Open Settings > Devices & services and select MQTT. Confirm that the integration is loaded and does not report an unavailable broker or failed authentication.
Find the PlayStation device
Open the MQTT integration's device list or use Settings > Devices & services > Devices and search for the console. The appearance of an MQTT device is observable evidence that discovery reached Home Assistant.
Inspect its entities
Open the device page and review the created entities. Confirm that they are enabled and not permanently unavailable. Entity names can incorporate device details and may differ between installations, so verify their device association rather than relying only on a copied entity ID.
Verify a physical state update
With the PS5 awake, observe its reported state. Put it into rest mode using the console and wait for Home Assistant to reflect Standby. This tests console observation and MQTT state delivery without involving a command.
Test Wake from rest mode
Issue the supported Wake action from the device or entity control in Home Assistant. Confirm that the physical console wakes and that Home Assistant subsequently reports the awake state.
Test Standby
Issue the supported Standby action. Confirm that the console enters rest mode and that the state shown by Home Assistant follows the physical device.
Interpret partial success correctly
| Observed result | What it proves | Where to investigate next |
|---|---|---|
| Add-on runs, but no console appears | The process started | Local discovery, VLANs, network isolation, and console availability |
| Console appears in PS5 MQTT, but no Home Assistant device appears | Local discovery works | Broker connection, discovery prefix, and Home Assistant MQTT discovery |
| State updates, but commands fail | Discovery and inbound state publication work | Console registration, Remote Play settings, command topics, and 403 log entries |
| Wake works only from rest mode | The documented Wake path works | This is expected behavior rather than evidence of a failed installation |
| Commands work, but state remains stale | Command delivery reaches the console | Availability, state publication, broker subscriptions, and console polling |
Test direct device controls before creating automations. Once the device reliably reports Awake and Standby and responds to both supported actions, you can use those entities in dashboards, scenes, and automations without confusing automation logic with integration problems.
Operate and maintain PS5 MQTT
After registration, Home Assistant should be the normal control surface. The PS5 MQTT web interface is an administrative setup tool, not a page that needs to remain publicly accessible.
Plan for startup order
After a host restart, the broker must become available before PS5 MQTT can connect. Home Assistant must then receive discovery and state messages. A brief unavailable period during startup is different from a persistent failure. If entities remain unavailable, inspect the broker and add-on logs rather than repeatedly deleting and recreating the integration.
Review updates deliberately
Before updating, read the current release notes and the add-on documentation presented by Home Assistant. Check for configuration schema changes, authentication changes, or migration steps. After updating, confirm broker connectivity, console discovery, state reporting, and one supported command.
Share diagnostics safely
Logs can contain broker hostnames, usernames, console identifiers, account information, local addresses, or authentication data. Redact reusable secrets and identifying values before sharing logs. Preserve timestamps, error codes, and surrounding messages because those details are useful for diagnosis.
Keep PS5 MQTT local and secure remote Home Assistant separately
Do not create a public tunnel to the PS5 MQTT credential-acquisition interface based on this article. The available project documentation does not establish its standalone port, bind behavior, access controls, reverse-proxy compatibility, callback behavior, or suitability for use outside Home Assistant's local add-on route.
Remote users normally need the resulting PlayStation entities, not the registration page. Provide remote access through a separately secured Home Assistant interface that has appropriate authentication, authorization, and proxy configuration. Keep PS5 MQTT, console discovery, and console registration on the trusted local network.
Localtonet remains relevant when you have deliberately selected an authenticated HTTP service that is reachable from the Localtonet client device and documented as suitable for reverse-proxy access. Our client establishes an outbound connection to a Localtonet relay, so the service can receive a public HTTPS address without inbound router port forwarding, firewall changes, VPN setup, or a public IP address.
A tunnel should never be aimed at a common Home Assistant or add-on port merely because it responds. Confirm the exact service, authentication boundary, reverse-proxy requirements, and intended public behavior first. A reachable administrative interface is not automatically safe to publish.
If you later use Localtonet for a verified and authenticated web endpoint, follow the documented lifecycle: install and run the Localtonet client on a device that can reach the target, select that device with its private auth token, select a currently available relay server, create the HTTP tunnel with the verified local IP address and port, and then select Start. Creating a tunnel does not start it.
Test the assigned public URL from a separate network and confirm that it reaches only the intended authenticated application. When access is no longer required, stop the tunnel. Delete it if it will not be reused. The endpoint remains available only while the selected client is connected and the tunnel is running. Review our current Localtonet documentation before configuring relay, domain, or plan-dependent options.
Troubleshooting PS5 MQTT installation problems
The repository does not appear in the add-on store
Confirm that you entered https://github.com/FunkeyFlo/ps5-mqtt in the repository manager without an extra path. Refresh the add-on store after adding it. Also confirm that your Home Assistant installation includes the Supervisor. Home Assistant Container and Core cannot install repositories through an add-on store.
The add-on rejects the configuration
Compare the saved YAML with the Configuration or Documentation tab of the installed add-on. Check indentation, option spelling, data types, and required values. The MQTT port must be numeric, and the structure must retain the documented mqtt block. Do not paste Docker environment variables into the add-on configuration.
The add-on starts and then stops
Open the Log tab immediately after starting it. A configuration parsing message points to the add-on options. Authentication failure, connection refusal, name-resolution failure, or timeout points to the broker path. Confirm that the broker hostname resolves from the add-on environment and that the configured listener accepts the chosen protocol and credentials.
PS5 MQTT cannot connect to the broker
Confirm that the broker is running and that Home Assistant's MQTT integration can connect. Then compare the PS5 MQTT host, port, username, password, and protocol with the broker listener. A hostname that works from your laptop may not resolve inside the add-on environment. Conversely, an internal add-on hostname may not work from a standalone Docker container.
The PlayStation is not discovered
Keep the PS5 awake during initial discovery. Confirm that the console and Home Assistant host have an intended local network path. Review guest Wi-Fi isolation, wireless client isolation, VLAN rules, container network boundaries, and firewall policy. Do not broadly disable segmentation. Apply only the local access your network design permits.
Registration fails or the code expires
Generate a fresh code from Settings > System > Remote Play > Link Device and enter it promptly. Confirm that Remote Play is enabled and that you selected the correct discovered console. Restart the registration flow if account authentication was interrupted or completed under the wrong PlayStation Network account.
No device or entities appear in Home Assistant
Confirm that registration completed, the add-on log reports broker connectivity, and the console was discovered. Then open Settings > Devices & services > MQTT. Verify that discovery is enabled and that its prefix matches PS5 MQTT. If you changed the prefix from homeassistant, both sides must use the same value.
The entities are unavailable
Check whether the add-on is running and connected to MQTT. Then inspect whether the console is reachable in its current power state. If entities became unavailable after a broker restart, allow the clients to reconnect and review both broker and add-on logs for rejected sessions.
Wake or Standby produces HTTP 403 errors
The PS5 MQTT project specifically recommends checking all required Remote Play features. Confirm Enable Remote Play, Stay Connected to the Internet, and Enable Turning On PS5 from Network. Also verify that the affected console completed registration with the correct account and Link Device code.
The console does not wake from complete shutdown
Put it into rest mode and test again. PS5 MQTT documents Wake and Standby behavior, and the underlying Remote Play protocol does not provide arbitrary power transitions from every state. Successful wake from rest mode is the appropriate acceptance test.
State changes are delayed or stale
Compare the physical console state with the PS5 MQTT log and Home Assistant entity history. If PS5 MQTT notices the transition but Home Assistant does not, focus on MQTT publication and subscriptions. If PS5 MQTT does not notice it, focus on local console connectivity and the add-on process.
Frequently asked questions
Does PS5 MQTT require an MQTT broker?
Yes. PS5 MQTT uses MQTT to publish discovery and state information and receive supported commands. Home Assistant's MQTT integration and PS5 MQTT must connect to the same broker.
Which Home Assistant installations support the add-on?
Home Assistant OS and Home Assistant Supervised include the add-on manager used in this guide. Home Assistant Container and Core do not support add-ons and must use the project's separate standalone or Docker deployment path.
Should I install the PS5 MQTT edge add-on?
Not for the normal installation described here. The PS5 MQTT project instructs users to install the regular add-on rather than the edge version.
Which PS5 settings are required?
Enable Remote Play under Settings > System > Remote Play. Under Settings > System > Power Saving > Features Available in Rest Mode, enable Stay Connected to the Internet and Enable Turning On PS5 from Network.
Why did no PS5 entities appear automatically?
Automatic creation requires successful console discovery and registration, a working broker connection, MQTT discovery enabled in Home Assistant, and matching discovery prefixes. Check those conditions in that order.
Can PS5 MQTT wake a completely powered-off console?
Do not rely on that transition. The documented control scope is Wake and Standby, where Standby is rest mode. Test Wake with the console in rest mode and with network wake enabled.
What usually causes 403 errors during Wake or Standby?
The project recommends checking the required Remote Play features first. Also confirm that account authentication and Link Device registration were completed for the specific console producing the error.
Should I expose the PS5 MQTT web UI with Localtonet?
No public-exposure recommendation is made for that interface. Its standalone port, bind behavior, independent access controls, and reverse-proxy compatibility are not established by the available project documentation. Keep credential acquisition local and use a separately secured Home Assistant interface for remote control.
Does Localtonet make PS5 discovery work across the internet?
No. A Localtonet tunnel publishes a deliberately selected local service. PS5 MQTT console discovery remains a local-network function, so VLAN, firewall, or discovery problems must be resolved inside the local environment.
Publish only a verified, authenticated web endpoint
Keep PS5 MQTT discovery and credential acquisition local. If you later choose a separate web service that is documented for remote use, adequately authenticated, and reachable from a Localtonet client device, our platform can publish that selected endpoint without inbound router port forwarding. Start the tunnel only when needed, then stop or delete it when access is no longer required.
Get Started Free →
