evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add SwitchBee Integration (#70201)

Browse source 
* Add SwitchBee Integration

* fixes

* improved API and more logs

* fixed test_config_flow code

* removed light and cover

* Fixed CR comments, updated pylib, improved response time and lowered the scan interval for lower latency

* CR fixes, added advanced setup form to let the
user choose the following:
    - scan interval in seconds: default 5
    - whether to expose scenarios and group switches from the CU or not

* used SCAN_INTERVAL_SEC instead of typing just the number

* Fixed PR comments, added unit tests

* fixes

* Improved the pypi and updated the code accordingly

* Add SwitchBee Integration

* fixes

* improved API and more logs

* fixed test_config_flow code

* removed light and cover

* Fixed CR comments, updated pylib, improved response time and lowered the scan interval for lower latency

* CR fixes, added advanced setup form to let the
user choose the following:
    - scan interval in seconds: default 5
    - whether to expose scenarios and group switches from the CU or not

* used SCAN_INTERVAL_SEC instead of typing just the number

* Fixed PR comments, added unit tests

* fixes

* Improved the pypi and updated the code accordingly

* fixes

* restored new line in .coveragerc

* test: increased config_flow test coverage

* removed two way type

* Updated CODEOWNERS

* fix: code review comments

* fixed review comments

* added device_info

* moved device info to attribute
This commit is contained in:
jafar-atili 2022-09-13 10:01:29 +03:00 • committed by GitHub
parent 4e32bf2ac9
commit 24266f1426
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 868 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

141
homeassistant/components/switchbee/switch.py Normal file
View file

@ -0,0 +1,141 @@
"""Support for SwitchBee switch."""
import logging
from typing import Any
from switchbee import SWITCHBEE_BRAND
from switchbee.api import SwitchBeeDeviceOfflineError, SwitchBeeError
from switchbee.device import ApiStateCommand, DeviceType, SwitchBeeBaseDevice
from homeassistant.components.switch import SwitchEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import aiohttp_client
from homeassistant.helpers.entity import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from . import SwitchBeeCoordinator
from .const import DOMAIN
_LOGGER = logging.getLogger(__name__)
async def async_setup_entry(
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
"""Set up Switchbee switch."""
coordinator: SwitchBeeCoordinator = hass.data[DOMAIN][entry.entry_id]
device_types = (
[DeviceType.TimedPowerSwitch]
if coordinator.switch_as_light
else [
DeviceType.TimedPowerSwitch,
DeviceType.GroupSwitch,
DeviceType.Switch,
DeviceType.TimedSwitch,
DeviceType.TwoWay,
]
)
async_add_entities(
Device(hass, device, coordinator)
for device in coordinator.data.values()
if device.type in device_types
)
class Device(CoordinatorEntity, SwitchEntity):
"""Representation of an Switchbee switch."""
def __init__(self, hass, device: SwitchBeeBaseDevice, coordinator):
"""Initialize the Switchbee switch."""
super().__init__(coordinator)
self._session = aiohttp_client.async_get_clientsession(hass)
self._attr_name = f"{device.name}"
self._device_id = device.id
self._attr_unique_id = f"{coordinator.mac_formated}-{device.id}"
self._attr_is_on = False
self._attr_available = True
self._attr_has_entity_name = True
self._device = device
self._attr_device_info = DeviceInfo(
name=f"SwitchBee_{str(device.unit_id)}",
identifiers={
(
DOMAIN,
f"{str(device.unit_id)}-{coordinator.mac_formated}",
)
},
manufacturer=SWITCHBEE_BRAND,
model=coordinator.api.module_display(device.unit_id),
suggested_area=device.zone,
via_device=(
DOMAIN,
f"{coordinator.api.name} ({coordinator.api.mac})",
),
)
@callback
def _handle_coordinator_update(self) -> None:
"""Handle updated data from the coordinator."""
async def async_refresh_state():
try:
await self.coordinator.api.set_state(self._device_id, "dummy")
except SwitchBeeDeviceOfflineError:
return
except SwitchBeeError:
return
if self.coordinator.data[self._device_id].state == -1:
# This specific call will refresh the state of the device in the CU
self.hass.async_create_task(async_refresh_state())
if self.available:
_LOGGER.error(
"%s switch is not responding, check the status in the SwitchBee mobile app",
self.name,
)
self._attr_available = False
self.async_write_ha_state()
return None
if not self.available:
_LOGGER.info(
"%s switch is now responding",
self.name,
)
self._attr_available = True
# timed power switch state will represent a number of minutes until it goes off
# regulare switches state is ON/OFF
self._attr_is_on = (
self.coordinator.data[self._device_id].state != ApiStateCommand.OFF
)
super()._handle_coordinator_update()
async def async_added_to_hass(self) -> None:
"""When entity is added to hass."""
await super().async_added_to_hass()
self._handle_coordinator_update()
async def async_turn_on(self, **kwargs: Any) -> None:
"""Async function to set on to switch."""
return await self._async_set_state(ApiStateCommand.ON)
async def async_turn_off(self, **kwargs: Any) -> None:
"""Async function to set off to switch."""
return await self._async_set_state(ApiStateCommand.OFF)
async def _async_set_state(self, state):
try:
await self.coordinator.api.set_state(self._device_id, state)
except (SwitchBeeError, SwitchBeeDeviceOfflineError) as exp:
_LOGGER.error(
"Failed to set %s state %s, error: %s", self._attr_name, state, exp
)
self._async_write_ha_state()
else:
await self.coordinator.async_refresh()