Add PlayStation Network Integration #133901

JackJPowell · 2024-12-23T17:26:13Z

Proposed change

This change adds support for integrating with the PlayStation Network. In this first release (my first HA PR), I have attempted to remove all unneeded code (no entity base class since I only have a single platform) but anticipate adding it, and refactoring elsewhere to follow home assistant conventions in subsequent pull requests. The integration contains a single platform (Media Player), is setup fully via the UI, supplies unique IDs, and attempts to follow all current Home Assistant best practices.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

When reviewing this integration, please keep in mind that it represents a user on the playstation network and not the PlayStation console itself. It is structured around allowing the user to associate multiple PSN accounts and the device names are setup to match this. This integration started its life as a custom component and has about ~400 users. For a look at what this may evolve into, here is a link to the custom repository.

This initial release of the PlayStation Network Integration exposes a media player based on the user's registered systems with the playstation network. One will be created for any PS4 systems and another for any PS5 systems. However, due to api limitations, it is not possible to pull data for more than a single console at a time nor do I have dates for when a console was last active. Given these limitations I'd like to discuss what the Home Assistant team believes is the best course of action to take in this regard:

Only a single system is reported as active. If a user is active on more than one, the one with the oldest action will be misrepresented in home assistant (reported as Off).
The api does not provide date of last access information so the integration may be creating a media player for a PS4 that the user no longer owns.
Since this integration is a representation of the user's account on the PlayStation Network, and not a PlayStation console device, does it make sense to expose a single PlayStation Console Media Player that contains the state of whatever currently active console the API is reporting?

A quality_scale.yaml file is included and I did my best to conform to all bronze level items. Some are marked as done, like common-modules, that still have pending tasks (the creation of entity.py for instance) but was skipped for this initial release. If this is the wrong approach, please let me know.

The integration communicates with the PlayStation Network via a supplied NPSSO token that the config flow walks the user through obtaining (along with the documentation referenced in PR#36520.

This integration relies on the PSNAWP project which was reversed engineered from the PlayStation Mobile app and is not endorsed or supported by Sony.

This PR wouldn't have been possible without the amazing help and guidance from @tr4nt0r. He put in so much time and effort to ensure this first PR go smoothly.

The associated brand images were included for the custom integration and are still up to date. Brands PR

Updates

After speaking with Joost, we decided to make a few changes to the submission:

I've reached out to the owner of the PSNAWP library and he was excited about the library's use in HA and will be updating his dependencies to come inline with HAs. (He already has them updated but has not published the release yet. He agreed to do so before the end of May)
1.1) I also submitted two PRs to his repo to integrate a couple of changes/additions I added to my fork of his repo. One of which has already been merged.
While we wait on the official library to be updated, I have published a new version of my fork that is mimicking the current state of PSNAWP library. (Dependency updated, PRs included, but without any of my custom changes) The intent being that once he publishes 2.3.0 of the official repo, all I should need to do is update my manifest to point to his library.
This will allow for an earlier review of this PR as time allows.
3.1) helpers.py has been added which includes the bulk of what I was maintaining in my fork.
3.2) config_flow - parse_npsso_token got some requested updates in my PR and required a change + tests in the integration
@tr4nt0r discovered that ps3 game status is returned on a different endpoint and I have added it to the supported platforms. Vita is close but media image is currently unavailable.
4.1) If this needs to be held for another PR, just let me know.

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

joostlek · 2024-12-23T21:48:48Z

Do you get a separate unique id for every playstation?

JackJPowell · 2024-12-24T14:15:49Z

Do you get a separate unique id for every playstation?

Yes and no. I can pull a list of registered devices and they do have a unique deviceId. However, the call to return the user state (What game are they playing, are they online), only returns the device type (PS4, PS5) which is not associated to any particular deviceId.

I also question the validity of the registered device data. I've had two PS4s over the years but I only have one entry in the response. I do have entries for my three PS3 systems though.

I meant to mention this in the original pull request, and I'll add it there now too, but I'm working with an undocumented and "unofficial" api. The psnawp project reverse engineered it from the android PlayStation Mobile app. The end result is that I'm left to infer some things rather than read it in the docs.

homeassistant/components/playstation_network/media_player.py

homeassistant/components/playstation_network/config_flow.py

homeassistant/components/playstation_network/coordinator.py

homeassistant/components/playstation_network/media_player.py

homeassistant/components/playstation_network/quality_scale.yaml

home-assistant · 2025-01-13T11:25:21Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

homeassistant/components/playstation_network/quality_scale.yaml

bieniu

Could you please rabase and run python3 -m script.hassfest?

homeassistant/components/playstation_network/media_player.py

