Added Midea Dishwasher Integration
This commit is contained in:
@@ -0,0 +1,346 @@
|
||||
"""Init for Midea LAN.
|
||||
|
||||
integration load process:
|
||||
1. component setup: `async_setup`
|
||||
1.1 use `hass.services.async_register` to register service
|
||||
2. config entry setup: `async_setup_entry`
|
||||
2.1 forward the Config Entry to the platform `async_forward_entry_setups`
|
||||
2.2 register listener `update_listener`
|
||||
3. unloading a config entry: `async_unload_entry`
|
||||
"""
|
||||
|
||||
import logging
|
||||
from typing import Any, cast
|
||||
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
import homeassistant.helpers.device_registry as dr
|
||||
import voluptuous as vol
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.const import (
|
||||
CONF_CUSTOMIZE,
|
||||
CONF_DEVICE_ID,
|
||||
CONF_IP_ADDRESS,
|
||||
CONF_NAME,
|
||||
CONF_PORT,
|
||||
CONF_PROTOCOL,
|
||||
CONF_TOKEN,
|
||||
CONF_TYPE,
|
||||
MAJOR_VERSION,
|
||||
MINOR_VERSION,
|
||||
)
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.helpers.typing import ConfigType
|
||||
from midealocal.device import DeviceType, MideaDevice, ProtocolVersion
|
||||
from midealocal.devices import device_selector
|
||||
|
||||
from .const import (
|
||||
ALL_PLATFORM,
|
||||
CONF_ACCOUNT,
|
||||
CONF_KEY,
|
||||
CONF_MODEL,
|
||||
CONF_REFRESH_INTERVAL,
|
||||
CONF_SUBTYPE,
|
||||
DEVICES,
|
||||
DOMAIN,
|
||||
EXTRA_SWITCH,
|
||||
)
|
||||
from .midea_devices import MIDEA_DEVICES
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def update_listener(hass: HomeAssistant, config_entry: ConfigEntry) -> None:
|
||||
"""Option flow signal update.
|
||||
|
||||
register update listener for config entry that will be called when entry is updated.
|
||||
A listener is registered by adding the following to the `async_setup_entry`:
|
||||
`config_entry.async_on_unload(config_entry.add_update_listener(update_listener))`
|
||||
means the Listener is attached when the entry is loaded and detached at unload
|
||||
"""
|
||||
# Forward the unloading of an entry to platforms.
|
||||
await hass.config_entries.async_unload_platforms(config_entry, ALL_PLATFORM)
|
||||
# forward the Config Entry to the platforms
|
||||
hass.async_create_task(
|
||||
hass.config_entries.async_forward_entry_setups(config_entry, ALL_PLATFORM),
|
||||
)
|
||||
device_id: int = cast("int", config_entry.data.get(CONF_DEVICE_ID))
|
||||
customize = config_entry.options.get(CONF_CUSTOMIZE, "")
|
||||
ip_address = config_entry.options.get(CONF_IP_ADDRESS, None)
|
||||
refresh_interval = config_entry.options.get(CONF_REFRESH_INTERVAL, None)
|
||||
dev: MideaDevice = hass.data[DOMAIN][DEVICES].get(device_id)
|
||||
if dev:
|
||||
dev.set_customize(customize)
|
||||
if ip_address is not None:
|
||||
dev.set_ip_address(ip_address)
|
||||
if refresh_interval is not None:
|
||||
dev.set_refresh_interval(refresh_interval)
|
||||
|
||||
|
||||
async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: # noqa: ARG001
|
||||
"""Set up midea_lan component when load this integration.
|
||||
|
||||
Returns
|
||||
-------
|
||||
True if entry is configured.
|
||||
|
||||
"""
|
||||
hass.data.setdefault(DOMAIN, {})
|
||||
attributes = []
|
||||
for device_entities in MIDEA_DEVICES.values():
|
||||
for attribute_name, attribute in cast(
|
||||
"dict",
|
||||
device_entities["entities"],
|
||||
).items():
|
||||
if (
|
||||
attribute.get("type") in EXTRA_SWITCH
|
||||
and attribute_name.value not in attributes
|
||||
):
|
||||
attributes.append(attribute_name.value)
|
||||
|
||||
def service_set_attribute(service: Any) -> None: # noqa: ANN401
|
||||
"""Set service attribute func."""
|
||||
device_id: int = service.data["device_id"]
|
||||
attr = service.data["attribute"]
|
||||
value = service.data["value"]
|
||||
dev: MideaDevice = hass.data[DOMAIN][DEVICES].get(device_id)
|
||||
if dev:
|
||||
if attr == "fan_speed" and value == "auto":
|
||||
value = 102
|
||||
item = None
|
||||
if dev_ := MIDEA_DEVICES.get(dev.device_type):
|
||||
item = cast("dict", dev_["entities"]).get(attr)
|
||||
if (
|
||||
item
|
||||
and (item.get("type") in EXTRA_SWITCH)
|
||||
or (
|
||||
dev.device_type == DeviceType.AC
|
||||
and attr == "fan_speed"
|
||||
and value in range(103)
|
||||
)
|
||||
):
|
||||
dev.set_attribute(attr=attr, value=value)
|
||||
else:
|
||||
_LOGGER.error(
|
||||
"Appliance [%s] has no attribute %s or value is invalid",
|
||||
device_id,
|
||||
attr,
|
||||
)
|
||||
|
||||
def service_send_command(service: Any) -> None: # noqa: ANN401
|
||||
"""Send command to service func."""
|
||||
device_id = service.data.get("device_id")
|
||||
cmd_type = service.data.get("cmd_type")
|
||||
cmd_body = service.data.get("cmd_body")
|
||||
try:
|
||||
cmd_body = bytearray.fromhex(cmd_body)
|
||||
except ValueError:
|
||||
_LOGGER.exception(
|
||||
"Appliance [%s] invalid cmd_body, a hexadecimal string required",
|
||||
device_id,
|
||||
)
|
||||
return
|
||||
dev = hass.data[DOMAIN][DEVICES].get(device_id)
|
||||
if dev:
|
||||
dev.send_command(cmd_type, cmd_body)
|
||||
|
||||
# register service func calls:
|
||||
# `service_set_attribute`, service.yaml key: `set_attribute`
|
||||
hass.services.async_register(
|
||||
DOMAIN,
|
||||
"set_attribute",
|
||||
service_set_attribute,
|
||||
schema=vol.Schema(
|
||||
{
|
||||
vol.Required("device_id"): vol.Coerce(int),
|
||||
vol.Required("attribute"): vol.In(attributes),
|
||||
vol.Required("value"): vol.Any(int, cv.boolean, str),
|
||||
},
|
||||
),
|
||||
)
|
||||
|
||||
# register service func calls:
|
||||
# `service_send_command`, service.yaml key: `send_command`
|
||||
hass.services.async_register(
|
||||
DOMAIN,
|
||||
"send_command",
|
||||
service_send_command,
|
||||
schema=vol.Schema(
|
||||
{
|
||||
vol.Required("device_id"): vol.Coerce(int),
|
||||
vol.Required("cmd_type"): vol.In([2, 3]),
|
||||
vol.Required("cmd_body"): str,
|
||||
},
|
||||
),
|
||||
)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
|
||||
"""Set up platform for current integration.
|
||||
|
||||
Returns
|
||||
-------
|
||||
True if entry is configured.
|
||||
|
||||
"""
|
||||
device_type = config_entry.data.get(CONF_TYPE)
|
||||
if device_type == CONF_ACCOUNT:
|
||||
return True
|
||||
name = config_entry.data.get(CONF_NAME)
|
||||
device_id: int = config_entry.data[CONF_DEVICE_ID]
|
||||
if name is None:
|
||||
name = f"{device_id}"
|
||||
if device_type is None:
|
||||
device_type = 0xAC
|
||||
token: str = config_entry.data.get(CONF_TOKEN) or ""
|
||||
key: str = config_entry.data.get(CONF_KEY) or ""
|
||||
ip_address = config_entry.options.get(CONF_IP_ADDRESS, None)
|
||||
if ip_address is None:
|
||||
ip_address = config_entry.data.get(CONF_IP_ADDRESS)
|
||||
refresh_interval = config_entry.options.get(CONF_REFRESH_INTERVAL)
|
||||
port: int = config_entry.data[CONF_PORT]
|
||||
model: str = config_entry.data[CONF_MODEL]
|
||||
subtype = config_entry.data.get(CONF_SUBTYPE, 0)
|
||||
protocol: ProtocolVersion = ProtocolVersion(config_entry.data[CONF_PROTOCOL])
|
||||
customize: str = config_entry.options.get(CONF_CUSTOMIZE, "")
|
||||
if protocol == ProtocolVersion.V3 and (key == "" or token == ""):
|
||||
_LOGGER.error("For V3 devices, the key and the token is required")
|
||||
return False
|
||||
# device_selector in `midealocal/devices/__init__.py`
|
||||
# hass core version >= 2024.3
|
||||
if (MAJOR_VERSION, MINOR_VERSION) >= (2024, 3):
|
||||
device = await hass.async_add_import_executor_job(
|
||||
device_selector,
|
||||
name,
|
||||
device_id,
|
||||
device_type,
|
||||
ip_address,
|
||||
port,
|
||||
token,
|
||||
key,
|
||||
protocol,
|
||||
model,
|
||||
subtype,
|
||||
customize,
|
||||
)
|
||||
# hass core version < 2024.3
|
||||
else:
|
||||
device = device_selector(
|
||||
name=name,
|
||||
device_id=device_id,
|
||||
device_type=device_type,
|
||||
ip_address=ip_address,
|
||||
port=port,
|
||||
token=token,
|
||||
key=key,
|
||||
device_protocol=protocol,
|
||||
model=model,
|
||||
subtype=subtype,
|
||||
customize=customize,
|
||||
)
|
||||
if device:
|
||||
if refresh_interval is not None:
|
||||
device.set_refresh_interval(refresh_interval)
|
||||
device.open()
|
||||
if DOMAIN not in hass.data:
|
||||
hass.data[DOMAIN] = {}
|
||||
if DEVICES not in hass.data[DOMAIN]:
|
||||
hass.data[DOMAIN][DEVICES] = {}
|
||||
hass.data[DOMAIN][DEVICES][device_id] = device
|
||||
# Forward the setup of an entry to all platforms
|
||||
await hass.config_entries.async_forward_entry_setups(config_entry, ALL_PLATFORM)
|
||||
# Listener `update_listener` is
|
||||
# attached when the entry is loaded
|
||||
# and detached when it's unloaded
|
||||
config_entry.async_on_unload(config_entry.add_update_listener(update_listener))
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
|
||||
"""Clean up entities, unsubscribe event listener and close all connections.
|
||||
|
||||
Returns
|
||||
-------
|
||||
True if entry is unloaded.
|
||||
|
||||
"""
|
||||
device_type = config_entry.data.get(CONF_TYPE)
|
||||
if device_type == CONF_ACCOUNT:
|
||||
return True
|
||||
device_id = config_entry.data.get(CONF_DEVICE_ID)
|
||||
if device_id is not None:
|
||||
dm = hass.data[DOMAIN][DEVICES].get(device_id)
|
||||
if dm is not None:
|
||||
try:
|
||||
dm.close()
|
||||
except (OSError, ConnectionError, AttributeError) as e:
|
||||
_LOGGER.warning("Failed to close Midea socket cleanly: %s", e)
|
||||
hass.data[DOMAIN][DEVICES].pop(device_id)
|
||||
# Forward the unloading of an entry to platforms
|
||||
await hass.config_entries.async_unload_platforms(config_entry, ALL_PLATFORM)
|
||||
return True
|
||||
|
||||
|
||||
async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
|
||||
"""Migrate old entry.
|
||||
|
||||
Returns
|
||||
-------
|
||||
True if entry is migrated.
|
||||
|
||||
"""
|
||||
# 1 -> 2: convert device identifiers from int to str
|
||||
if config_entry.version == 1:
|
||||
_LOGGER.debug("Migrating configuration from version 1")
|
||||
|
||||
if (MAJOR_VERSION, MINOR_VERSION) >= (2024, 3):
|
||||
hass.config_entries.async_update_entry(config_entry, version=2)
|
||||
else:
|
||||
config_entry.version = 2
|
||||
hass.config_entries.async_update_entry(config_entry)
|
||||
|
||||
# Migrate device.
|
||||
await _async_migrate_device_identifiers(hass, config_entry)
|
||||
|
||||
_LOGGER.debug("Migration to configuration version 2 successful")
|
||||
|
||||
return True
|
||||
|
||||
|
||||
async def _async_migrate_device_identifiers(
|
||||
hass: HomeAssistant,
|
||||
config_entry: ConfigEntry,
|
||||
) -> None:
|
||||
"""Migrate the device identifiers to the new format."""
|
||||
device_registry = dr.async_get(hass)
|
||||
device_entry_found = False
|
||||
for device_entry in dr.async_entries_for_config_entry(
|
||||
device_registry,
|
||||
config_entry.entry_id,
|
||||
):
|
||||
for identifier in device_entry.identifiers:
|
||||
# Device found in registry. Update identifiers.
|
||||
new_identifiers = {
|
||||
(
|
||||
DOMAIN,
|
||||
str(identifier[1]),
|
||||
),
|
||||
}
|
||||
_LOGGER.debug(
|
||||
"Migrating device identifiers from %s to %s",
|
||||
device_entry.identifiers,
|
||||
new_identifiers,
|
||||
)
|
||||
device_registry.async_update_device(
|
||||
device_id=device_entry.id,
|
||||
new_identifiers=new_identifiers,
|
||||
)
|
||||
# Device entry found. Leave inner for loop.
|
||||
device_entry_found = True
|
||||
break
|
||||
|
||||
# Leave outer for loop if device entry is already found.
|
||||
if device_entry_found:
|
||||
break
|
||||
Reference in New Issue
Block a user