Add switch platform to bosch_shc integration (#62315)

* Add support for switch platform.

* Add untested files to .coveragerc.

* Differ between Light Switch and Smart Plug.
Bumped to boschshcpy==0.2.27

* Removed duplicated code.
Fixed suggestions from code review.

* Fixed pylint errors

* Fix pylint issue.

* Add property statement

* Fixed wrong attribute access

* Apply suggestions from code review

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Move switch function to base class.
Changes from code review.

* Apply suggestions from code review

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Merged camera switch into SHCSwitch class

* Type hint

* Removed deprecated sensor entities in switch device.
Added routing switch entity.

* Apply suggestions from code review

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Icon and EntityCategory as class attributes

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>
This commit is contained in:
Thomas Schamm 2022-03-08 10:35:29 +01:00 committed by GitHub
parent bfe94f1cc5
commit 0b7b1baf30
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 261 additions and 1 deletions

View file

@ -129,6 +129,7 @@ omit =
homeassistant/components/bosch_shc/cover.py
homeassistant/components/bosch_shc/entity.py
homeassistant/components/bosch_shc/sensor.py
homeassistant/components/bosch_shc/switch.py
homeassistant/components/braviatv/__init__.py
homeassistant/components/braviatv/const.py
homeassistant/components/braviatv/media_player.py

View file

@ -19,7 +19,7 @@ from .const import (
DOMAIN,
)
PLATFORMS = [Platform.BINARY_SENSOR, Platform.COVER, Platform.SENSOR]
PLATFORMS = [Platform.BINARY_SENSOR, Platform.COVER, Platform.SENSOR, Platform.SWITCH]
_LOGGER = logging.getLogger(__name__)

View file

@ -145,6 +145,13 @@ async def async_setup_entry(
entry_id=config_entry.entry_id,
)
)
entities.append(
CommunicationQualitySensor(
device=sensor,
parent_id=session.information.unique_id,
entry_id=config_entry.entry_id,
)
)
if entities:
async_add_entities(entities)
@ -241,6 +248,23 @@ class TemperatureRatingSensor(SHCEntity, SensorEntity):
return self._device.temperature_rating.name
class CommunicationQualitySensor(SHCEntity, SensorEntity):
"""Representation of an SHC communication quality reporting sensor."""
_attr_icon = "mdi:wifi"
def __init__(self, device: SHCDevice, parent_id: str, entry_id: str) -> None:
"""Initialize an SHC communication quality reporting sensor."""
super().__init__(device, parent_id, entry_id)
self._attr_name = f"{device.name} Communication Quality"
self._attr_unique_id = f"{device.serial}_communication_quality"
@property
def native_value(self):
"""Return the state of the sensor."""
return self._device.communicationquality.name
class HumidityRatingSensor(SHCEntity, SensorEntity):
"""Representation of an SHC humidity rating sensor."""

View file

