jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-23 05:07:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor Command line cover to inherit TemplateEntity (#81214)

Browse Source 
* Refactor cover

* Remove not needed
This commit is contained in:
G Johansson 2023-03-13 10:57:30 +01:00 committed by GitHub
parent 5c42261210
commit 5c4f93fa36
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
homeassistant/components/command_line/cover.py
View File

@ -20,8 +20,12 @@ from homeassistant.const import (
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.reload import setup_reload_service from homeassistant.helpers.reload import async_setup_reload_service
from homeassistant.helpers.template import Template from homeassistant.helpers.template import Template
from homeassistant.helpers.template_entity import (
TEMPLATE_ENTITY_BASE_SCHEMA,
TemplateEntity,
)
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from . import call_shell_with_timeout, check_output_or_log from . import call_shell_with_timeout, check_output_or_log
@ -47,15 +51,15 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
) )
def setup_platform( async def async_setup_platform(
hass: HomeAssistant, hass: HomeAssistant,
config: ConfigType, config: ConfigType,
add_entities: AddEntitiesCallback, async_add_entities: AddEntitiesCallback,
discovery_info: DiscoveryInfoType | None = None, discovery_info: DiscoveryInfoType | None = None,
) -> None: ) -> None:
"""Set up cover controlled by shell commands.""" """Set up cover controlled by shell commands."""
setup_reload_service(hass, DOMAIN, PLATFORMS) await async_setup_reload_service(hass, DOMAIN, PLATFORMS)
devices: dict[str, Any] = config.get(CONF_COVERS, {}) devices: dict[str, Any] = config.get(CONF_COVERS, {})
covers = [] covers = []
@ -65,8 +69,14 @@ def setup_platform(
if value_template is not None: if value_template is not None:
value_template.hass = hass value_template.hass = hass
cover_config = vol.Schema(
TEMPLATE_ENTITY_BASE_SCHEMA.schema, extra=vol.REMOVE_EXTRA
)(device_config)
covers.append( covers.append(
CommandCover( CommandCover(
hass,
cover_config,
device_config.get(CONF_FRIENDLY_NAME, device_name), device_config.get(CONF_FRIENDLY_NAME, device_name),
device_config[CONF_COMMAND_OPEN], device_config[CONF_COMMAND_OPEN],
device_config[CONF_COMMAND_CLOSE], device_config[CONF_COMMAND_CLOSE],
@ -82,14 +92,16 @@ def setup_platform(
_LOGGER.error("No covers added") _LOGGER.error("No covers added")
return return
add_entities(covers) async_add_entities(covers)
class CommandCover(CoverEntity): class CommandCover(TemplateEntity, CoverEntity):
"""Representation a command line cover.""" """Representation a command line cover."""
def __init__( def __init__(
self, self,
hass: HomeAssistant,
config: ConfigType,
name: str, name: str,
command_open: str, command_open: str,
command_close: str, command_close: str,
@ -100,7 +112,13 @@ class CommandCover(CoverEntity):
unique_id: str | None, unique_id: str | None,
) -> None: ) -> None:
"""Initialize the cover.""" """Initialize the cover."""
self._attr_name = name TemplateEntity.__init__(
self,
hass,
config=config,
fallback_name=name,
unique_id=unique_id,
)
self._state: int | None = None self._state: int | None = None
self._command_open = command_open self._command_open = command_open
self._command_close = command_close self._command_close = command_close
@ -108,7 +126,6 @@ class CommandCover(CoverEntity):
self._command_state = command_state self._command_state = command_state
self._value_template = value_template self._value_template = value_template
self._timeout = timeout self._timeout = timeout
self._attr_unique_id = unique_id
self._attr_should_poll = bool(command_state) self._attr_should_poll = bool(command_state)
def _move_cover(self, command: str) -> bool: def _move_cover(self, command: str) -> bool:
@ -148,12 +165,14 @@ class CommandCover(CoverEntity):
if TYPE_CHECKING: if TYPE_CHECKING:
return None return None
def update(self) -> None: async def async_update(self) -> None:
"""Update device state.""" """Update device state."""
if self._command_state: if self._command_state:
payload = str(self._query_state()) payload = str(await self.hass.async_add_executor_job(self._query_state))
if self._value_template: if self._value_template:
payload = self._value_template.render_with_possible_json_value(payload) payload = await self.hass.async_add_executor_job(
self._value_template.render_with_possible_json_value, payload
)
self._state = int(payload) self._state = int(payload)
def open_cover(self, **kwargs: Any) -> None: def open_cover(self, **kwargs: Any) -> None: