feat: set the cover closed position (#1242)

* feat: add the cover closed position configure option

* feat: estimate the cover entity's is_closed property by the cover closed position (#944)

* fix: translations

* feat: set max cover closed position as 5

* docs: modify README

* fix: remove useless spaces

Author: SusanPhevos

README.md

@@ -293,7 +293,7 @@ The value of the event instance name indicates `_attr_device_class` of the Home
 
 `spec_filter.yaml` is used to filter out the MIoT-Spec-V2 instance that will not be converted to Home Assistant entity.
 
-The format of `spec_filter.json` is as follows.
+The format of `spec_filter.yaml` is as follows.
 
 ```yaml
 <MIoT-Spec-V2 device instance urn without the version field>:

custom_components/xiaomi_home/config_flow.py

@@ -75,6 +75,9 @@
     DEFAULT_CLOUD_SERVER,
     DEFAULT_CTRL_MODE,
     DEFAULT_INTEGRATION_LANGUAGE,
+    DEFAULT_COVER_CLOSED_POSITION,
+    MIN_COVER_CLOSED_POSITION,
+    MAX_COVER_CLOSED_POSITION,
     DEFAULT_NICK_NAME,
     DEFAULT_OAUTH2_API_HOST,
     DOMAIN,
@@ -129,6 +132,7 @@ class XiaomiMihomeConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
 
     _cloud_server: str
     _integration_language: str
+    _cover_closed_position: int
     _auth_info: dict
     _nick_name: str
     _home_selected: dict
@@ -151,6 +155,7 @@ def __init__(self) -> None:
         self._main_loop = asyncio.get_running_loop()
         self._cloud_server = DEFAULT_CLOUD_SERVER
         self._integration_language = DEFAULT_INTEGRATION_LANGUAGE
+        self._cover_closed_position = DEFAULT_COVER_CLOSED_POSITION
         self._storage_path = ''
         self._virtual_did = ''
         self._uid = ''
@@ -951,6 +956,7 @@ async def config_flow_done(self):
                 'action_debug': self._action_debug,
                 'hide_non_standard_entities':
                     self._hide_non_standard_entities,
+                'cover_closed_position': self._cover_closed_position,
                 'display_binary_mode': self._display_binary_mode,
                 'display_devices_changed_notify':
                     self._display_devices_changed_notify
@@ -995,6 +1001,7 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
     _hide_non_standard_entities: bool
     _display_binary_mode: list[str]
     _display_devs_notify: list[str]
+    _cover_closed_position: int
 
     _oauth_redirect_url_full: str
     _auth_info: dict
@@ -1015,6 +1022,7 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
     _opt_lan_ctrl_cfg: bool
     _opt_network_detect_cfg: bool
     _opt_check_network_deps: bool
+    _cover_pos_new: int
 
     _trans_rules_count: int
     _trans_rules_count_success: int
@@ -1043,6 +1051,8 @@ def __init__(self, config_entry: config_entries.ConfigEntry):
         self._ctrl_mode = self._entry_data.get('ctrl_mode', DEFAULT_CTRL_MODE)
         self._integration_language = self._entry_data.get(
             'integration_language', DEFAULT_INTEGRATION_LANGUAGE)
+        self._cover_closed_position = self._entry_data.get(
+            'cover_closed_position', DEFAULT_COVER_CLOSED_POSITION)
         self._nick_name = self._entry_data.get('nick_name', DEFAULT_NICK_NAME)
         self._action_debug = self._entry_data.get('action_debug', False)
         self._hide_non_standard_entities = self._entry_data.get(
@@ -1068,6 +1078,7 @@ def __init__(self, config_entry: config_entries.ConfigEntry):
         self._action_debug_new = False
         self._hide_non_standard_entities_new = False
         self._display_binary_mode_new = []
+        self._cover_pos_new = self._cover_closed_position
         self._update_user_info = False
         self._update_devices = False
         self._update_trans_rules = False
@@ -1340,6 +1351,12 @@ async def async_step_config_options(self, user_input=None):
                     ): cv.multi_select(
                         self._miot_i18n.translate(
                             'config.binary_mode')),  # type: ignore
+                    vol.Optional(
+                        'cover_closed_position',
+                        default=self._cover_closed_position  # type: ignore
+                    ): vol.All(vol.Coerce(int), vol.Range(
+                        min=MIN_COVER_CLOSED_POSITION,
+                        max=MAX_COVER_CLOSED_POSITION)),
                     vol.Required(
                         'update_trans_rules',
                         default=self._update_trans_rules  # type: ignore
@@ -1378,6 +1395,8 @@ async def async_step_config_options(self, user_input=None):
             'update_lan_ctrl_config', self._opt_lan_ctrl_cfg)
         self._opt_network_detect_cfg = user_input.get(
             'network_detect_config', self._opt_network_detect_cfg)
+        self._cover_pos_new = user_input.get(
+            'cover_closed_position', self._cover_closed_position)
 
         return await self.async_step_update_user_info()
 
@@ -1926,6 +1945,7 @@ async def async_step_config_confirm(self, user_input=None):
                     'nick_name': self._nick_name,
                     'lang_new': INTEGRATION_LANGUAGES[self._lang_new],
                     'nick_name_new': self._nick_name_new,
+                    'cover_pos_new': self._cover_pos_new,
                     'devices_add': len(self._devices_add),
                     'devices_remove': len(self._devices_remove),
                     'trans_rules_count': self._trans_rules_count,
@@ -1952,6 +1972,9 @@ async def async_step_config_confirm(self, user_input=None):
         if self._lang_new != self._integration_language:
             self._entry_data['integration_language'] = self._lang_new
             self._need_reload = True
+        if self._cover_pos_new != self._cover_closed_position:
+            self._entry_data['cover_closed_position'] = self._cover_pos_new
+            self._need_reload = True
         if self._update_user_info:
             self._entry_data['nick_name'] = self._nick_name_new
         if self._update_devices:

custom_components/xiaomi_home/cover.py

@@ -91,6 +91,7 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry,
 class Cover(MIoTServiceEntity, CoverEntity):
     """Cover entities for Xiaomi Home."""
     # pylint: disable=unused-argument
+    _cover_closed_position: int
     _prop_motor_control: Optional[MIoTSpecProperty]
     _prop_motor_value_open: Optional[int]
     _prop_motor_value_close: Optional[int]
@@ -115,6 +116,9 @@ def __init__(self, miot_device: MIoTDevice,
         self._attr_supported_color_modes = set()
         self._attr_supported_features = CoverEntityFeature(0)
 
+        self._cover_closed_position = (
+            miot_device.miot_client.cover_closed_position)
+
         self._prop_motor_control = None
         self._prop_motor_value_open = None
         self._prop_motor_value_close = None
@@ -297,7 +301,7 @@ def is_closing(self) -> Optional[bool]:
     def is_closed(self) -> Optional[bool]:
         """Return if the cover is closed."""
         if self.current_cover_position is not None:
-            return self.current_cover_position == 0
+            return self.current_cover_position <= self._cover_closed_position
         # The current position is prior to the status when determining
         # whether the cover is closed.
         if self._prop_status and self._prop_status_closed:

custom_components/xiaomi_home/miot/const.py

@@ -120,6 +120,10 @@
     'zh-Hant': '繁體中文'
 }
 
+DEFAULT_COVER_CLOSED_POSITION: int = 0
+MIN_COVER_CLOSED_POSITION: int = 0
+MAX_COVER_CLOSED_POSITION: int = 5
+
 DEFAULT_CTRL_MODE: str = 'auto'
 
 # Registered in Xiaomi OAuth 2.0 Service

custom_components/xiaomi_home/miot/miot_client.py

@@ -63,7 +63,8 @@
 from .const import (
     DEFAULT_CTRL_MODE, DEFAULT_INTEGRATION_LANGUAGE, DEFAULT_NICK_NAME, DOMAIN,
     MIHOME_CERT_EXPIRE_MARGIN, NETWORK_REFRESH_INTERVAL,
-    OAUTH2_CLIENT_ID, SUPPORT_CENTRAL_GATEWAY_CTRL)
+    OAUTH2_CLIENT_ID, SUPPORT_CENTRAL_GATEWAY_CTRL,
+    DEFAULT_COVER_CLOSED_POSITION)
 from .miot_cloud import MIoTHttpClient, MIoTOauthClient
 from .miot_error import MIoTClientError, MIoTErrorCode
 from .miot_mips import (
@@ -486,6 +487,11 @@ def display_binary_text(self) -> bool:
     def display_binary_bool(self) -> bool:
         return self._display_binary_bool
 
+    @property
+    def cover_closed_position(self) -> int:
+        return self._entry_data.get('cover_closed_position',
+                                    DEFAULT_COVER_CLOSED_POSITION)
+
     @display_devices_changed_notify.setter
     def display_devices_changed_notify(self, value: list[str]) -> None:
         if set(value) == set(self._display_devs_notify):

custom_components/xiaomi_home/translations/de.json

@@ -4,7 +4,7 @@
         "step": {
             "eula": {
                 "title": "Risikohinweis",
-                "description": "1. Ihre **Xiaomi-Benutzerinformationen und Geräteinformationen** werden in Ihrem Home Assistant-System gespeichert. **Xiaomi kann die Sicherheit des Home Assistant-Speichermechanismus nicht garantieren**. Sie sind dafür verantwortlich, Ihre Informationen vor Diebstahl zu schützen.\r\n2. Diese Integration wird von der Open-Source-Community unterstützt und gewartet. Es können jedoch Stabilitätsprobleme oder andere Probleme auftreten. Wenn Sie auf ein Problem stoßen, das mit dieser Integration zusammenhängt, sollten Sie **die Open-Source-Community um Hilfe bitten, anstatt sich an den Xiaomi Home Kundendienst zu wenden**.\r\n3. Sie benötigen bestimmte technische Fähigkeiten, um Ihre lokale Laufzeitumgebung zu warten. Diese Integration ist für Anfänger nicht geeignet. \r\n4. Bevor Sie diese Integration verwenden, lesen Sie bitte die **README-Datei sorgfältig durch**.\r\n5. Um eine stabile Nutzung der Integration zu gewährleisten und Missbrauch der Schnittstelle zu verhindern, **darf diese Integration nur in Home Assistant verwendet werden. Weitere Informationen finden Sie in der LICENSE**.",
+                "description": "1. Ihre **Xiaomi-Benutzerinformationen und Geräteinformationen** werden in Ihrem Home Assistant-System gespeichert. **Xiaomi kann die Sicherheit des Home Assistant-Speichermechanismus nicht garantieren**. Sie sind dafür verantwortlich, Ihre Informationen vor Diebstahl zu schützen.\r\n2. Diese Integration wird von der Open-Source-Community unterstützt und gewartet. Es können jedoch Stabilitätsprobleme oder andere Probleme auftreten. Wenn Sie auf ein Problem stoßen, das mit dieser Integration zusammenhängt, sollten Sie **die Open-Source-Community um Hilfe bitten, anstatt sich an den Xiaomi Home Kundendienst zu wenden**.\r\n3. Sie benötigen bestimmte technische Fähigkeiten, um Ihre lokale Laufzeitumgebung zu warten. Diese Integration ist für Anfänger nicht geeignet.\r\n4. Bevor Sie diese Integration verwenden, lesen Sie bitte die **README-Datei sorgfältig durch**.\r\n5. Um eine stabile Nutzung der Integration zu gewährleisten und Missbrauch der Schnittstelle zu verhindern, **darf diese Integration nur in Home Assistant verwendet werden. Weitere Informationen finden Sie in der LICENSE**.",
                 "data": {
                     "eula": "Ich habe das oben genannte Risiko zur Kenntnis genommen und übernehme freiwillig die damit verbundenen Risiken durch die Verwendung der Integration."
                 }
@@ -124,7 +124,8 @@
                     "display_devices_changed_notify": "Gerätestatusänderungen anzeigen",
                     "update_trans_rules": "Entitätskonvertierungsregeln aktualisieren",
                     "update_lan_ctrl_config": "LAN-Steuerungskonfiguration aktualisieren",
-                    "network_detect_config": "Integrierte Netzwerkkonfiguration"
+                    "network_detect_config": "Integrierte Netzwerkkonfiguration",
+                    "cover_closed_position": "Die Position der geschlossenen Vorhänge"
                 }
             },
             "update_user_info": {
@@ -183,7 +184,7 @@
             },
             "config_confirm": {
                 "title": "Bestätigen Sie die Konfiguration",
-                "description": "**{nick_name}**, bitte bestätigen Sie die neuesten Konfigurationsinformationen und klicken Sie dann auf \"Senden\". Die Integration wird mit den aktualisierten Konfigurationen erneut geladen.\r\n\r\nIntegrationsprache:\t{lang_new}\r\nBenutzername:\t{nick_name_new}\r\nAction-Debug-Modus:\t{action_debug}\r\nVerstecke Nicht-Standard-Entitäten:\t{hide_non_standard_entities}\r\nGerätestatusänderungen anzeigen:\t{display_devices_changed_notify}\r\nGeräteänderungen:\t{devices_add} neue Geräte hinzufügen, {devices_remove} Geräte entfernen\r\nKonvertierungsregeländerungen:\tInsgesamt {trans_rules_count} Regeln, aktualisiert {trans_rules_count_success} Regeln",
+                "description": "**{nick_name}**, bitte bestätigen Sie die neuesten Konfigurationsinformationen und klicken Sie dann auf \"Senden\". Die Integration wird mit den aktualisierten Konfigurationen erneut geladen.\r\n\r\nIntegrationsprache:\t{lang_new}\r\nBenutzername:\t{nick_name_new}\r\nAction-Debug-Modus:\t{action_debug}\r\nVerstecke Nicht-Standard-Entitäten:\t{hide_non_standard_entities}\r\nDie Position der geschlossenen Vorhänge:\t{cover_pos_new}\r\nGerätestatusänderungen anzeigen:\t{display_devices_changed_notify}\r\nGeräteänderungen:\t{devices_add} neue Geräte hinzufügen, {devices_remove} Geräte entfernen\r\nKonvertierungsregeländerungen:\tInsgesamt {trans_rules_count} Regeln, aktualisiert {trans_rules_count_success} Regeln",
                 "data": {
                     "confirm": "Änderungen bestätigen"
                 }

custom_components/xiaomi_home/translations/en.json

@@ -124,7 +124,8 @@
                     "display_devices_changed_notify": "Display device status change notifications",
                     "update_trans_rules": "Update entity conversion rules",
                     "update_lan_ctrl_config": "Update LAN control configuration",
-                    "network_detect_config": "Integrated Network Configuration"
+                    "network_detect_config": "Integrated network configuration",
+                    "cover_closed_position": "Cover closed position"
                 }
             },
             "update_user_info": {
@@ -183,7 +184,7 @@
             },
             "config_confirm": {
                 "title": "Confirm Configuration",
-                "description": "Hello **{nick_name}**, please confirm the latest configuration information and then Click SUBMIT.\r\nThe integration will reload using the updated configuration.\r\n\r\nIntegration Language: \t{lang_new}\r\nNickname: \t{nick_name_new}\r\nDebug mode for action: \t{action_debug}\r\nHide non-standard created entities: \t{hide_non_standard_entities}\r\nDisplay device status change notifications:\t{display_devices_changed_notify}\r\nDevice Changes: \tAdd **{devices_add}** devices, Remove **{devices_remove}** devices\r\nTransformation rules change: \tThere are a total of **{trans_rules_count}** rules, and updated **{trans_rules_count_success}** rules",
+                "description": "Hello **{nick_name}**, please confirm the latest configuration information and then Click SUBMIT.\r\nThe integration will reload using the updated configuration.\r\n\r\nIntegration Language:\t{lang_new}\r\nNickname:\t{nick_name_new}\r\nDebug mode for action:\t{action_debug}\r\nHide non-standard created entities:\t{hide_non_standard_entities}\r\nCover closed position:\t{cover_pos_new}\r\nDisplay device status change notifications:\t{display_devices_changed_notify}\r\nDevice Changes:\tAdd **{devices_add}** devices, Remove **{devices_remove}** devices\r\nTransformation rules change:\tThere are a total of **{trans_rules_count}** rules, and updated **{trans_rules_count_success}** rules",
                 "data": {
                     "confirm": "Confirm the change"
                 }

custom_components/xiaomi_home/translations/es.json

@@ -4,7 +4,7 @@
         "step": {
             "eula": {
                 "title": "Aviso de riesgo",
-                "description": "1. Su **información de usuario de Xiaomi e información del dispositivo** se almacenará en su sistema Home Assistant. **Xiaomi no puede garantizar la seguridad del mecanismo de almacenamiento de Home Assistant**. Usted es responsable de evitar que su información sea robada.\r\n2. Esta integración es mantenida por la comunidad de código abierto y puede haber problemas de estabilidad u otros problemas. Cuando tenga problemas relacionados con el uso de esta integración, **busque ayuda en la comunidad de código abierto en lugar de contactar al servicio al cliente de Xiaomi**.\r\n3. Es necesario tener ciertas habilidades técnicas para mantener su entorno de ejecución local, esta integración no es amigable para los usuarios novatos.\r\n4. Antes de utilizar esta integración, por favor **lea detenidamente el archivo README**. \r\n5. Para garantizar el uso estable de la integración y prevenir el abuso de la interfaz, **esta integración solo está permitida en Home Assistant. Para más detalles, consulte la LICENSE**.",
+                "description": "1. Su **información de usuario de Xiaomi e información del dispositivo** se almacenará en su sistema Home Assistant. **Xiaomi no puede garantizar la seguridad del mecanismo de almacenamiento de Home Assistant**. Usted es responsable de evitar que su información sea robada.\r\n2. Esta integración es mantenida por la comunidad de código abierto y puede haber problemas de estabilidad u otros problemas. Cuando tenga problemas relacionados con el uso de esta integración, **busque ayuda en la comunidad de código abierto en lugar de contactar al servicio al cliente de Xiaomi**.\r\n3. Es necesario tener ciertas habilidades técnicas para mantener su entorno de ejecución local, esta integración no es amigable para los usuarios novatos.\r\n4. Antes de utilizar esta integración, por favor **lea detenidamente el archivo README**.\r\n5. Para garantizar el uso estable de la integración y prevenir el abuso de la interfaz, **esta integración solo está permitida en Home Assistant. Para más detalles, consulte la LICENSE**.",
                 "data": {
                     "eula": "He leído y entiendo los riesgos anteriores, y estoy dispuesto a asumir cualquier riesgo relacionado con el uso de esta integración."
                 }
@@ -124,7 +124,8 @@
                     "display_devices_changed_notify": "Mostrar notificaciones de cambio de estado del dispositivo",
                     "update_trans_rules": "Actualizar reglas de conversión de entidad",
                     "update_lan_ctrl_config": "Actualizar configuración de control LAN",
-                    "network_detect_config": "Configuración de Red Integrada"
+                    "network_detect_config": "Configuración de Red Integrada",
+                    "cover_closed_position": "La posición de las cortinas cerradas"
                 }
             },
             "update_user_info": {
@@ -183,7 +184,7 @@
             },
             "config_confirm": {
                 "title": "Confirmar configuración",
-                "description": "¡Hola, **{nick_name}**! Por favor, confirme la última información de configuración y haga clic en \"Enviar\" para finalizar la configuración.\r\nLa integración se volverá a cargar con la nueva configuración.\r\n\r\nIdioma de la integración:\t{lang_new}\r\nApodo de usuario:\t{nick_name_new}\r\nModo de depuración de Action:\t{action_debug}\r\nOcultar entidades generadas no estándar:\t{hide_non_standard_entities}\r\nMostrar notificaciones de cambio de estado del dispositivo:\t{display_devices_changed_notify}\r\nCambios de dispositivos:\t{devices_add} dispositivos agregados, {devices_remove} dispositivos eliminados\r\nCambios en las reglas de conversión:\t{trans_rules_count} reglas en total, {trans_rules_count_success} reglas actualizadas",
+                "description": "¡Hola, **{nick_name}**! Por favor, confirme la última información de configuración y haga clic en \"Enviar\" para finalizar la configuración.\r\nLa integración se volverá a cargar con la nueva configuración.\r\n\r\nIdioma de la integración:\t{lang_new}\r\nApodo de usuario:\t{nick_name_new}\r\nModo de depuración de Action:\t{action_debug}\r\nOcultar entidades generadas no estándar:\t{hide_non_standard_entities}\r\nLa posición de las cortinas cerradas:\t{cover_pos_new}\r\nMostrar notificaciones de cambio de estado del dispositivo:\t{display_devices_changed_notify}\r\nCambios de dispositivos:\t{devices_add} dispositivos agregados, {devices_remove} dispositivos eliminados\r\nCambios en las reglas de conversión:\t{trans_rules_count} reglas en total, {trans_rules_count_success} reglas actualizadas",
                 "data": {
                     "confirm": "Confirmar modificación"
                 }