Add more spotify sensors (#129215)

Author: joostlek

homeassistant/components/spotify/icons.json

@@ -4,6 +4,41 @@
       "spotify": {
         "default": "mdi:spotify"
       }
+    },
+    "sensor": {
+      "song_tempo": {
+        "default": "mdi:metronome"
+      },
+      "danceability": {
+        "default": "mdi:dance-ballroom"
+      },
+      "energy": {
+        "default": "mdi:lightning-bolt"
+      },
+      "mode": {
+        "default": "mdi:music"
+      },
+      "speechiness": {
+        "default": "mdi:speaker-message"
+      },
+      "acousticness": {
+        "default": "mdi:guitar-acoustic"
+      },
+      "instrumentalness": {
+        "default": "mdi:guitar-electric"
+      },
+      "valence": {
+        "default": "mdi:emoticon-happy"
+      },
+      "liveness": {
+        "default": "mdi:music-note"
+      },
+      "time_signature": {
+        "default": "mdi:music-clef-treble"
+      },
+      "key": {
+        "default": "mdi:music-clef-treble"
+      }
     }
   }
 }

homeassistant/components/spotify/sensor.py

@@ -5,7 +5,12 @@
 
 from spotifyaio.models import AudioFeatures
 
-from homeassistant.components.sensor import SensorEntity, SensorEntityDescription
+from homeassistant.components.sensor import (
+    SensorDeviceClass,
+    SensorEntity,
+    SensorEntityDescription,
+)
+from homeassistant.const import PERCENTAGE
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
@@ -17,7 +22,17 @@
 class SpotifyAudioFeaturesSensorEntityDescription(SensorEntityDescription):
     """Describes Spotify sensor entity."""
 
-    value_fn: Callable[[AudioFeatures], float]
+    value_fn: Callable[[AudioFeatures], float | str | None]
+
+
+def _get_key(audio_features: AudioFeatures) -> str | None:
+    if audio_features.key is None:
+        return None
+    key_name = audio_features.key.name
+    base = key_name[0]
+    if len(key_name) > 1:
+        base = f"{base}♯"
+    return base
 
 
 AUDIO_FEATURE_SENSORS: tuple[SpotifyAudioFeaturesSensorEntityDescription, ...] = (
@@ -28,6 +43,86 @@ class SpotifyAudioFeaturesSensorEntityDescription(SensorEntityDescription):
         suggested_display_precision=0,
         value_fn=lambda audio_features: audio_features.tempo,
     ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="danceability",
+        translation_key="danceability",
+        native_unit_of_measurement=PERCENTAGE,
+        suggested_display_precision=0,
+        value_fn=lambda audio_features: audio_features.danceability * 100,
+        entity_registry_enabled_default=False,
+    ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="energy",
+        translation_key="energy",
+        native_unit_of_measurement=PERCENTAGE,
+        suggested_display_precision=0,
+        value_fn=lambda audio_features: audio_features.energy * 100,
+        entity_registry_enabled_default=False,
+    ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="mode",
+        translation_key="mode",
+        device_class=SensorDeviceClass.ENUM,
+        options=["major", "minor"],
+        value_fn=lambda audio_features: audio_features.mode.name.lower(),
+        entity_registry_enabled_default=False,
+    ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="speechiness",
+        translation_key="speechiness",
+        native_unit_of_measurement=PERCENTAGE,
+        suggested_display_precision=0,
+        value_fn=lambda audio_features: audio_features.speechiness * 100,
+        entity_registry_enabled_default=False,
+    ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="acousticness",
+        translation_key="acousticness",
+        native_unit_of_measurement=PERCENTAGE,
+        suggested_display_precision=0,
+        value_fn=lambda audio_features: audio_features.acousticness * 100,
+        entity_registry_enabled_default=False,
+    ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="instrumentalness",
+        translation_key="instrumentalness",
+        native_unit_of_measurement=PERCENTAGE,
+        suggested_display_precision=0,
+        value_fn=lambda audio_features: audio_features.instrumentalness * 100,
+        entity_registry_enabled_default=False,
+    ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="liveness",
+        translation_key="liveness",
+        native_unit_of_measurement=PERCENTAGE,
+        suggested_display_precision=0,
+        value_fn=lambda audio_features: audio_features.liveness * 100,
+        entity_registry_enabled_default=False,
+    ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="valence",
+        translation_key="valence",
+        native_unit_of_measurement=PERCENTAGE,
+        suggested_display_precision=0,
+        value_fn=lambda audio_features: audio_features.valence * 100,
+        entity_registry_enabled_default=False,
+    ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="time_signature",
+        translation_key="time_signature",
+        device_class=SensorDeviceClass.ENUM,
+        options=["3/4", "4/4", "5/4", "6/4", "7/4"],
+        value_fn=lambda audio_features: f"{audio_features.time_signature}/4",
+        entity_registry_enabled_default=False,
+    ),
+    SpotifyAudioFeaturesSensorEntityDescription(
+        key="key",
+        translation_key="key",
+        device_class=SensorDeviceClass.ENUM,
+        options=["C", "C♯", "D", "D♯", "E", "F", "F♯", "G", "G♯", "A", "A♯", "B"],
+        value_fn=_get_key,
+        entity_registry_enabled_default=False,
+    ),
 )
 
 
@@ -63,7 +158,7 @@ def __init__(
         self.entity_description = entity_description
 
     @property
-    def native_value(self) -> float | None:
+    def native_value(self) -> float | str | None:
         """Return the state of the sensor."""
         if (audio_features := self.coordinator.data.audio_features) is None:
             return None

homeassistant/components/spotify/strings.json

@@ -35,6 +35,40 @@
     "sensor": {
       "song_tempo": {
         "name": "Song tempo"
+      },
+      "danceability": {
+        "name": "Song danceability"
+      },
+      "energy": {
+        "name": "Song energy"
+      },
+      "mode": {
+        "name": "Song mode",
+        "state": {
+          "minor": "Minor",
+          "major": "Major"
+        }
+      },
+      "speechiness": {
+        "name": "Song speechiness"
+      },
+      "acousticness": {
+        "name": "Song acousticness"
+      },
+      "instrumentalness": {
+        "name": "Song instrumentalness"
+      },
+      "valence": {
+        "name": "Song valence"
+      },
+      "liveness": {
+        "name": "Song liveness"
+      },
+      "time_signature": {
+        "name": "Song time signature"
+      },
+      "key": {
+        "name": "Song key"
       }
     }
   }

tests/components/spotify/fixtures/audio_features.json

@@ -1,7 +1,7 @@
 {
   "danceability": 0.696,
   "energy": 0.905,
-  "key": 2,
+  "key": 3,
   "loudness": -2.743,
   "mode": 1,
   "speechiness": 0.103,

tests/components/spotify/snapshots/test_diagnostics.ambr

@@ -19,7 +19,7 @@
         'danceability': 0.696,
         'energy': 0.905,
         'instrumentalness': 0.000905,
-        'key': 2,
+        'key': 3,
         'liveness': 0.302,
         'loudness': -2.743,
         'mode': 1,