hass-core/homeassistant/components/drop_connect/config_flow.py
Patrick Frazer fce1b6d248
Add DROP integration (#104319)
* Add DROP integration

* Remove all but one platform for first PR

* Simplify initialization of hass.data[] structure

* Remove unnecessary mnemonic 'DROP_' prefix from DOMAIN constants

* Remove unnecessary whitespace

* Clarify configuration 'confirm' step description

* Remove unnecessary whitespace

* Use device class where applicable

* Remove unnecessary constructor and change its elements to class variables

* Change base entity inheritance to CoordinatorEntity

* Make sensor definitions more concise

* Rename HA domain from drop to drop_connect

* Remove underscores from class and function names

* Remove duplicate temperature sensor

* Change title capitalization

* Refactor using SensorEntityDescription

* Remove unnecessary intermediate dict layer

* Remove generated translations file

* Remove currently unused string values

* Use constants in sensor definitions

* Replace values with constants

* Move translation keys

* Remove unnecessary unique ID and config entry references

* Clean up DROPEntity initialization

* Clean up sensors

* Rename vars and functions according to style

* Remove redundant self references

* Clean up DROPSensor initializer

* Add missing state classes

* Simplify detection of configured devices

* Change entity identifiers to create device linkage

* Move device_info to coordinator

* Remove unnecessary properties

* Correct hub device IDs

* Remove redundant attribute

* Replace optional UID with assert

* Remove redundant attribute

* Correct coordinator initialization

* Fix mypy error

* Move API functionality to 3rd party library

* Abstract device to sensor map into a dict

* Unsubscribe MQTT on unload

* Move entity device information

* Make type checking for mypy conditional

* Bump dropmqttapi to 1.0.1

* Freeze dataclass to match parent class

* Fix race condition in MQTT unsubscribe setup

* Ensure unit tests begin with invalid MQTT state

* Change unit tests to reflect device firmware

* Move MQTT subscription out of the coordinator

* Tidy up initializer

* Move entirety of MQTT subscription out of the coordinator

* Make drop_api a class property

* Remove unnecessary type checks

* Simplify some unit test asserts

* Remove argument matching default

* Add entity category to battery and cartridge life sensors
2023-12-22 14:24:08 +01:00

98 lines
3.4 KiB
Python

"""Config flow for drop_connect integration."""
from __future__ import annotations
import logging
from typing import TYPE_CHECKING, Any
from dropmqttapi.discovery import DropDiscovery
from homeassistant import config_entries
from homeassistant.data_entry_flow import FlowResult
from homeassistant.helpers.service_info.mqtt import MqttServiceInfo
from .const import (
CONF_COMMAND_TOPIC,
CONF_DATA_TOPIC,
CONF_DEVICE_DESC,
CONF_DEVICE_ID,
CONF_DEVICE_NAME,
CONF_DEVICE_OWNER_ID,
CONF_DEVICE_TYPE,
CONF_HUB_ID,
DISCOVERY_TOPIC,
DOMAIN,
)
_LOGGER = logging.getLogger(__name__)
class FlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
"""Handle DROP config flow."""
VERSION = 1
_drop_discovery: DropDiscovery | None = None
async def async_step_mqtt(self, discovery_info: MqttServiceInfo) -> FlowResult:
"""Handle a flow initialized by MQTT discovery."""
# Abort if the topic does not match our discovery topic or the payload is empty.
if (
discovery_info.subscribed_topic != DISCOVERY_TOPIC
or not discovery_info.payload
):
return self.async_abort(reason="invalid_discovery_info")
self._drop_discovery = DropDiscovery(DOMAIN)
if not (
await self._drop_discovery.parse_discovery(
discovery_info.topic, discovery_info.payload
)
):
return self.async_abort(reason="invalid_discovery_info")
existing_entry = await self.async_set_unique_id(
f"{self._drop_discovery.hub_id}_{self._drop_discovery.device_id}"
)
if existing_entry is not None:
# Note: returning "invalid_discovery_info" here instead of "already_configured"
# allows discovery of additional device types.
return self.async_abort(reason="invalid_discovery_info")
self.context.update({"title_placeholders": {"name": self._drop_discovery.name}})
return await self.async_step_confirm()
async def async_step_confirm(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Confirm the setup."""
if TYPE_CHECKING:
assert self._drop_discovery is not None
if user_input is not None:
device_data = {
CONF_COMMAND_TOPIC: self._drop_discovery.command_topic,
CONF_DATA_TOPIC: self._drop_discovery.data_topic,
CONF_DEVICE_DESC: self._drop_discovery.device_desc,
CONF_DEVICE_ID: self._drop_discovery.device_id,
CONF_DEVICE_NAME: self._drop_discovery.name,
CONF_DEVICE_TYPE: self._drop_discovery.device_type,
CONF_HUB_ID: self._drop_discovery.hub_id,
CONF_DEVICE_OWNER_ID: self._drop_discovery.owner_id,
}
return self.async_create_entry(
title=self._drop_discovery.name, data=device_data
)
return self.async_show_form(
step_id="confirm",
description_placeholders={
"device_name": self._drop_discovery.name,
"device_type": self._drop_discovery.device_desc,
},
)
async def async_step_user(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle a flow initialized by the user."""
return self.async_abort(reason="not_supported")