config_flow.py

Go to the documentation of this file.

"""Config flow for OwnTracks."""
 
import secrets
from typing import Any
 
from homeassistant.components import cloud, webhook
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_WEBHOOK_ID
 
from .const import DOMAIN
from .helper import supports_encryption
 
CONF_SECRET = "secret"
CONF_CLOUDHOOK = "cloudhook"
 
 
class OwnTracksFlow(ConfigFlow, domain=DOMAIN):
    """Set up OwnTracks."""
 
    VERSION = 1
 
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a user initiated set up flow to create OwnTracks webhook."""
        if user_input is None:
            return self.async_show_formasync_show_formasync_show_form(step_id="user")
 
        try:
            webhook_id, webhook_url, cloudhook = await self._get_webhook_id_get_webhook_id()
        except cloud.CloudNotConnected:
            return self.async_abortasync_abortasync_abort(reason="cloud_not_connected")
 
        secret = secrets.token_hex(16)
 
        if supports_encryption():
            secret_desc = (
                f"The encryption key is {secret} (on Android under Preferences >"
                " Advanced)"
            )
        else:
            secret_desc = "Encryption is not supported because nacl is not installed."
 
        return self.async_create_entryasync_create_entryasync_create_entry(
            title="OwnTracks",
            data={
                CONF_WEBHOOK_ID: webhook_id,
                CONF_SECRET: secret,
                CONF_CLOUDHOOK: cloudhook,
            },
            description_placeholders={
                "secret": secret_desc,
                "webhook_url": webhook_url,
                "android_url": "https://play.google.com/store/apps/details?id=org.owntracks.android",
                "ios_url": "https://itunes.apple.com/us/app/owntracks/id692424691?mt=8",
                "docs_url": "https://www.home-assistant.io/integrations/owntracks/",
            },
        )
 
    async def _get_webhook_id(self):
        """Generate webhook ID."""
        webhook_id = webhook.async_generate_id()
        if cloud.async_active_subscription(self.hass):
            webhook_url = await cloud.async_create_cloudhook(self.hass, webhook_id)
            cloudhook = True
        else:
            webhook_url = webhook.async_generate_url(self.hass, webhook_id)
            cloudhook = False
 
        return webhook_id, webhook_url, cloudhook