homeassistant/components/playstation_network/coordinator.py

homeassistant/components/playstation_network/helpers.py

joostlek · 2025-06-08T12:42:51Z

homeassistant/components/playstation_network/media_player.py

+        if not SUPPORTED_PLATFORMS - devices_added:
+            remove_listener()


What's this for?

The integration only adds entities for devices that the user is actively using. This is to prevent adding a PS3/PS4 that is in the user's lifetime device list, but that they no longer own or use. And once all of the integration's supported devices have been added, there is no longer a need to check for new ones.

But we remove old ones right

Sorry, I may not be following. Are you asking if we removed older platforms from the supported list? In which case, yes.

I would suggest we should allow users to remove devices manually as there is no way to recognize if they don't own that platform anymore

But if they don't own the platform anymore, they won't be actively logged in to the playstation network on it, and the integration won't add it as a media player. In the current state, the no-longer-owned PS3 for instance won't be added to HA.

anyway, that's something that can be added later

joostlek · 2025-06-12T14:48:14Z

homeassistant/components/playstation_network/helpers.py

+        if LEGACY_PLATFORMS & data.registered_platforms:
+            assert self.client is not None
+            self.legacy_profile = await self.hass.async_add_executor_job(


so if I understand correctly, in theory we can already do this request in the retrieve_psn_data. As in, we can do this check and this call there

You're right again. I didn't want to do this call unnecessarily but as long as we shift some logic we can group it too and only make the call when necessary. Will fix

All grouped together 👍🏻

tests/components/playstation_network/test_config_flow.py

joostlek · 2025-06-12T14:52:39Z

tests/components/playstation_network/test_config_flow.py

+    mock_psnawp_npsso.parse_npsso_token.side_effect = PSNAWPInvalidTokenError
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN,
+        context={"source": config_entries.SOURCE_USER},
+        data={CONF_NPSSO: NPSSO_TOKEN_INVALID_JSON},
+    )
+    assert result["errors"] == {"base": "invalid_account"}
+
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": config_entries.SOURCE_USER}
+    )
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] == {}
+
+    mock_psnawp_npsso.parse_npsso_token.side_effect = None
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {CONF_NPSSO: NPSSO_TOKEN},
+    )
+
+    assert result["type"] is FlowResultType.CREATE_ENTRY
+    assert result["data"] == {
+        CONF_NPSSO: NPSSO_TOKEN,
+    }


Currently this test is also creating 2 config flows while only one is needed

I believe this is fixed but wanted you to check first.

joostlek

CI for 3.0.0 https://github.com/isFakeAccount/psnawp/actions/runs/15224374415/job/42824516538

NoRi2909 · 2025-06-24T05:37:49Z

homeassistant/components/playstation_network/strings.json

