hass-core/homeassistant/components/pvoutput/config_flow.py
Franck Nijhof 1cfeb404b6
Add configuration flow to PVOutput (#62667)
* Add configuration flow to PVOutput

* Update homeassistant/components/pvoutput/sensor.py

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Update homeassistant/components/pvoutput/sensor.py

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Use account URL placeholder

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2021-12-27 22:05:10 +01:00

92 lines
3.1 KiB
Python

"""Config flow to configure the PVOutput integration."""
from __future__ import annotations
from typing import Any
from pvo import PVOutput, PVOutputAuthenticationError, PVOutputError
import voluptuous as vol
from homeassistant.config_entries import ConfigFlow
from homeassistant.const import CONF_API_KEY, CONF_NAME
from homeassistant.core import HomeAssistant
from homeassistant.data_entry_flow import FlowResult
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from .const import CONF_SYSTEM_ID, DOMAIN
async def validate_input(hass: HomeAssistant, *, api_key: str, system_id: int) -> None:
"""Try using the give system id & api key against the PVOutput API."""
session = async_get_clientsession(hass)
pvoutput = PVOutput(
session=session,
api_key=api_key,
system_id=system_id,
)
await pvoutput.status()
class TailscaleFlowHandler(ConfigFlow, domain=DOMAIN):
"""Config flow for PVOutput."""
VERSION = 1
imported_name: str | None = None
async def async_step_user(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle a flow initialized by the user."""
errors = {}
if user_input is not None:
try:
await validate_input(
self.hass,
api_key=user_input[CONF_API_KEY],
system_id=user_input[CONF_SYSTEM_ID],
)
except PVOutputAuthenticationError:
errors["base"] = "invalid_auth"
except PVOutputError:
errors["base"] = "cannot_connect"
else:
await self.async_set_unique_id(str(user_input[CONF_SYSTEM_ID]))
self._abort_if_unique_id_configured()
return self.async_create_entry(
title=self.imported_name or str(user_input[CONF_SYSTEM_ID]),
data={
CONF_SYSTEM_ID: user_input[CONF_SYSTEM_ID],
CONF_API_KEY: user_input[CONF_API_KEY],
},
)
else:
user_input = {}
return self.async_show_form(
step_id="user",
description_placeholders={
"account_url": "https://pvoutput.org/account.jsp"
},
data_schema=vol.Schema(
{
vol.Required(
CONF_API_KEY, default=user_input.get(CONF_API_KEY, "")
): str,
vol.Required(
CONF_SYSTEM_ID, default=user_input.get(CONF_SYSTEM_ID, "")
): int,
}
),
errors=errors,
)
async def async_step_import(self, config: dict[str, Any]) -> FlowResult:
"""Handle a flow initialized by importing a config."""
self.imported_name = config[CONF_NAME]
return await self.async_step_user(
user_input={
CONF_SYSTEM_ID: config[CONF_SYSTEM_ID],
CONF_API_KEY: config[CONF_API_KEY],
}
)