132 lines
4.3 KiB
Python
132 lines
4.3 KiB
Python
"""Adds config flow for Brother Printer."""
|
|
import ipaddress
|
|
import re
|
|
|
|
from brother import Brother, SnmpError, UnsupportedModel
|
|
import voluptuous as vol
|
|
|
|
from homeassistant import config_entries, exceptions
|
|
from homeassistant.const import CONF_HOST, CONF_TYPE
|
|
|
|
from .const import DOMAIN, PRINTER_TYPES
|
|
from .utils import get_snmp_engine
|
|
|
|
DATA_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Required(CONF_HOST, default=""): str,
|
|
vol.Optional(CONF_TYPE, default="laser"): vol.In(PRINTER_TYPES),
|
|
}
|
|
)
|
|
|
|
|
|
def host_valid(host):
|
|
"""Return True if hostname or IP address is valid."""
|
|
try:
|
|
if ipaddress.ip_address(host).version == (4 or 6):
|
|
return True
|
|
except ValueError:
|
|
disallowed = re.compile(r"[^a-zA-Z\d\-]")
|
|
return all(x and not disallowed.search(x) for x in host.split("."))
|
|
|
|
|
|
class BrotherConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
|
|
"""Handle a config flow for Brother Printer."""
|
|
|
|
VERSION = 1
|
|
CONNECTION_CLASS = config_entries.CONN_CLASS_LOCAL_POLL
|
|
|
|
def __init__(self):
|
|
"""Initialize."""
|
|
self.brother = None
|
|
self.host = None
|
|
|
|
async def async_step_user(self, user_input=None):
|
|
"""Handle the initial step."""
|
|
errors = {}
|
|
|
|
if user_input is not None:
|
|
try:
|
|
if not host_valid(user_input[CONF_HOST]):
|
|
raise InvalidHost()
|
|
|
|
snmp_engine = get_snmp_engine(self.hass)
|
|
|
|
brother = Brother(user_input[CONF_HOST], snmp_engine=snmp_engine)
|
|
await brother.async_update()
|
|
|
|
await self.async_set_unique_id(brother.serial.lower())
|
|
self._abort_if_unique_id_configured()
|
|
|
|
title = f"{brother.model} {brother.serial}"
|
|
return self.async_create_entry(title=title, data=user_input)
|
|
except InvalidHost:
|
|
errors[CONF_HOST] = "wrong_host"
|
|
except ConnectionError:
|
|
errors["base"] = "cannot_connect"
|
|
except SnmpError:
|
|
errors["base"] = "snmp_error"
|
|
except UnsupportedModel:
|
|
return self.async_abort(reason="unsupported_model")
|
|
|
|
return self.async_show_form(
|
|
step_id="user", data_schema=DATA_SCHEMA, errors=errors
|
|
)
|
|
|
|
async def async_step_zeroconf(self, discovery_info):
|
|
"""Handle zeroconf discovery."""
|
|
if discovery_info is None:
|
|
return self.async_abort(reason="cannot_connect")
|
|
|
|
if not discovery_info.get("name") or not discovery_info["name"].startswith(
|
|
"Brother"
|
|
):
|
|
return self.async_abort(reason="not_brother_printer")
|
|
|
|
# Hostname is format: brother.local.
|
|
self.host = discovery_info["hostname"].rstrip(".")
|
|
|
|
snmp_engine = get_snmp_engine(self.hass)
|
|
|
|
self.brother = Brother(self.host, snmp_engine=snmp_engine)
|
|
try:
|
|
await self.brother.async_update()
|
|
except (ConnectionError, SnmpError, UnsupportedModel):
|
|
return self.async_abort(reason="cannot_connect")
|
|
|
|
# Check if already configured
|
|
await self.async_set_unique_id(self.brother.serial.lower())
|
|
self._abort_if_unique_id_configured()
|
|
|
|
self.context.update(
|
|
{
|
|
"title_placeholders": {
|
|
"serial_number": self.brother.serial,
|
|
"model": self.brother.model,
|
|
}
|
|
}
|
|
)
|
|
return await self.async_step_zeroconf_confirm()
|
|
|
|
async def async_step_zeroconf_confirm(self, user_input=None):
|
|
"""Handle a flow initiated by zeroconf."""
|
|
if user_input is not None:
|
|
title = f"{self.brother.model} {self.brother.serial}"
|
|
return self.async_create_entry(
|
|
title=title,
|
|
data={CONF_HOST: self.host, CONF_TYPE: user_input[CONF_TYPE]},
|
|
)
|
|
return self.async_show_form(
|
|
step_id="zeroconf_confirm",
|
|
data_schema=vol.Schema(
|
|
{vol.Optional(CONF_TYPE, default="laser"): vol.In(PRINTER_TYPES)}
|
|
),
|
|
description_placeholders={
|
|
"serial_number": self.brother.serial,
|
|
"model": self.brother.model,
|
|
},
|
|
)
|
|
|
|
|
|
class InvalidHost(exceptions.HomeAssistantError):
|
|
"""Error to indicate that hostname/IP address is invalid."""
|