Add type hints to LCN (#52509)
* Add type hints to LCN * Fix requested review changes
This commit is contained in:
parent
b496469a2f
commit
e16ef10af5
13 changed files with 333 additions and 172 deletions
|
@ -1,21 +1,29 @@
|
|||
"""Support for LCN switches."""
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
|
||||
import pypck
|
||||
|
||||
from homeassistant.components.switch import DOMAIN as DOMAIN_SWITCH, SwitchEntity
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.const import CONF_ADDRESS, CONF_DOMAIN, CONF_ENTITIES
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.typing import ConfigType, HomeAssistantType
|
||||
|
||||
from . import LcnEntity
|
||||
from .const import CONF_DOMAIN_DATA, CONF_OUTPUT, OUTPUT_PORTS
|
||||
from .helpers import get_device_connection
|
||||
from .helpers import DeviceConnectionType, InputType, get_device_connection
|
||||
|
||||
PARALLEL_UPDATES = 0
|
||||
|
||||
|
||||
def create_lcn_switch_entity(hass, entity_config, config_entry):
|
||||
def create_lcn_switch_entity(
|
||||
hass: HomeAssistantType, entity_config: ConfigType, config_entry: ConfigEntry
|
||||
) -> LcnEntity:
|
||||
"""Set up an entity for this domain."""
|
||||
device_connection = get_device_connection(
|
||||
hass, tuple(entity_config[CONF_ADDRESS]), config_entry
|
||||
hass, entity_config[CONF_ADDRESS], config_entry
|
||||
)
|
||||
|
||||
if entity_config[CONF_DOMAIN_DATA][CONF_OUTPUT] in OUTPUT_PORTS:
|
||||
|
@ -24,7 +32,11 @@ def create_lcn_switch_entity(hass, entity_config, config_entry):
|
|||
return LcnRelaySwitch(entity_config, config_entry.entry_id, device_connection)
|
||||
|
||||
|
||||
async def async_setup_entry(hass, config_entry, async_add_entities):
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistantType,
|
||||
config_entry: ConfigEntry,
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
) -> None:
|
||||
"""Set up LCN switch entities from a config entry."""
|
||||
|
||||
entities = []
|
||||
|
@ -39,46 +51,48 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
|
|||
class LcnOutputSwitch(LcnEntity, SwitchEntity):
|
||||
"""Representation of a LCN switch for output ports."""
|
||||
|
||||
def __init__(self, config, entry_id, device_connection):
|
||||
def __init__(
|
||||
self, config: ConfigType, entry_id: str, device_connection: DeviceConnectionType
|
||||
) -> None:
|
||||
"""Initialize the LCN switch."""
|
||||
super().__init__(config, entry_id, device_connection)
|
||||
|
||||
self.output = pypck.lcn_defs.OutputPort[config[CONF_DOMAIN_DATA][CONF_OUTPUT]]
|
||||
|
||||
self._is_on = None
|
||||
self._is_on = False
|
||||
|
||||
async def async_added_to_hass(self):
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Run when entity about to be added to hass."""
|
||||
await super().async_added_to_hass()
|
||||
if not self.device_connection.is_group:
|
||||
await self.device_connection.activate_status_request_handler(self.output)
|
||||
|
||||
async def async_will_remove_from_hass(self):
|
||||
async def async_will_remove_from_hass(self) -> None:
|
||||
"""Run when entity will be removed from hass."""
|
||||
await super().async_will_remove_from_hass()
|
||||
if not self.device_connection.is_group:
|
||||
await self.device_connection.cancel_status_request_handler(self.output)
|
||||
|
||||
@property
|
||||
def is_on(self):
|
||||
def is_on(self) -> bool:
|
||||
"""Return True if entity is on."""
|
||||
return self._is_on
|
||||
|
||||
async def async_turn_on(self, **kwargs):
|
||||
async def async_turn_on(self, **kwargs: Any) -> None:
|
||||
"""Turn the entity on."""
|
||||
if not await self.device_connection.dim_output(self.output.value, 100, 0):
|
||||
return
|
||||
self._is_on = True
|
||||
self.async_write_ha_state()
|
||||
|
||||
async def async_turn_off(self, **kwargs):
|
||||
async def async_turn_off(self, **kwargs: Any) -> None:
|
||||
"""Turn the entity off."""
|
||||
if not await self.device_connection.dim_output(self.output.value, 0, 0):
|
||||
return
|
||||
self._is_on = False
|
||||
self.async_write_ha_state()
|
||||
|
||||
def input_received(self, input_obj):
|
||||
def input_received(self, input_obj: InputType) -> None:
|
||||
"""Set switch state when LCN input object (command) is received."""
|
||||
if (
|
||||
not isinstance(input_obj, pypck.inputs.ModStatusOutput)
|
||||
|
@ -93,32 +107,34 @@ class LcnOutputSwitch(LcnEntity, SwitchEntity):
|
|||
class LcnRelaySwitch(LcnEntity, SwitchEntity):
|
||||
"""Representation of a LCN switch for relay ports."""
|
||||
|
||||
def __init__(self, config, entry_id, device_connection):
|
||||
def __init__(
|
||||
self, config: ConfigType, entry_id: str, device_connection: DeviceConnectionType
|
||||
) -> None:
|
||||
"""Initialize the LCN switch."""
|
||||
super().__init__(config, entry_id, device_connection)
|
||||
|
||||
self.output = pypck.lcn_defs.RelayPort[config[CONF_DOMAIN_DATA][CONF_OUTPUT]]
|
||||
|
||||
self._is_on = None
|
||||
self._is_on = False
|
||||
|
||||
async def async_added_to_hass(self):
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Run when entity about to be added to hass."""
|
||||
await super().async_added_to_hass()
|
||||
if not self.device_connection.is_group:
|
||||
await self.device_connection.activate_status_request_handler(self.output)
|
||||
|
||||
async def async_will_remove_from_hass(self):
|
||||
async def async_will_remove_from_hass(self) -> None:
|
||||
"""Run when entity will be removed from hass."""
|
||||
await super().async_will_remove_from_hass()
|
||||
if not self.device_connection.is_group:
|
||||
await self.device_connection.cancel_status_request_handler(self.output)
|
||||
|
||||
@property
|
||||
def is_on(self):
|
||||
def is_on(self) -> bool:
|
||||
"""Return True if entity is on."""
|
||||
return self._is_on
|
||||
|
||||
async def async_turn_on(self, **kwargs):
|
||||
async def async_turn_on(self, **kwargs: Any) -> None:
|
||||
"""Turn the entity on."""
|
||||
states = [pypck.lcn_defs.RelayStateModifier.NOCHANGE] * 8
|
||||
states[self.output.value] = pypck.lcn_defs.RelayStateModifier.ON
|
||||
|
@ -127,7 +143,7 @@ class LcnRelaySwitch(LcnEntity, SwitchEntity):
|
|||
self._is_on = True
|
||||
self.async_write_ha_state()
|
||||
|
||||
async def async_turn_off(self, **kwargs):
|
||||
async def async_turn_off(self, **kwargs: Any) -> None:
|
||||
"""Turn the entity off."""
|
||||
states = [pypck.lcn_defs.RelayStateModifier.NOCHANGE] * 8
|
||||
states[self.output.value] = pypck.lcn_defs.RelayStateModifier.OFF
|
||||
|
@ -136,7 +152,7 @@ class LcnRelaySwitch(LcnEntity, SwitchEntity):
|
|||
self._is_on = False
|
||||
self.async_write_ha_state()
|
||||
|
||||
def input_received(self, input_obj):
|
||||
def input_received(self, input_obj: InputType) -> None:
|
||||
"""Set switch state when LCN input object (command) is received."""
|
||||
if not isinstance(input_obj, pypck.inputs.ModStatusRelays):
|
||||
return
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue