mirror of
https://github.com/XiaoMi/ha_xiaomi_home.git
synced 2025-03-31 14:55:31 +08:00
ef56448dbb
* fix: fix miot_device type error * fix: fix type error * feat: remove spec cache storage * feat: update std_lib and multi_lang logic * feat: update entity value-range * feat: update value-list logic * feat: update prop.format_ logic * fix: fix miot cloud log error * fix: fix fan entity * style: ignore type error * style: rename spec_filter func name * feat: move bool_trans from storage to spec * feat: move sepc_filter from storage to spec, use the YAML format file * feat: same prop supports multiple sub * feat: same event supports multiple sub * fix: fix device remove error * feat: add func slugify_did * fix: fix multi lang error * feat: update action debug logic * feat: ignore normal disconnect log * feat: support binary mode * feat: change miot spec name type define * style: ignore i18n tranlate type error * fix: fix pylint warning * fix: miot storage type error * feat: support binary display mode configure * feat: set default sensor state_class * fix: fix sensor entity type error * fix: fix __init__ type error * feat: update test case logic * fix: github actions add dependencies lib * fix: fix some type error * feat: update device list changed notify logic
351 lines
16 KiB
Python
351 lines
16 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
Copyright (C) 2024 Xiaomi Corporation.
|
|
|
|
The ownership and intellectual property rights of Xiaomi Home Assistant
|
|
Integration and related Xiaomi cloud service API interface provided under this
|
|
license, including source code and object code (collectively, "Licensed Work"),
|
|
are owned by Xiaomi. Subject to the terms and conditions of this License, Xiaomi
|
|
hereby grants you a personal, limited, non-exclusive, non-transferable,
|
|
non-sublicensable, and royalty-free license to reproduce, use, modify, and
|
|
distribute the Licensed Work only for your use of Home Assistant for
|
|
non-commercial purposes. For the avoidance of doubt, Xiaomi does not authorize
|
|
you to use the Licensed Work for any other purpose, including but not limited
|
|
to use Licensed Work to develop applications (APP), Web services, and other
|
|
forms of software.
|
|
|
|
You may reproduce and distribute copies of the Licensed Work, with or without
|
|
modifications, whether in source or object form, provided that you must give
|
|
any other recipients of the Licensed Work a copy of this License and retain all
|
|
copyright and disclaimers.
|
|
|
|
Xiaomi provides the Licensed Work on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
|
CONDITIONS OF ANY KIND, either express or implied, including, without
|
|
limitation, any warranties, undertakes, or conditions of TITLE, NO ERROR OR
|
|
OMISSION, CONTINUITY, RELIABILITY, NON-INFRINGEMENT, MERCHANTABILITY, or
|
|
FITNESS FOR A PARTICULAR PURPOSE. In any event, you are solely responsible
|
|
for any direct, indirect, special, incidental, or consequential damages or
|
|
losses arising from the use or inability to use the Licensed Work.
|
|
|
|
Xiaomi reserves all rights not expressly granted to you in this License.
|
|
Except for the rights expressly granted by Xiaomi under this License, Xiaomi
|
|
does not authorize you in any form to use the trademarks, copyrights, or other
|
|
forms of intellectual property rights of Xiaomi and its affiliates, including,
|
|
without limitation, without obtaining other written permission from Xiaomi, you
|
|
shall not use "Xiaomi", "Mijia" and other words related to Xiaomi or words that
|
|
may make the public associate with Xiaomi in any form to publicize or promote
|
|
the software or hardware devices that use the Licensed Work.
|
|
|
|
Xiaomi has the right to immediately terminate all your authorization under this
|
|
License in the event:
|
|
1. You assert patent invalidation, litigation, or other claims against patents
|
|
or other intellectual property rights of Xiaomi or its affiliates; or,
|
|
2. You make, have made, manufacture, sell, or offer to sell products that knock
|
|
off Xiaomi or its affiliates' products.
|
|
|
|
The Xiaomi Home integration Init File.
|
|
"""
|
|
from __future__ import annotations
|
|
import logging
|
|
from typing import Optional
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.components import persistent_notification
|
|
from homeassistant.helpers import device_registry, entity_registry
|
|
|
|
from .miot.common import slugify_did
|
|
from .miot.miot_storage import (
|
|
DeviceManufacturer, MIoTStorage, MIoTCert)
|
|
from .miot.miot_spec import (
|
|
MIoTSpecInstance, MIoTSpecParser, MIoTSpecService)
|
|
from .miot.const import (
|
|
DEFAULT_INTEGRATION_LANGUAGE, DOMAIN, SUPPORTED_PLATFORMS)
|
|
from .miot.miot_error import MIoTOauthError
|
|
from .miot.miot_device import MIoTDevice
|
|
from .miot.miot_client import MIoTClient, get_miot_instance_async
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
async def async_setup(hass: HomeAssistant, hass_config: dict) -> bool:
|
|
# pylint: disable=unused-argument
|
|
hass.data.setdefault(DOMAIN, {})
|
|
# {[entry_id:str]: MIoTClient}, miot client instance
|
|
hass.data[DOMAIN].setdefault('miot_clients', {})
|
|
# {[entry_id:str]: list[MIoTDevice]}
|
|
hass.data[DOMAIN].setdefault('devices', {})
|
|
# {[entry_id:str]: entities}
|
|
hass.data[DOMAIN].setdefault('entities', {})
|
|
for platform in SUPPORTED_PLATFORMS:
|
|
hass.data[DOMAIN]['entities'][platform] = []
|
|
return True
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant, config_entry: ConfigEntry
|
|
) -> bool:
|
|
"""Set up an entry."""
|
|
def ha_persistent_notify(
|
|
notify_id: str, title: Optional[str] = None,
|
|
message: Optional[str] = None
|
|
) -> None:
|
|
"""Send messages in Notifications dialog box."""
|
|
if title:
|
|
persistent_notification.async_create(
|
|
hass=hass, message=message or '',
|
|
title=title, notification_id=notify_id)
|
|
else:
|
|
persistent_notification.async_dismiss(
|
|
hass=hass, notification_id=notify_id)
|
|
|
|
entry_id = config_entry.entry_id
|
|
entry_data = dict(config_entry.data)
|
|
|
|
ha_persistent_notify(
|
|
notify_id=f'{entry_id}.oauth_error', title=None, message=None)
|
|
|
|
try:
|
|
miot_client: MIoTClient = await get_miot_instance_async(
|
|
hass=hass, entry_id=entry_id,
|
|
entry_data=entry_data,
|
|
persistent_notify=ha_persistent_notify)
|
|
# Spec parser
|
|
spec_parser = MIoTSpecParser(
|
|
lang=entry_data.get(
|
|
'integration_language', DEFAULT_INTEGRATION_LANGUAGE),
|
|
storage=miot_client.miot_storage,
|
|
loop=miot_client.main_loop
|
|
)
|
|
await spec_parser.init_async()
|
|
# Manufacturer
|
|
manufacturer: DeviceManufacturer = DeviceManufacturer(
|
|
storage=miot_client.miot_storage,
|
|
loop=miot_client.main_loop)
|
|
await manufacturer.init_async()
|
|
miot_devices: list[MIoTDevice] = []
|
|
er = entity_registry.async_get(hass=hass)
|
|
for did, info in miot_client.device_list.items():
|
|
spec_instance = await spec_parser.parse(urn=info['urn'])
|
|
if not isinstance(spec_instance, MIoTSpecInstance):
|
|
_LOGGER.error('spec content is None, %s, %s', did, info)
|
|
continue
|
|
device: MIoTDevice = MIoTDevice(
|
|
miot_client=miot_client,
|
|
device_info={
|
|
**info, 'manufacturer': manufacturer.get_name(
|
|
info.get('manufacturer', ''))},
|
|
spec_instance=spec_instance)
|
|
miot_devices.append(device)
|
|
device.spec_transform()
|
|
# Remove filter entities and non-standard entities
|
|
for platform in SUPPORTED_PLATFORMS:
|
|
# ONLY support filter spec service translate entity
|
|
if platform in device.entity_list:
|
|
filter_entities = list(filter(
|
|
lambda entity: (
|
|
isinstance(entity.spec, MIoTSpecService)
|
|
and (
|
|
entity.spec.need_filter
|
|
or (
|
|
miot_client.hide_non_standard_entities
|
|
and entity.spec.proprietary))
|
|
),
|
|
device.entity_list[platform]))
|
|
for entity in filter_entities:
|
|
device.entity_list[platform].remove(entity)
|
|
entity_id = device.gen_service_entity_id(
|
|
ha_domain=platform,
|
|
siid=entity.spec.iid) # type: ignore
|
|
if er.async_get(entity_id_or_uuid=entity_id):
|
|
er.async_remove(entity_id=entity_id)
|
|
if platform in device.prop_list:
|
|
filter_props = list(filter(
|
|
lambda prop: (
|
|
prop.need_filter or (
|
|
miot_client.hide_non_standard_entities
|
|
and prop.proprietary)),
|
|
device.prop_list[platform]))
|
|
for prop in filter_props:
|
|
device.prop_list[platform].remove(prop)
|
|
entity_id = device.gen_prop_entity_id(
|
|
ha_domain=platform, spec_name=prop.name,
|
|
siid=prop.service.iid, piid=prop.iid)
|
|
if er.async_get(entity_id_or_uuid=entity_id):
|
|
er.async_remove(entity_id=entity_id)
|
|
if platform in device.event_list:
|
|
filter_events = list(filter(
|
|
lambda event: (
|
|
event.need_filter or (
|
|
miot_client.hide_non_standard_entities
|
|
and event.proprietary)),
|
|
device.event_list[platform]))
|
|
for event in filter_events:
|
|
device.event_list[platform].remove(event)
|
|
entity_id = device.gen_event_entity_id(
|
|
ha_domain=platform, spec_name=event.name,
|
|
siid=event.service.iid, eiid=event.iid)
|
|
if er.async_get(entity_id_or_uuid=entity_id):
|
|
er.async_remove(entity_id=entity_id)
|
|
if platform in device.action_list:
|
|
filter_actions = list(filter(
|
|
lambda action: (
|
|
action.need_filter or (
|
|
miot_client.hide_non_standard_entities
|
|
and action.proprietary)),
|
|
device.action_list[platform]))
|
|
for action in filter_actions:
|
|
device.action_list[platform].remove(action)
|
|
entity_id = device.gen_action_entity_id(
|
|
ha_domain=platform, spec_name=action.name,
|
|
siid=action.service.iid, aiid=action.iid)
|
|
if er.async_get(entity_id_or_uuid=entity_id):
|
|
er.async_remove(entity_id=entity_id)
|
|
# Remove non-standard action debug entity
|
|
if platform == 'notify':
|
|
entity_id = device.gen_action_entity_id(
|
|
ha_domain='text', spec_name=action.name,
|
|
siid=action.service.iid, aiid=action.iid)
|
|
if er.async_get(entity_id_or_uuid=entity_id):
|
|
er.async_remove(entity_id=entity_id)
|
|
# Action debug
|
|
if not miot_client.action_debug:
|
|
# Remove text entity for debug action
|
|
for action in device.action_list.get('notify', []):
|
|
entity_id = device.gen_action_entity_id(
|
|
ha_domain='text', spec_name=action.name,
|
|
siid=action.service.iid, aiid=action.iid)
|
|
if er.async_get(entity_id_or_uuid=entity_id):
|
|
er.async_remove(entity_id=entity_id)
|
|
# Binary sensor display
|
|
if not miot_client.display_binary_bool:
|
|
for prop in device.prop_list.get('binary_sensor', []):
|
|
entity_id = device.gen_prop_entity_id(
|
|
ha_domain='binary_sensor', spec_name=prop.name,
|
|
siid=prop.service.iid, piid=prop.iid)
|
|
if er.async_get(entity_id_or_uuid=entity_id):
|
|
er.async_remove(entity_id=entity_id)
|
|
if not miot_client.display_binary_text:
|
|
for prop in device.prop_list.get('binary_sensor', []):
|
|
entity_id = device.gen_prop_entity_id(
|
|
ha_domain='sensor', spec_name=prop.name,
|
|
siid=prop.service.iid, piid=prop.iid)
|
|
if er.async_get(entity_id_or_uuid=entity_id):
|
|
er.async_remove(entity_id=entity_id)
|
|
|
|
hass.data[DOMAIN]['devices'][config_entry.entry_id] = miot_devices
|
|
await hass.config_entries.async_forward_entry_setups(
|
|
config_entry, SUPPORTED_PLATFORMS)
|
|
|
|
# Remove the deleted devices
|
|
devices_remove = (await miot_client.miot_storage.load_user_config_async(
|
|
uid=config_entry.data['uid'],
|
|
cloud_server=config_entry.data['cloud_server'],
|
|
keys=['devices_remove'])).get('devices_remove', [])
|
|
if isinstance(devices_remove, list) and devices_remove:
|
|
dr = device_registry.async_get(hass)
|
|
for did in devices_remove:
|
|
device_entry = dr.async_get_device(
|
|
identifiers={(
|
|
DOMAIN,
|
|
slugify_did(
|
|
cloud_server=config_entry.data['cloud_server'],
|
|
did=did))},
|
|
connections=None)
|
|
if not device_entry:
|
|
_LOGGER.error('remove device not found, %s', did)
|
|
continue
|
|
dr.async_remove_device(device_id=device_entry.id)
|
|
_LOGGER.info(
|
|
'delete device entry, %s, %s', did, device_entry.id)
|
|
await miot_client.miot_storage.update_user_config_async(
|
|
uid=config_entry.data['uid'],
|
|
cloud_server=config_entry.data['cloud_server'],
|
|
config={'devices_remove': []})
|
|
|
|
await spec_parser.deinit_async()
|
|
await manufacturer.deinit_async()
|
|
|
|
except MIoTOauthError as oauth_error:
|
|
ha_persistent_notify(
|
|
notify_id=f'{entry_id}.oauth_error',
|
|
title='Xiaomi Home Oauth Error',
|
|
message=f'Please re-add.\r\nerror: {oauth_error}'
|
|
)
|
|
except Exception as err:
|
|
raise err
|
|
|
|
return True
|
|
|
|
|
|
async def async_unload_entry(
|
|
hass: HomeAssistant, config_entry: ConfigEntry
|
|
) -> bool:
|
|
"""Unload the entry."""
|
|
entry_id = config_entry.entry_id
|
|
# Unload the platform
|
|
unload_ok = await hass.config_entries.async_unload_platforms(
|
|
config_entry, SUPPORTED_PLATFORMS)
|
|
if unload_ok:
|
|
hass.data[DOMAIN]['entities'].pop(entry_id, None)
|
|
hass.data[DOMAIN]['devices'].pop(entry_id, None)
|
|
# Remove integration data
|
|
miot_client: MIoTClient = hass.data[DOMAIN]['miot_clients'].pop(
|
|
entry_id, None)
|
|
if miot_client:
|
|
await miot_client.deinit_async()
|
|
del miot_client
|
|
return True
|
|
|
|
|
|
async def async_remove_entry(
|
|
hass: HomeAssistant, config_entry: ConfigEntry
|
|
) -> bool:
|
|
"""Remove the entry."""
|
|
entry_data = dict(config_entry.data)
|
|
uid: str = entry_data['uid']
|
|
cloud_server: str = entry_data['cloud_server']
|
|
miot_storage: MIoTStorage = hass.data[DOMAIN]['miot_storage']
|
|
miot_cert: MIoTCert = MIoTCert(
|
|
storage=miot_storage, uid=uid, cloud_server=cloud_server)
|
|
|
|
# Clean device list
|
|
await miot_storage.remove_async(
|
|
domain='miot_devices', name=f'{uid}_{cloud_server}', type_=dict)
|
|
# Clean user configuration
|
|
await miot_storage.update_user_config_async(
|
|
uid=uid, cloud_server=cloud_server, config=None)
|
|
# Clean cert file
|
|
await miot_cert.remove_user_cert_async()
|
|
await miot_cert.remove_user_key_async()
|
|
return True
|
|
|
|
|
|
async def async_remove_config_entry_device(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
device_entry: device_registry.DeviceEntry
|
|
) -> bool:
|
|
"""Remove the device."""
|
|
miot_client: MIoTClient = await get_miot_instance_async(
|
|
hass=hass, entry_id=config_entry.entry_id)
|
|
|
|
if len(device_entry.identifiers) != 1:
|
|
_LOGGER.error(
|
|
'remove device failed, invalid identifiers, %s, %s',
|
|
device_entry.id, device_entry.identifiers)
|
|
return False
|
|
identifiers = list(device_entry.identifiers)[0]
|
|
if identifiers[0] != DOMAIN:
|
|
_LOGGER.error(
|
|
'remove device failed, invalid domain, %s, %s',
|
|
device_entry.id, device_entry.identifiers)
|
|
return False
|
|
|
|
# Remove device
|
|
await miot_client.remove_device2_async(did_tag=identifiers[1])
|
|
device_registry.async_get(hass).async_remove_device(device_entry.id)
|
|
_LOGGER.info(
|
|
'remove device, %s, %s', identifiers[1], device_entry.id)
|
|
return True
|