switch.py

Go to the documentation of this file.

"""Support for Freebox Delta, Revolution and Mini 4K."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
from freebox_api.exceptions import InsufficientPermissionsError
 
from homeassistant.components.switch import SwitchEntity, SwitchEntityDescription
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import DOMAIN
from .router import FreeboxRouter
 
_LOGGER = logging.getLogger(__name__)
 
 
SWITCH_DESCRIPTIONS = [
    SwitchEntityDescription(
        key="wifi",
        name="Freebox WiFi",
        entity_category=EntityCategory.CONFIG,
    )
]
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up the switch."""
    router: FreeboxRouter = hass.data[DOMAIN][entry.unique_id]
    entities = [
        FreeboxSwitch(router, entity_description)
        for entity_description in SWITCH_DESCRIPTIONS
    ]
    async_add_entities(entities, True)
 
 
class FreeboxSwitch(SwitchEntity):
    """Representation of a freebox switch."""
 
    def __init__(
        self, router: FreeboxRouter, entity_description: SwitchEntityDescription
    ) -> None:
        """Initialize the switch."""
        self.entity_descriptionentity_description = entity_description
        self._router_router = router
        self._attr_device_info_attr_device_info = router.device_info
        self._attr_unique_id_attr_unique_id = f"{router.mac} {entity_description.name}"
 
    async def _async_set_state(self, enabled: bool) -> None:
        """Turn the switch on or off."""
        try:
            await self._router_router.wifi.set_global_config({"enabled": enabled})
        except InsufficientPermissionsError:
            _LOGGER.warning(
                "Home Assistant does not have permissions to modify the Freebox"
                " settings. Please refer to documentation"
            )
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the switch on."""
        await self._async_set_state_async_set_state(True)
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the switch off."""
        await self._async_set_state_async_set_state(False)
 
    async def async_update(self) -> None:
        """Get the state and update it."""
        data = await self._router_router.wifi.get_global_config()
        self._attr_is_on_attr_is_on = bool(data["enabled"])