mirror of
https://github.com/home-assistant/core.git
synced 2026-09-22 17:52:44 +01:00
81 lines
2.7 KiB
Python
81 lines
2.7 KiB
Python
"""Support for command line notification services."""
|
|
|
|
from typing import Any, override
|
|
|
|
from homeassistant.components.notify import (
|
|
DOMAIN as NOTIFY_DOMAIN,
|
|
BaseNotificationService,
|
|
)
|
|
from homeassistant.const import CONF_COMMAND
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
|
|
from .const import CONF_COMMAND_TIMEOUT, DOMAIN, LOGGER
|
|
from .utils import (
|
|
async_run_shell_command,
|
|
create_platform_yaml_not_supported_issue,
|
|
render_template_args,
|
|
)
|
|
|
|
|
|
async def async_get_service(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> CommandLineNotificationService | None:
|
|
"""Get the Command Line notification service."""
|
|
if not discovery_info:
|
|
create_platform_yaml_not_supported_issue(hass, NOTIFY_DOMAIN)
|
|
return None
|
|
|
|
notify_config = discovery_info
|
|
command: str = notify_config[CONF_COMMAND]
|
|
timeout: int = notify_config[CONF_COMMAND_TIMEOUT]
|
|
|
|
return CommandLineNotificationService(command, timeout)
|
|
|
|
|
|
class CommandLineNotificationService(BaseNotificationService):
|
|
"""Implement the notification service for the Command Line service."""
|
|
|
|
def __init__(self, command: str, timeout: int) -> None:
|
|
"""Initialize the service."""
|
|
self.command = command
|
|
self._timeout = timeout
|
|
|
|
@override
|
|
async def async_send_message(self, message: str = "", **kwargs: Any) -> None:
|
|
"""Send a message to a command line."""
|
|
if not (command := render_template_args(self.hass, self.command)):
|
|
return
|
|
|
|
LOGGER.debug("Running with message: %s", message)
|
|
|
|
try:
|
|
proc, _ = await async_run_shell_command(
|
|
command, self._timeout, stdin=message.encode()
|
|
)
|
|
except TimeoutError as err:
|
|
# TimeoutError subclasses OSError, so it must be caught first.
|
|
LOGGER.debug("Timeout for command: %s", command)
|
|
raise HomeAssistantError(
|
|
translation_domain=DOMAIN,
|
|
translation_key="timeout_error",
|
|
translation_placeholders={"command": command},
|
|
) from err
|
|
except OSError as err:
|
|
LOGGER.debug("Error trying to exec command: %s", command)
|
|
raise HomeAssistantError(
|
|
translation_domain=DOMAIN,
|
|
translation_key="command_error",
|
|
translation_placeholders={"command": command, "error": str(err)},
|
|
) from err
|
|
|
|
if proc.returncode != 0:
|
|
LOGGER.error(
|
|
"Command failed (with return code %s): %s",
|
|
proc.returncode,
|
|
command,
|
|
)
|