@ -0,0 +1,235 @@
"""Platform for switch integration."""
from __future__ import annotations
from dataclasses import dataclass
from boschshcpy import (
SHCCamera360,
SHCCameraEyes,
SHCLightSwitch,
SHCSession,
SHCSmartPlug,
SHCSmartPlugCompact,
)
from boschshcpy.device import SHCDevice
from homeassistant.components.switch import (
SwitchDeviceClass,
SwitchEntity,
SwitchEntityDescription,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity import EntityCategory
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import StateType
from .const import DATA_SESSION, DOMAIN
from .entity import SHCEntity
@dataclass
class SHCSwitchRequiredKeysMixin:
"""Mixin for SHC switch required keys."""
on_key: str
on_value: StateType
should_poll: bool
@dataclass
class SHCSwitchEntityDescription(
SwitchEntityDescription,
SHCSwitchRequiredKeysMixin,
):
"""Class describing SHC switch entities."""
SWITCH_TYPES: dict[str, SHCSwitchEntityDescription] = {
"smartplug": SHCSwitchEntityDescription(
key="smartplug",
device_class=SwitchDeviceClass.OUTLET,
on_key="state",
on_value=SHCSmartPlug.PowerSwitchService.State.ON,
should_poll=False,
),
"smartplugcompact": SHCSwitchEntityDescription(
key="smartplugcompact",
device_class=SwitchDeviceClass.OUTLET,
on_key="state",
on_value=SHCSmartPlugCompact.PowerSwitchService.State.ON,
should_poll=False,
),
"lightswitch": SHCSwitchEntityDescription(
key="lightswitch",
device_class=SwitchDeviceClass.SWITCH,
on_key="state",
on_value=SHCLightSwitch.PowerSwitchService.State.ON,
should_poll=False,
),
"cameraeyes": SHCSwitchEntityDescription(
key="cameraeyes",
device_class=SwitchDeviceClass.SWITCH,
on_key="cameralight",
on_value=SHCCameraEyes.CameraLightService.State.ON,
should_poll=True,
),
"camera360": SHCSwitchEntityDescription(
key="camera360",
device_class=SwitchDeviceClass.SWITCH,
on_key="privacymode",
on_value=SHCCamera360.PrivacyModeService.State.DISABLED,
should_poll=True,
),
}
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the SHC switch platform."""
entities: list[SwitchEntity] = []
session: SHCSession = hass.data[DOMAIN][config_entry.entry_id][DATA_SESSION]
for switch in session.device_helper.smart_plugs:
entities.append(
SHCSwitch(
device=switch,
parent_id=session.information.unique_id,
entry_id=config_entry.entry_id,
description=SWITCH_TYPES["smartplug"],
)
)
entities.append(
SHCRoutingSwitch(
device=switch,
parent_id=session.information.unique_id,
entry_id=config_entry.entry_id,
)
)
for switch in session.device_helper.light_switches:
entities.append(
SHCSwitch(
device=switch,
parent_id=session.information.unique_id,
entry_id=config_entry.entry_id,
description=SWITCH_TYPES["lightswitch"],
)
)
for switch in session.device_helper.smart_plugs_compact:
entities.append(
SHCSwitch(
device=switch,
parent_id=session.information.unique_id,
entry_id=config_entry.entry_id,
description=SWITCH_TYPES["smartplugcompact"],
)
)
for switch in session.device_helper.camera_eyes:
entities.append(
SHCSwitch(
device=switch,
parent_id=session.information.unique_id,
entry_id=config_entry.entry_id,
description=SWITCH_TYPES["cameraeyes"],
)
)
for switch in session.device_helper.camera_360:
entities.append(
SHCSwitch(
device=switch,
parent_id=session.information.unique_id,
entry_id=config_entry.entry_id,
description=SWITCH_TYPES["camera360"],
)
)
if entities:
async_add_entities(entities)
class SHCSwitch(SHCEntity, SwitchEntity):
"""Representation of a SHC switch."""
entity_description: SHCSwitchEntityDescription
def __init__(
self,
device: SHCDevice,
parent_id: str,
entry_id: str,
description: SHCSwitchEntityDescription,
) -> None:
"""Initialize a SHC switch."""
super().__init__(device, parent_id, entry_id)
self.entity_description = description
@property
def is_on(self) -> bool:
"""Return the state of the switch."""
return (
getattr(self._device, self.entity_description.on_key)
== self.entity_description.on_value
)
def turn_on(self, **kwargs) -> None:
"""Turn the switch on."""
setattr(self._device, self.entity_description.on_key, True)
def turn_off(self, **kwargs) -> None:
"""Turn the switch off."""
setattr(self._device, self.entity_description.on_key, False)
def toggle(self, **kwargs) -> None:
"""Toggle the switch."""
setattr(self._device, self.entity_description.on_key, not self.is_on)
@property
def should_poll(self) -> bool:
"""Switch needs polling."""
return self.entity_description.should_poll
def update(self) -> None:
"""Trigger an update of the device."""
self._device.update()
class SHCRoutingSwitch(SHCEntity, SwitchEntity):
"""Representation of a SHC routing switch."""
_attr_icon = "mdi:wifi"
_attr_entity_category = EntityCategory.CONFIG
def __init__(self, device: SHCDevice, parent_id: str, entry_id: str) -> None:
"""Initialize an SHC communication quality reporting sensor."""
super().__init__(device, parent_id, entry_id)
self._attr_name = f"{device.name} Routing"
self._attr_unique_id = f"{device.serial}_routing"
@property
def is_on(self) -> bool:
"""Return the state of the switch."""
return self._device.routing.name == "ENABLED"
def turn_on(self, **kwargs) -> None:
"""Turn the switch on."""
self._device.routing = True
def turn_off(self, **kwargs) -> None:
"""Turn the switch off."""
self._device.routing = False
def toggle(self, **kwargs) -> None:
"""Toggle the switch."""
self._device.routing = not self.is_on