diff --git a/homeassistant/components/sun/__init__.py b/homeassistant/components/sun/__init__.py index f42f5450462..0faa1db379d 100644 --- a/homeassistant/components/sun/__init__.py +++ b/homeassistant/components/sun/__init__.py @@ -16,7 +16,10 @@ from homeassistant.helpers.typing import ConfigType # as we will always load it and we do not want to have # to wait for the import executor when its busy later # in the startup process. -from . import sensor as sensor_pre_import # noqa: F401 +from . import ( + binary_sensor as binary_sensor_pre_import, # noqa: F401 + sensor as sensor_pre_import, # noqa: F401 +) from .const import ( # noqa: F401 # noqa: F401 DOMAIN, STATE_ABOVE_HORIZON, @@ -24,6 +27,8 @@ from .const import ( # noqa: F401 # noqa: F401 ) from .entity import Sun, SunConfigEntry +PLATFORMS = [Platform.BINARY_SENSOR, Platform.SENSOR] + CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN) _LOGGER = logging.getLogger(__name__) @@ -52,14 +57,12 @@ async def async_setup_entry(hass: HomeAssistant, entry: SunConfigEntry) -> bool: await component.async_add_entities([sun]) entry.runtime_data = sun entry.async_on_unload(sun.remove_listeners) - await hass.config_entries.async_forward_entry_setups(entry, [Platform.SENSOR]) + await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS) return True async def async_unload_entry(hass: HomeAssistant, entry: SunConfigEntry) -> bool: """Unload a config entry.""" - if unload_ok := await hass.config_entries.async_unload_platforms( - entry, [Platform.SENSOR] - ): + if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS): await entry.runtime_data.async_remove() return unload_ok diff --git a/homeassistant/components/sun/binary_sensor.py b/homeassistant/components/sun/binary_sensor.py new file mode 100644 index 00000000000..962a385191c --- /dev/null +++ b/homeassistant/components/sun/binary_sensor.py @@ -0,0 +1,100 @@ +"""Binary Sensor platform for Sun integration.""" + +from __future__ import annotations + +from collections.abc import Callable +from dataclasses import dataclass + +from homeassistant.components.binary_sensor import ( + DOMAIN as BINARY_SENSOR_DOMAIN, + BinarySensorEntity, + BinarySensorEntityDescription, +) +from homeassistant.const import EntityCategory +from homeassistant.core import HomeAssistant +from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo +from homeassistant.helpers.dispatcher import async_dispatcher_connect +from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback + +from .const import DOMAIN, SIGNAL_EVENTS_CHANGED +from .entity import Sun, SunConfigEntry + +ENTITY_ID_BINARY_SENSOR_FORMAT = BINARY_SENSOR_DOMAIN + ".sun_{}" + + +@dataclass(kw_only=True, frozen=True) +class SunBinarySensorEntityDescription(BinarySensorEntityDescription): + """Describes a Sun binary sensor entity.""" + + value_fn: Callable[[Sun], bool | None] + signal: str + + +BINARY_SENSOR_TYPES: tuple[SunBinarySensorEntityDescription, ...] = ( + SunBinarySensorEntityDescription( + key="solar_rising", + translation_key="solar_rising", + value_fn=lambda data: data.rising, + entity_registry_enabled_default=False, + signal=SIGNAL_EVENTS_CHANGED, + ), +) + + +async def async_setup_entry( + hass: HomeAssistant, + entry: SunConfigEntry, + async_add_entities: AddConfigEntryEntitiesCallback, +) -> None: + """Set up Sun binary sensor platform.""" + + sun = entry.runtime_data + + async_add_entities( + [ + SunBinarySensor(sun, description, entry.entry_id) + for description in BINARY_SENSOR_TYPES + ] + ) + + +class SunBinarySensor(BinarySensorEntity): + """Representation of a Sun binary sensor.""" + + _attr_has_entity_name = True + _attr_should_poll = False + _attr_entity_category = EntityCategory.DIAGNOSTIC + entity_description: SunBinarySensorEntityDescription + + def __init__( + self, + sun: Sun, + entity_description: SunBinarySensorEntityDescription, + entry_id: str, + ) -> None: + """Initiate Sun Binary Sensor.""" + self.entity_description = entity_description + self.entity_id = ENTITY_ID_BINARY_SENSOR_FORMAT.format(entity_description.key) + self._attr_unique_id = f"{entry_id}-{entity_description.key}" + self.sun = sun + self._attr_device_info = DeviceInfo( + name="Sun", + identifiers={(DOMAIN, entry_id)}, + entry_type=DeviceEntryType.SERVICE, + ) + + @property + def is_on(self) -> bool | None: + """Return value of binary sensor.""" + return self.entity_description.value_fn(self.sun) + + async def async_added_to_hass(self) -> None: + """Register signal listener when added to hass.""" + await super().async_added_to_hass() + self.async_on_remove( + async_dispatcher_connect( + self.hass, + self.entity_description.signal, + self.async_write_ha_state, + ) + ) diff --git a/homeassistant/components/sun/icons.json b/homeassistant/components/sun/icons.json index 9d903fd7b8e..1fee6beba3a 100644 --- a/homeassistant/components/sun/icons.json +++ b/homeassistant/components/sun/icons.json @@ -28,6 +28,15 @@ "solar_rising": { "default": "mdi:sun-clock" } + }, + "binary_sensor": { + "solar_rising": { + "default": "mdi:weather-sunny-off", + "state": { + "on": "mdi:weather-sunset-up", + "off": "mdi:weather-sunset-down" + } + } } } } diff --git a/homeassistant/components/sun/strings.json b/homeassistant/components/sun/strings.json index 7c7accd8cc6..14f612b7b50 100644 --- a/homeassistant/components/sun/strings.json +++ b/homeassistant/components/sun/strings.json @@ -27,6 +27,15 @@ "solar_azimuth": { "name": "Solar azimuth" }, "solar_elevation": { "name": "Solar elevation" }, "solar_rising": { "name": "Solar rising" } + }, + "binary_sensor": { + "solar_rising": { + "name": "Solar rising", + "state": { + "on": "Rising", + "off": "Setting" + } + } } } } diff --git a/tests/components/sun/test_binary_sensor.py b/tests/components/sun/test_binary_sensor.py new file mode 100644 index 00000000000..3f8bb75c567 --- /dev/null +++ b/tests/components/sun/test_binary_sensor.py @@ -0,0 +1,44 @@ +"""The tests for the Sun binary_sensor platform.""" + +from datetime import datetime, timedelta + +from freezegun.api import FrozenDateTimeFactory +import pytest + +from homeassistant.components import sun +from homeassistant.const import EntityCategory +from homeassistant.core import HomeAssistant +from homeassistant.helpers import entity_registry as er +from homeassistant.setup import async_setup_component +from homeassistant.util import dt as dt_util + + +@pytest.mark.usefixtures("entity_registry_enabled_by_default") +async def test_setting_rising( + hass: HomeAssistant, + entity_registry: er.EntityRegistry, + freezer: FrozenDateTimeFactory, +) -> None: + """Test retrieving sun setting and rising.""" + utc_now = datetime(2016, 11, 1, 8, 0, 0, tzinfo=dt_util.UTC) + freezer.move_to(utc_now) + await async_setup_component(hass, sun.DOMAIN, {sun.DOMAIN: {}}) + await hass.async_block_till_done() + + assert hass.states.get("binary_sensor.sun_solar_rising").state == "on" + + entry_ids = hass.config_entries.async_entries("sun") + + freezer.tick(timedelta(hours=12)) + # Block once for Sun to update + await hass.async_block_till_done() + # Block another time for the sensors to update + await hass.async_block_till_done() + + # Make sure all the signals work + assert hass.states.get("binary_sensor.sun_solar_rising").state == "off" + + entity = entity_registry.async_get("binary_sensor.sun_solar_rising") + assert entity + assert entity.entity_category is EntityCategory.DIAGNOSTIC + assert entity.unique_id == f"{entry_ids[0].entry_id}-solar_rising"