core/homeassistant/components/synology_dsm/switch.py

126 lines
4.2 KiB
Python
Raw Normal View History

"""Support for Synology DSM switch."""
2021-03-18 13:31:38 +00:00
from __future__ import annotations
from dataclasses import dataclass
import logging
from typing import Any
from synology_dsm.api.surveillance_station import SynoSurveillanceStation
from homeassistant.components.switch import SwitchEntity, SwitchEntityDescription
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
from . import SynoApi
from .const import DOMAIN
from .entity import SynologyDSMBaseEntity, SynologyDSMEntityDescription
from .models import SynologyDSMData
_LOGGER = logging.getLogger(__name__)
@dataclass
class SynologyDSMSwitchEntityDescription(
SwitchEntityDescription, SynologyDSMEntityDescription
):
"""Describes Synology DSM switch entity."""
SURVEILLANCE_SWITCH: tuple[SynologyDSMSwitchEntityDescription, ...] = (
SynologyDSMSwitchEntityDescription(
api_key=SynoSurveillanceStation.HOME_MODE_API_KEY,
key="home_mode",
name="Home Mode",
icon="mdi:home-account",
),
)
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
"""Set up the Synology NAS switch."""
data: SynologyDSMData = hass.data[DOMAIN][entry.unique_id]
if coordinator := data.coordinator_switches:
assert coordinator.version is not None
async_add_entities(
SynoDSMSurveillanceHomeModeToggle(
data.api, coordinator.version, coordinator, description
)
for description in SURVEILLANCE_SWITCH
)
class SynoDSMSurveillanceHomeModeToggle(SynologyDSMBaseEntity, SwitchEntity):
"""Representation a Synology Surveillance Station Home Mode toggle."""
coordinator: DataUpdateCoordinator[dict[str, dict[str, bool]]]
entity_description: SynologyDSMSwitchEntityDescription
def __init__(
self,
api: SynoApi,
version: str,
coordinator: DataUpdateCoordinator[dict[str, dict[str, bool]]],
description: SynologyDSMSwitchEntityDescription,
) -> None:
"""Initialize a Synology Surveillance Station Home Mode."""
super().__init__(api, coordinator, description)
self._version = version
self._attr_name = (
f"{self._api.network.hostname} Surveillance Station {description.name}"
)
@property
def is_on(self) -> bool:
"""Return the state."""
return self.coordinator.data["switches"][self.entity_description.key]
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on Home mode."""
_LOGGER.debug(
"SynoDSMSurveillanceHomeModeToggle.turn_on(%s)",
self._api.information.serial,
)
await self.hass.async_add_executor_job(
self._api.dsm.surveillance_station.set_home_mode, True
)
await self.coordinator.async_request_refresh()
async def async_turn_off(self, **kwargs: Any) -> None:
"""Turn off Home mode."""
_LOGGER.debug(
"SynoDSMSurveillanceHomeModeToggle.turn_off(%s)",
self._api.information.serial,
)
await self.hass.async_add_executor_job(
self._api.dsm.surveillance_station.set_home_mode, False
)
await self.coordinator.async_request_refresh()
@property
def available(self) -> bool:
"""Return True if entity is available."""
return bool(self._api.surveillance_station)
@property
def device_info(self) -> DeviceInfo:
"""Return the device information."""
return DeviceInfo(
identifiers={
(
DOMAIN,
f"{self._api.information.serial}_{SynoSurveillanceStation.INFO_API_KEY}",
)
},
name=f"{self._api.network.hostname} Surveillance Station",
manufacturer="Synology",
model=self._api.information.model,
sw_version=self._version,
via_device=(DOMAIN, self._api.information.serial),
)