Add In party sensor to Xbox integration (home-assistant#155967)

Author: tr4nt0r

homeassistant/components/xbox/icons.json

@@ -29,6 +29,19 @@
       "gamer_score": {
         "default": "mdi:alpha-g-circle"
       },
+      "in_party": {
+        "default": "mdi:headset",
+        "state": {
+          "0": "mdi:headset-off"
+        }
+      },
+      "join_restrictions": {
+        "default": "mdi:account-voice-off",
+        "state": {
+          "invite_only": "mdi:email-newsletter",
+          "joinable": "mdi:account-multiple-plus-outline"
+        }
+      },
       "last_online": {
         "default": "mdi:account-clock"
       },

homeassistant/components/xbox/sensor.py

@@ -24,6 +24,11 @@
 from .coordinator import XboxConfigEntry
 from .entity import XboxBaseEntity, XboxBaseEntityDescription, check_deprecated_entity
 
+MAP_JOIN_RESTRICTIONS = {
+    "local": "invite_only",
+    "followed": "joinable",
+}
+
 
 class XboxSensor(StrEnum):
     """Xbox sensor."""
@@ -37,6 +42,8 @@ class XboxSensor(StrEnum):
     FOLLOWER = "follower"
     NOW_PLAYING = "now_playing"
     FRIENDS = "friends"
+    IN_PARTY = "in_party"
+    JOIN_RESTRICTIONS = "join_restrictions"
 
 
 @dataclass(kw_only=True, frozen=True)
@@ -95,6 +102,18 @@ def now_playing_attributes(_: Person, title: Title | None) -> dict[str, Any]:
     return attributes
 
 
+def join_restrictions(person: Person, _: Title | None = None) -> str | None:
+    """Join restrictions for current party the user is in."""
+
+    return (
+        MAP_JOIN_RESTRICTIONS.get(
+            person.multiplayer_summary.party_details[0].join_restriction
+        )
+        if person.multiplayer_summary and person.multiplayer_summary.party_details
+        else None
+    )
+
+
 def title_logo(_: Person, title: Title | None) -> str | None:
     """Get the game logo."""
 
@@ -159,6 +178,22 @@ def title_logo(_: Person, title: Title | None) -> str | None:
         translation_key=XboxSensor.FRIENDS,
         value_fn=lambda x, _: x.detail.friend_count if x.detail else None,
     ),
+    XboxSensorEntityDescription(
+        key=XboxSensor.IN_PARTY,
+        translation_key=XboxSensor.IN_PARTY,
+        value_fn=(
+            lambda x, _: x.multiplayer_summary.in_party
+            if x.multiplayer_summary
+            else None
+        ),
+    ),
+    XboxSensorEntityDescription(
+        key=XboxSensor.JOIN_RESTRICTIONS,
+        translation_key=XboxSensor.JOIN_RESTRICTIONS,
+        value_fn=join_restrictions,
+        device_class=SensorDeviceClass.ENUM,
+        options=list(MAP_JOIN_RESTRICTIONS.values()),
+    ),
 )
 
 

homeassistant/components/xbox/strings.json

@@ -73,6 +73,17 @@
         "name": "Gamerscore",
         "unit_of_measurement": "points"
       },
+      "in_party": {
+        "name": "In party",
+        "unit_of_measurement": "[%key:component::xbox::entity::sensor::following::unit_of_measurement%]"
+      },
+      "join_restrictions": {
+        "name": "Party join restrictions",
+        "state": {
+          "invite_only": "Invite-only",
+          "joinable": "Joinable"
+        }
+      },
       "last_online": {
         "name": "Last online"
       },

tests/components/xbox/fixtures/people_batch.json

@@ -33,8 +33,21 @@
       "search": null,
       "titleHistory": null,
       "multiplayerSummary": {
-        "inMultiplayerSession": 0,
-        "inParty": 0
+        "joinableActivities": [],
+        "partyDetails": [
+          {
+            "sessionRef": {
+              "scid": "7ffcfe63-a320-4086-85bb-a1734bef7a30",
+              "templateName": "chat",
+              "name": "d3804c40-ac93-4c7d-9414-6cb419931105"
+            },
+            "status": "active",
+            "visibility": "open",
+            "joinRestriction": "followed",
+            "accepted": 2
+          }
+        ],
+        "inParty": 2
       },
       "recentPlayer": null,
       "follower": null,