Add sensor platform for AccuWeather integration (#38312)

* Add sensor platform

* Fix typo

homeassistant/components/accuweather/sensor.py

@@ -0,0 +1,177 @@
+"""Support for the AccuWeather service."""
+from homeassistant.const import (
+    ATTR_ATTRIBUTION,
+    ATTR_DEVICE_CLASS,
+    CONF_NAME,
+    DEVICE_CLASS_TEMPERATURE,
+)
+from homeassistant.helpers.entity import Entity
+
+from .const import (
+    ATTR_FORECAST,
+    ATTR_ICON,
+    ATTR_LABEL,
+    ATTRIBUTION,
+    COORDINATOR,
+    DOMAIN,
+    FORECAST_DAYS,
+    FORECAST_SENSOR_TYPES,
+    OPTIONAL_SENSORS,
+    SENSOR_TYPES,
+)
+
+PARALLEL_UPDATES = 1
+
+
+async def async_setup_entry(hass, config_entry, async_add_entities):
+    """Add AccuWeather entities from a config_entry."""
+    name = config_entry.data[CONF_NAME]
+
+    coordinator = hass.data[DOMAIN][config_entry.entry_id][COORDINATOR]
+
+    sensors = []
+    for sensor in SENSOR_TYPES:
+        sensors.append(AccuWeatherSensor(name, sensor, coordinator))
+
+    if coordinator.forecast:
+        for sensor in FORECAST_SENSOR_TYPES:
+            for day in FORECAST_DAYS:
+                # Some air quality/allergy sensors are only available for certain
+                # locations.
+                if sensor in coordinator.data[ATTR_FORECAST][0]:
+                    sensors.append(
+                        AccuWeatherSensor(name, sensor, coordinator, forecast_day=day)
+                    )
+
+    async_add_entities(sensors, False)
+
+
+class AccuWeatherSensor(Entity):
+    """Define an AccuWeather entity."""
+
+    def __init__(self, name, kind, coordinator, forecast_day=None):
+        """Initialize."""
+        self._name = name
+        self.kind = kind
+        self.coordinator = coordinator
+        self._device_class = None
+        self._attrs = {ATTR_ATTRIBUTION: ATTRIBUTION}
+        self._unit_system = "Metric" if self.coordinator.is_metric else "Imperial"
+        self.forecast_day = forecast_day
+
+    @property
+    def name(self):
+        """Return the name."""
+        if self.forecast_day is not None:
+            return f"{self._name} {FORECAST_SENSOR_TYPES[self.kind][ATTR_LABEL]} {self.forecast_day}d"
+        return f"{self._name} {SENSOR_TYPES[self.kind][ATTR_LABEL]}"
+
+    @property
+    def unique_id(self):
+        """Return a unique_id for this entity."""
+        if self.forecast_day is not None:
+            return f"{self.coordinator.location_key}-{self.kind}-{self.forecast_day}".lower()
+        return f"{self.coordinator.location_key}-{self.kind}".lower()
+
+    @property
+    def should_poll(self):
+        """Return the polling requirement of the entity."""
+        return False
+
+    @property
+    def available(self):
+        """Return True if entity is available."""
+        return self.coordinator.last_update_success
+
+    @property
+    def state(self):
+        """Return the state."""
+        if self.forecast_day is not None:
+            if (
+                FORECAST_SENSOR_TYPES[self.kind][ATTR_DEVICE_CLASS]
+                == DEVICE_CLASS_TEMPERATURE
+            ):
+                return self.coordinator.data[ATTR_FORECAST][self.forecast_day][
+                    self.kind
+                ]["Value"]
+            if self.kind in ["WindGustDay", "WindGustNight"]:
+                return self.coordinator.data[ATTR_FORECAST][self.forecast_day][
+                    self.kind
+                ]["Speed"]["Value"]
+            if self.kind in ["Grass", "Mold", "Ragweed", "Tree", "UVIndex", "Ozone"]:
+                return self.coordinator.data[ATTR_FORECAST][self.forecast_day][
+                    self.kind
+                ]["Value"]
+            return self.coordinator.data[ATTR_FORECAST][self.forecast_day][self.kind]
+        if self.kind == "Ceiling":
+            return round(self.coordinator.data[self.kind][self._unit_system]["Value"])
+        if self.kind == "PressureTendency":
+            return self.coordinator.data[self.kind]["LocalizedText"].lower()
+        if SENSOR_TYPES[self.kind][ATTR_DEVICE_CLASS] == DEVICE_CLASS_TEMPERATURE:
+            return self.coordinator.data[self.kind][self._unit_system]["Value"]
+        if self.kind == "Precipitation":
+            return self.coordinator.data["PrecipitationSummary"][self.kind][
+                self._unit_system
+            ]["Value"]
+        if self.kind == "WindGust":
+            return self.coordinator.data[self.kind]["Speed"][self._unit_system]["Value"]
+        return self.coordinator.data[self.kind]
+
+    @property
+    def icon(self):
+        """Return the icon."""
+        if self.forecast_day is not None:
+            return FORECAST_SENSOR_TYPES[self.kind][ATTR_ICON]
+        return SENSOR_TYPES[self.kind][ATTR_ICON]
+
+    @property
+    def device_class(self):
+        """Return the device_class."""
+        if self.forecast_day is not None:
+            return FORECAST_SENSOR_TYPES[self.kind][ATTR_DEVICE_CLASS]
+        return SENSOR_TYPES[self.kind][ATTR_DEVICE_CLASS]
+
+    @property
+    def unit_of_measurement(self):
+        """Return the unit the value is expressed in."""
+        if self.forecast_day is not None:
+            return FORECAST_SENSOR_TYPES[self.kind][self._unit_system]
+        return SENSOR_TYPES[self.kind][self._unit_system]
+
+    @property
+    def device_state_attributes(self):
+        """Return the state attributes."""
+        if self.forecast_day is not None:
+            if self.kind == "WindGustDay":
+                self._attrs["direction"] = self.coordinator.data[ATTR_FORECAST][
+                    self.forecast_day
+                ][self.kind]["Direction"]["English"]
+            elif self.kind == "WindGustNight":
+                self._attrs["direction"] = self.coordinator.data[ATTR_FORECAST][
+                    self.forecast_day
+                ][self.kind]["Direction"]["English"]
+            elif self.kind in ["Grass", "Mold", "Ragweed", "Tree", "UVIndex", "Ozone"]:
+                self._attrs["level"] = self.coordinator.data[ATTR_FORECAST][
+                    self.forecast_day
+                ][self.kind]["Category"]
+            return self._attrs
+        if self.kind == "UVIndex":
+            self._attrs["level"] = self.coordinator.data["UVIndexText"]
+        elif self.kind == "Precipitation":
+            self._attrs["type"] = self.coordinator.data["PrecipitationType"]
+        return self._attrs
+
+    @property
+    def entity_registry_enabled_default(self):
+        """Return if the entity should be enabled when first added to the entity registry."""
+        return bool(self.kind not in OPTIONAL_SENSORS)
+
+    async def async_added_to_hass(self):
+        """Connect to dispatcher listening for entity data notifications."""
+        self.async_on_remove(
+            self.coordinator.async_add_listener(self.async_write_ha_state)
+        )
+
+    async def async_update(self):
+        """Update AccuWeather entity."""
+        await self.coordinator.async_request_refresh()