+          "npsso": "NPSSO token"
+        },
+        "data_description": {
+          "npsso": "The NPSSO token is generated during successful login of your PlayStation Network account and is used to authenticate your requests from with Home Assistant."


We missed the "… requests from with Home Assistant." here.

already fixed in another PR 👍🏼

* clean pull request * Create one device per console * Requested changes * Pr/tr4nt0r/1 (#2) * clean pull request * Create one device per console * device setup * Merge PR1 - Dynamic Device Support * Merge PR1 - Dynamic Device Support --------- Co-authored-by: tr4nt0r <[email protected]> * nitpicks * Update config_flow test * Update quality_scale.yaml * repair integrations.json * minor updates * Add translation string for invalid account * misc changes post review * Minor strings updates * strengthen config_flow test * Requested changes * Applied patch to commit a358725 * migrate PlayStationNetwork helper classes to HA * Revert to standard psn library * Updates to media_player logic * add default_factory, change registered_platforms to set * Improve test coverage * Add snapshot test for media_player platform * fix token parse error * Parametrize media player test * Add PS3 support * Add PS3 support * Add concurrent console support * Adjust psnawp rate limit * Convert to package PlatformType * Update dependency to PSNAWP==3.0.0 * small improvements * Add PlayStation PC Support * Refactor active sessions list * shift async logic to helper * Implemented suggested changes * Suggested changes * Updated tests * Suggested changes * Fix test * Suggested changes * Suggested changes * Update config_flow tests * Group remaining api call in single executor --------- Co-authored-by: tr4nt0r <[email protected]> Co-authored-by: Joost Lekkerkerker <[email protected]>

home-assistant bot added cla-signed has-tests integration: playstation_network new-integration quality-scale labels Dec 23, 2024

This was referenced Dec 23, 2024

Add Playstation Network Documentation home-assistant/home-assistant.io#36512

Closed

Add Playstation Network Documentation home-assistant/home-assistant.io#36519

Closed

Add PlayStation Network Documentation home-assistant/home-assistant.io#36520

Merged

JackJPowell marked this pull request as ready for review December 23, 2024 17:42

tr4nt0r suggested changes Dec 24, 2024

View reviewed changes

homeassistant/components/playstation_network/media_player.py Outdated Show resolved Hide resolved

JackJPowell force-pushed the PlayStationNetwork branch from 7898fc4 to 679b123 Compare January 12, 2025 19:04

joostlek requested changes Jan 13, 2025

View reviewed changes

home-assistant bot marked this pull request as draft January 13, 2025 11:25

JackJPowell force-pushed the PlayStationNetwork branch 2 times, most recently from 9fcee12 to f84ee93 Compare January 18, 2025 22:39

JackJPowell marked this pull request as ready for review January 18, 2025 22:44

home-assistant bot requested review from joostlek and tr4nt0r January 18, 2025 22:44

tr4nt0r suggested changes Jan 18, 2025

View reviewed changes

JackJPowell force-pushed the PlayStationNetwork branch from ef11f41 to 6e93647 Compare January 19, 2025 19:39

JackJPowell force-pushed the PlayStationNetwork branch from 6e93647 to b12c19e Compare February 2, 2025 14:20

JackJPowell force-pushed the PlayStationNetwork branch 2 times, most recently from 649b5ca to a4296ad Compare March 1, 2025 18:38

bieniu requested changes Mar 14, 2025

View reviewed changes

homeassistant/components/playstation_network/media_player.py Outdated Show resolved Hide resolved

homeassistant/components/playstation_network/media_player.py Outdated Show resolved Hide resolved

home-assistant bot marked this pull request as draft March 14, 2025 10:04

JackJPowell force-pushed the PlayStationNetwork branch from a4296ad to b46872a Compare March 14, 2025 12:39

JackJPowell added 5 commits May 31, 2025 00:53

Merge remote-tracking branch 'upstream/dev' into PlayStationNetwork

b578d73

Updated tests

e2d2d9b

Suggested changes

aff17f9

Merge remote-tracking branch 'upstream/dev' into PlayStationNetwork

4a2ccd2

Fix test

e7c165f

This comment was marked as resolved.

Sign in to view

Merge remote-tracking branch 'upstream/dev' into PlayStationNetwork

49ca5d5

JackJPowell force-pushed the PlayStationNetwork branch from e7c165f to 0ba59ae Compare June 7, 2025 20:14

joostlek requested changes Jun 8, 2025

View reviewed changes

home-assistant bot marked this pull request as draft June 8, 2025 12:43

JackJPowell added 3 commits June 8, 2025 13:42

Merge remote-tracking branch 'upstream/dev' into PlayStationNetwork

c5dc305

Suggested changes

0d692b1

Suggested changes

a0a478c

JackJPowell force-pushed the PlayStationNetwork branch from 0ba59ae to a0a478c Compare June 8, 2025 14:05

JackJPowell marked this pull request as ready for review June 8, 2025 14:18

home-assistant bot requested review from joostlek and tr4nt0r June 8, 2025 14:18

joostlek requested changes Jun 12, 2025

View reviewed changes

home-assistant bot marked this pull request as draft June 12, 2025 14:52

JackJPowell added 3 commits June 13, 2025 14:08

Merge remote-tracking branch 'upstream/dev' into PlayStationNetwork

5874f01

Update config_flow tests

5c90091

Group remaining api call in single executor

42214cf

JackJPowell marked this pull request as ready for review June 13, 2025 14:53

home-assistant bot requested a review from joostlek June 13, 2025 14:53

joostlek approved these changes Jun 23, 2025

View reviewed changes

Merge branch 'dev' into PlayStationNetwork

35e4e71

joostlek merged commit c671ff3 into home-assistant:dev Jun 23, 2025
48 checks passed

NoRi2909 reviewed Jun 24, 2025

View reviewed changes

github-actions bot locked and limited conversation to collaborators Jun 25, 2025

		if not SUPPORTED_PLATFORMS - devices_added:
		remove_listener()

Uh oh!

Add PlayStation Network Integration #133901

Add PlayStation Network Integration #133901

Uh oh!

Conversation

JackJPowell commented Dec 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Updates

Checklist

Uh oh!

joostlek commented Dec 23, 2024

Uh oh!

JackJPowell commented Dec 24, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

home-assistant bot commented Jan 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bieniu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joostlek left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NoRi2909 Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

JackJPowell commented Dec 23, 2024 •

edited

Loading

joostlek left a comment •

edited

Loading

NoRi2909 Jun 24, 2025 •

edited

Loading