-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Add PlayStation Network Documentation #36520
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: next
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
--- | ||
title: PlayStation Network | ||
description: Instructions on enabling PlayStation Network support for your Home Assistant | ||
ha_category: | ||
- Media player | ||
ha_release: 2025.1 | ||
ha_iot_class: Cloud Polling | ||
ha_domain: playstation_network | ||
ha_platforms: | ||
- media_player | ||
ha_codeowners: | ||
- '@jackjpowell' | ||
ha_config_flow: true | ||
ha_integration_type: integration | ||
related: | ||
- url: https://playstation.com/ | ||
title: Playstation | ||
--- | ||
|
||
The PlayStation Network {% term integration %} enables you to seamlessly integrate information from your currently playing game in Home Assistant. | ||
|
||
## About PlayStation Network | ||
|
||
PlayStation Network (PSN) is a digital media entertainment service provided by [Sony Interactive Entertainment](https://en.wikipedia.org/wiki/Sony_Interactive_Entertainment). It allows users to enjoy a variety of gaming-related services such as purchasing games, downloading content, and connecting with other players. | ||
|
||
## How you can use this integration | ||
|
||
The PlayStation Network integration lets you integrate information about your currently playing game into Home Assistant. You can display the game title and cover art in your Home Assistant dashboards. | ||
|
||
## Prerequisites for PlayStation Network integration | ||
|
||
- To set up the PlayStation Network integration, you must first have an active PlayStation Network account. You can register for an account at the [Official PlayStation® Site](https://playstation.com/). | ||
- During the setup process in Home Assistant, you will be asked to provide your NPSSO token. You will need to be logged into [playstation.com](https://playstation.com/) to access the token in your browser. You will find a link to retrieve the token in the config flow. | ||
|
||
{% include integrations/config_flow.md %} | ||
|
||
### Login to PlayStation Network | ||
|
||
{% configuration_basic %} | ||
"NPSSO Token": | ||
description: "Supply your NPSSO token after successfully logging into the PlayStationNetwork in your browser." | ||
required: true | ||
type: string | ||
{% endconfiguration_basic %} | ||
|
||
## Supported Functionality | ||
|
||
### Media Players | ||
|
||
- **PlayStation Console**: One Media Player will be created for any PlayStation 5 and one Media Player will be created for any PlayStation 4 console you have connected to the PlayStation Network. The artwork and title of the currently playing game will be populated. | ||
|
||
## Data updates | ||
|
||
This integration retrieves data from the PlayStation Network every 30 seconds to ensure timely updates. | ||
|
||
## Known limitations | ||
|
||
PlayStation Network imposes a rate limit of 300 requests per 15 minutes. | ||
|
||
This integration makes 3 requests per data update (every 30 seconds). This presently is well under the rate limit, but leaves room to add additional requests as the integration develops. | ||
|
||
Please keep these limits in mind to avoid exceeding the PlayStation Network request allowance. | ||
|
||
The Active state for each device is only reported via the API for the last used device. For example, if you start playing a game on your PS4 and without powering down, launch a game on your PS5, the API will only report your PS5 status. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Clarify the device status limitation implications. Consider adding:
|
||
|
||
## Supported devices | ||
|
||
The following devices are known to be supported by the integration: | ||
|
||
- PlayStation 5 | ||
- PlayStation 4 | ||
|
||
## Unsupported devices | ||
|
||
The following devices are not supported by the integration: | ||
|
||
- PlayStation 3 | ||
- PlayStation Vita | ||
- PlayStation Portable | ||
- Other PlayStation system variants (PlayStation TV) or older systems that do not support the PlayStation Network | ||
|
||
## Use Cases | ||
|
||
You can display your currently playing game as artwork on your dashboard. You can also send notifications of your currently playing game to others inviting them to join you. | ||
Comment on lines
+82
to
+84
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Expand the Use Cases section with more examples. The current use cases are very brief. Consider adding:
|
||
|
||
## Remove integration | ||
|
||
This integration can be removed by following these steps: | ||
|
||
{% include integrations/remove_device_service.md %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Add specific instructions for NPSSO token retrieval
The documentation mentions that users will find a link to retrieve the token in the config flow, but it would be helpful to include:
This would improve the user experience during setup.