ps4 component allows you to control a
Sony PlayStation 4 console.
- This component supports controlling a single PlayStation 4 for your instance. Additional consoles may be supported in a future release.
- Download the Second Screen App and make sure that you can find and control your PlayStation 4 normally.
Read the section “Granting Port Access” below before continuing.
Configuration -> Integrationsand select
Follow instructions displayed to generate user credentials. You will know this step is completed when a form with fields appears.
Pair Home Assistant to your PlayStation 4 by filling in the fields.
- Note: To find your correct region refer to the section Regions
The PlayStation 4 component requires the use of privileged ports to work correctly, specifically UDP port 987 and TCP port 997. Depending on your OS of your Home Assistant instance you may need to allow usage of privileged ports manually.
Do not run your Home Assistant instance itself as root or with root/sudo privileges to accomplish this. This would create a security risk for your host system.
There are varying methods to perform this, dependent on your OS that is running Home Assistant. Specifically, your Python Interpreter which runs your Home Assistant instance needs access to the mentioned ports.
If your Home Assistant device is running Hass.io on HassOS, it does not require additional configuration.
Home Assistant installed on a Debian-type OS may require configuration. This section is applicable but not limited to the following operating systems:
In terminal run the following command:
sudo setcap 'cap_net_bind_service=+ep' <python>
<python> with your system path to Python that is running Home Assistant and/or your virtual environment if used. The path should not be a symlink or be inside of a virtual environment.
sudo setcap 'cap_net_bind_service=+ep' /usr/bin/python3.5
To find your system Python path:
Add the System Health component to your
configuration.yaml. In a web browser access your frontend and navigate to the about/logs page “http://
/dev-info). In the System Health box locate the item **python_version** and note the value that is displayed. Then in terminal run:
<version>with the value for
python_versionthat is shown in the System Health box.
The output which has the directory
/bin/is likely your system python path which should look like this
If Home Assistant is installed in a virtual environment, use terminal to
cdto the root/top directory of your environment and run:
readlink -f bin/python3
readlink -f bin/python
The output will be your system Python path.
When running Home Assistant using Docker, make sure that the Home Assistant container is discoverable by the PS4. This can be achieved by ensuring that the Home Assistant container uses the
host network driver (by passing
--net=host to the container when creating, or adding
network_mode: "host" to your compose file when using
The PlayStation 4 component does not use entries from
configuration.yaml. You must configure this component by using
Some titles will have different SKUs in the PlayStation Store database depending on your region. You must select your specific region in the setup in order to retrieve the cover art for such titles correctly. The component will attempt to search other databases for the correct title if it cannot be found, although it will take longer to do so and may fetch an incorrect cover.
|Available Regions||Unavailable Regions|
|Argentina, Australia, Austria, Bahrain, Belgium, Brazil, Bulgaria,||China, Japan, Phillipines,|
|Canada, Chile, Columbia, Costa Rica, Croatia, Cyprus, Czech Republic,||Serbia, Ukraine, Vietnam|
|Denmark, Ecuador, El Salvador, Finland, France, Germany, Greece, Guatemala,|
|Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Ireland, Israel,|
|Italy, Korea, Kuwait, Lebanon, Luxembourg, Malta, Maylasia, Mexico,|
|Middle East, Nederland, New Zealand, Nicaragua, Norway, Oman, Panama,|
|Peru, Poland, Portugal, Qatar, Romania, Russia, Saudi Arabia, Singapore,|
|Slovakia, Slovenia, South Africa, Spain, Sweden, Switzerland, Taiwan,|
|Thailand, Turkey, United Arab Emirates, United Kingdom, United States|
The regions which are unavailable have no database or have formatting in the database which can not be used by the component.
Emulate button press on PlayStation 4. This emulates the commands available for the PS4 Second Screen App. This is not to be confused with DualShock 4 controller buttons.
|Service data attribute||Optional||Example||Description|
||The entity id for your PlayStation 4.|
||The command you want to send.|
Full list of supported commands.
If you are running a game/title on your PS4 that does not display a cover or displays the incorrect cover, post an issue here.
Be sure to include the following information:
- Your Country
As well as the exact values for the following attributes found in the state of your PS4 entity.