sensor.py

Go to the documentation of this file.

"""Sensor for Steam account status."""
 
from __future__ import annotations
 
from datetime import datetime
from time import localtime, mktime
from typing import cast
 
from homeassistant.components.sensor import SensorEntity, SensorEntityDescription
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import StateType
from homeassistant.util.dt import utc_from_timestamp
 
from . import SteamConfigEntry
from .const import (
    CONF_ACCOUNTS,
    STEAM_API_URL,
    STEAM_HEADER_IMAGE_FILE,
    STEAM_ICON_URL,
    STEAM_MAIN_IMAGE_FILE,
    STEAM_STATUSES,
)
from .coordinator import SteamDataUpdateCoordinator
from .entity import SteamEntity
 
PARALLEL_UPDATES = 1
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: SteamConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the Steam platform."""
    async_add_entities(
        SteamSensor(entry.runtime_data, account)
        for account in entry.options[CONF_ACCOUNTS]
    )
 
 
class SteamSensor(SteamEntity, SensorEntity):
    """A class for the Steam account."""
 
    def __init__(self, coordinator: SteamDataUpdateCoordinator, account: str) -> None:
        """Initialize the sensor."""
        super().__init__(coordinator)
        self.entity_descriptionentity_description = SensorEntityDescription(
            key=account,
            name=f"steam_{account}",
            icon="mdi:steam",
        )
        self._attr_unique_id_attr_unique_id = f"sensor.steam_{account}"
 
    @property
    def native_value(self) -> StateType:
        """Return the state of the sensor."""
        if self.entity_descriptionentity_description.key in self.coordinator.data:
            player = self.coordinator.data[self.entity_descriptionentity_description.key]
            return STEAM_STATUSES[cast(int, player["personastate"])]
        return None
 
    @property
    def extra_state_attributes(self) -> dict[str, str | int | datetime]:
        """Return the state attributes of the sensor."""
        if self.entity_descriptionentity_description.key not in self.coordinator.data:
            return {}
        player = self.coordinator.data[self.entity_descriptionentity_description.key]
 
        attrs: dict[str, str | int | datetime] = {}
        if game := player.get("gameextrainfo"):
            attrs["game"] = game
        if game_id := player.get("gameid"):
            attrs["game_id"] = game_id
            game_url = f"{STEAM_API_URL}{player['gameid']}/"
            attrs["game_image_header"] = f"{game_url}{STEAM_HEADER_IMAGE_FILE}"
            attrs["game_image_main"] = f"{game_url}{STEAM_MAIN_IMAGE_FILE}"
            if info := self._get_game_icon_get_game_icon(player):
                attrs["game_icon"] = f"{STEAM_ICON_URL}{game_id}/{info}.jpg"
        self._attr_name_attr_name = str(player["personaname"]) or None
        self._attr_entity_picture_attr_entity_picture = str(player["avatarmedium"]) or None
        if last_online := cast(int | None, player.get("lastlogoff")):
            attrs["last_online"] = utc_from_timestamp(mktime(localtime(last_online)))
        if level := self.coordinator.data[self.entity_descriptionentity_description.key]["level"]:
            attrs["level"] = level
        return attrs
 
    def _get_game_icon(self, player: dict) -> str | None:
        """Get game icon identifier."""
        if player.get("gameid") in self.coordinator.game_icons:
            return self.coordinator.game_icons[player["gameid"]]
        # Reset game icons to have coordinator get id for new game
        self.coordinator.game_icons = {}
        return None