class SubaruConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
"""Handle a config flow for Subaru."""
VERSION = 1
def __init__(self):
"""Initialize config flow."""
self.config_data = {CONF_PIN: None}
self.controller = None
async def async_step_user(self, user_input=None):
"""Handle the start of the config flow."""
error = None
if user_input:
self._async_abort_entries_match({CONF_USERNAME: user_input[CONF_USERNAME]})
try:
await self.validate_login_creds(user_input)
except InvalidCredentials:
error = {"base": "invalid_auth"}
except SubaruException as ex:
_LOGGER.error("Unable to communicate with Subaru API: %s", ex.message)
return self.async_abort(reason="cannot_connect")
else:
if self.controller.is_pin_required():
return await self.async_step_pin()
return self.async_create_entry(
title=user_input[CONF_USERNAME], data=self.config_data
)
return self.async_show_form(
step_id="user",
data_schema=vol.Schema(
{
vol.Required(
CONF_USERNAME,
default=user_input.get(CONF_USERNAME) if user_input else "",
): str,
vol.Required(
CONF_PASSWORD,
default=user_input.get(CONF_PASSWORD) if user_input else "",
): str,
vol.Required(
CONF_COUNTRY,
default=user_input.get(CONF_COUNTRY)
if user_input
else COUNTRY_USA,
): vol.In([COUNTRY_CAN, COUNTRY_USA]),
}
),
errors=error,
)
@staticmethod
@callback
def async_get_options_flow(config_entry):
"""Get the options flow for this handler."""
return OptionsFlowHandler(config_entry)
async def validate_login_creds(self, data):
"""Validate the user input allows us to connect.
data: contains values provided by the user.
"""
websession = aiohttp_client.async_get_clientsession(self.hass)
now = datetime.now()
if not data.get(CONF_DEVICE_ID):
data[CONF_DEVICE_ID] = int(now.timestamp())
date = now.strftime("%Y-%m-%d")
device_name = "Home Assistant: Added " + date
self.controller = SubaruAPI(
websession,
username=data[CONF_USERNAME],
password=data[CONF_PASSWORD],
device_id=data[CONF_DEVICE_ID],
pin=None,
device_name=device_name,
country=data[CONF_COUNTRY],
)
_LOGGER.debug(
"Setting up first time connection to Subaru API. This may take up to 20 seconds"
)
if await self.controller.connect():
_LOGGER.debug("Successfully authenticated and authorized with Subaru API")
self.config_data.update(data)
async def async_step_pin(self, user_input=None):
"""Handle second part of config flow, if required."""
error = None
if user_input and self.controller.update_saved_pin(user_input[CONF_PIN]):
try:
vol.Match(r"[0-9]{4}")(user_input[CONF_PIN])
await self.controller.test_pin()
except vol.Invalid:
error = {"base": "bad_pin_format"}
except InvalidPIN:
error = {"base": "incorrect_pin"}
else:
_LOGGER.debug("PIN successfully tested")
self.config_data.update(user_input)
return self.async_create_entry(
title=self.config_data[CONF_USERNAME], data=self.config_data
)
return self.async_show_form(step_id="pin", data_schema=PIN_SCHEMA, errors=error)
class SubaruConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
"""Handle a config flow for Subaru."""
VERSION = 1
def __init__(self):
"""Initialize config flow."""
self.config_data = {CONF_PIN: None}
self.controller = None
async def async_step_user(self, user_input=None):
"""Handle the start of the config flow."""
error = None
if user_input:
self._async_abort_entries_match(
{CONF_USERNAME: user_input[CONF_USERNAME]})
try:
await self.validate_login_creds(user_input)
except InvalidCredentials:
error = {"base": "invalid_auth"}
except SubaruException as ex:
_LOGGER.error("Unable to communicate with Subaru API: %s",
ex.message)
return self.async_abort(reason="cannot_connect")
else:
if not self.controller.device_registered:
_LOGGER.debug("2FA validation is required")
return await self.async_step_two_factor()
if self.controller.is_pin_required():
return await self.async_step_pin()
return self.async_create_entry(title=user_input[CONF_USERNAME],
data=self.config_data)
return self.async_show_form(
step_id="user",
data_schema=vol.Schema({
vol.Required(
CONF_USERNAME,
default=user_input.get(CONF_USERNAME) if user_input else "",
):
str,
vol.Required(
CONF_PASSWORD,
default=user_input.get(CONF_PASSWORD) if user_input else "",
):
str,
vol.Required(
CONF_COUNTRY,
default=user_input.get(CONF_COUNTRY) if user_input else COUNTRY_USA,
):
vol.In([COUNTRY_CAN, COUNTRY_USA]),
}),
errors=error,
)
@staticmethod
@callback
def async_get_options_flow(
config_entry: config_entries.ConfigEntry, ) -> OptionsFlowHandler:
"""Get the options flow for this handler."""
return OptionsFlowHandler(config_entry)
async def validate_login_creds(self, data):
"""Validate the user input allows us to connect.
data: contains values provided by the user.
"""
websession = aiohttp_client.async_get_clientsession(self.hass)
now = datetime.now()
if not data.get(CONF_DEVICE_ID):
data[CONF_DEVICE_ID] = int(now.timestamp())
date = now.strftime("%Y-%m-%d")
device_name = "Home Assistant: Added " + date
self.controller = SubaruAPI(
websession,
username=data[CONF_USERNAME],
password=data[CONF_PASSWORD],
device_id=data[CONF_DEVICE_ID],
pin=None,
device_name=device_name,
country=data[CONF_COUNTRY],
)
_LOGGER.debug("Setting up first time connection to Subaru API")
if await self.controller.connect():
_LOGGER.debug("Successfully authenticated with Subaru API")
self.config_data.update(data)
async def async_step_two_factor(self, user_input=None):
"""Select contact method and request 2FA code from Subaru."""
error = None
if user_input:
# self.controller.contact_methods is a dict:
# {"phone":"555-555-5555", "userName":"******"}
selected_method = next(
k for k, v in self.controller.contact_methods.items()
if v == user_input[CONF_CONTACT_METHOD])
if await self.controller.request_auth_code(selected_method):
return await self.async_step_two_factor_validate()
return self.async_abort(reason="two_factor_request_failed")
data_schema = vol.Schema({
vol.Required(CONF_CONTACT_METHOD):
vol.In(list(self.controller.contact_methods.values()))
})
return self.async_show_form(step_id="two_factor",
data_schema=data_schema,
errors=error)
async def async_step_two_factor_validate(self, user_input=None):
"""Validate received 2FA code with Subaru."""
error = None
if user_input:
try:
vol.Match(r"^[0-9]{6}$")(user_input[CONF_VALIDATION_CODE])
if await self.controller.submit_auth_code(
user_input[CONF_VALIDATION_CODE]):
if self.controller.is_pin_required():
return await self.async_step_pin()
return self.async_create_entry(
title=self.config_data[CONF_USERNAME],
data=self.config_data)
error = {"base": "incorrect_validation_code"}
except vol.Invalid:
error = {"base": "bad_validation_code_format"}
data_schema = vol.Schema({vol.Required(CONF_VALIDATION_CODE): str})
return self.async_show_form(step_id="two_factor_validate",
data_schema=data_schema,
errors=error)
async def async_step_pin(self, user_input=None):
"""Handle second part of config flow, if required."""
error = None
if user_input and self.controller.update_saved_pin(
user_input[CONF_PIN]):
try:
vol.Match(r"[0-9]{4}")(user_input[CONF_PIN])
await self.controller.test_pin()
except vol.Invalid:
error = {"base": "bad_pin_format"}
except InvalidPIN:
error = {"base": "incorrect_pin"}
else:
_LOGGER.debug("PIN successfully tested")
self.config_data.update(user_input)
return self.async_create_entry(
title=self.config_data[CONF_USERNAME],
data=self.config_data)
return self.async_show_form(step_id="pin",
data_schema=PIN_SCHEMA,
errors=error)