Add custom open telnet command option

Author: AlexxIT

custom_components/xiaomi_gateway3/config_flow.py

@@ -8,6 +8,7 @@
 
 from . import DOMAIN
 from .core import gateway3
+from .core.gateway3 import TELNET_CMD
 from .core.xiaomi_cloud import MiCloud
 
 _LOGGER = logging.getLogger(__name__)
@@ -56,8 +57,8 @@ async def async_step_user(self, user_input=None):
                     data_schema=vol.Schema({
                         vol.Required('host', default=device['localip']): str,
                         vol.Required('token', default=device['token']): str,
+                        vol.Required('telnet_cmd', default=TELNET_CMD): str,
                     }),
-                    description_placeholders={'error_text': ''}
                 )
 
         if DOMAIN in self.hass.data and 'devices' in self.hass.data[DOMAIN]:
@@ -116,6 +117,7 @@ async def async_step_token(self, user_input=None, error=None):
             data_schema=vol.Schema({
                 vol.Required('host'): str,
                 vol.Required('token'): str,
+                vol.Required('telnet_cmd', default=TELNET_CMD): str,
             }),
             errors={'base': error} if error else None
         )
@@ -180,6 +182,7 @@ async def async_step_user(self, user_input=None):
 
         host = self.entry.options['host']
         token = self.entry.options['token']
+        telnet_cmd = self.entry.options.get('telnet_cmd')
         ble = self.entry.options.get('ble', True)
         stats = self.entry.options.get('stats', False)
         debug = self.entry.options.get('debug', [])
@@ -192,6 +195,7 @@ async def async_step_user(self, user_input=None):
             data_schema=vol.Schema({
                 vol.Required('host', default=host): str,
                 vol.Required('token', default=token): str,
+                vol.Optional('telnet_cmd', default=telnet_cmd): str,
                 vol.Required('ble', default=ble): bool,
                 vol.Required('stats', default=stats): bool,
                 vol.Optional('debug', default=debug): cv.multi_select(

custom_components/xiaomi_gateway3/core/gateway3.py

@@ -22,6 +22,8 @@
 # MAC reverse
 RE_REVERSE = re.compile(r'(..)(..)(..)(..)(..)(..)')
 
+TELNET_CMD = '{"method":"enable_telnet_service","params":""}'
+
 
 class GatewayV:
     """Handling different firmware versions."""
@@ -339,6 +341,7 @@ class Gateway3(Thread, GatewayV, GatewayMesh, GatewayStats):
     time_offset = 0
     pair_model = None
     pair_payload = None
+    telnet_cmd = None
 
     def __init__(self, host: str, token: str, config: dict, **options):
         super().__init__(daemon=True)
@@ -359,6 +362,8 @@ def __init__(self, host: str, token: str, config: dict, **options):
                                      else options['parent'])
         self.default_devices = config['devices'] if config else None
 
+        self.telnet_cmd = options.get('telnet_cmd') or TELNET_CMD
+
         if 'true' in self._debug:
             self.miio.debug = True
 
@@ -444,7 +449,8 @@ def _check_port(self, port: int):
 
     def _enable_telnet(self):
         """Enable telnet with miio protocol."""
-        if self.miio.send("enable_telnet_service") != 'ok':
+        raw = json.loads(self.telnet_cmd)
+        if self.miio.send(raw['method'], raw.get('params')) != 'ok':
             self.debug(f"Can't enable telnet")
             return False
         return True

custom_components/xiaomi_gateway3/translations/en.json

@@ -23,10 +23,11 @@
         }
       },
       "token": {
-        "description": "[Obtain](https://github.com/Maxmudjon/com.xiaomi-miio/blob/master/docs/obtain_token.md) Mi Home token.\nNote: Gateway with firmware **1.4.6_0043** higher are supported only after [soldering](https://github.com/AlexxIT/XiaomiGateway3/wiki)",
+        "description": "You can obtain Mi Home token automatically with [Cloud integration](https://github.com/AlexxIT/XiaomiGateway3#obtain-mi-home-device-token) or [manually](https://github.com/Maxmudjon/com.xiaomi-miio/blob/master/docs/obtain_token.md). Check supported firmwares info in [component docs](https://github.com/AlexxIT/XiaomiGateway3#supported-firmwares).",
         "data": {
           "host": "Host",
-          "token": "Token"
+          "token": "Token",
+          "telnet_cmd": "Open Telnet command"
         }
       }
     }
@@ -45,6 +46,7 @@
         "data": {
           "host": "Host",
           "token": "Token",
+          "telnet_cmd": "Open Telnet command",
           "ble": "Support BLE Devices",
           "stats": "Zigbee and BLE performance data",
           "debug": "Debug",

custom_components/xiaomi_gateway3/translations/ru.json

@@ -23,10 +23,11 @@
         }
       },
       "token": {
-        "description": "[Получите](https://github.com/Maxmudjon/com.xiaomi-miio/blob/master/docs/obtain_token.md) Mi Home токен. Шлюз с прошивкой **1.4.6_0043** и выше поддерживается только после [перепрошивки](https://github.com/AlexxIT/XiaomiGateway3/wiki)",
+        "description": "Вы можете получить Mi Home токен автоматически с помощью [облачной интеграции](https://github.com/AlexxIT/XiaomiGateway3#obtain-mi-home-device-token) или [вручную](https://github.com/Maxmudjon/com.xiaomi-miio/blob/master/docs/obtain_token.md). Ознакомьтесь с поддерживаемыми версиями прошивок в [документации компонента](https://github.com/AlexxIT/XiaomiGateway3#supported-firmwares).",
         "data": {
           "host": "IP-адрес",
-          "token": "Токен"
+          "token": "Токен",
+          "telnet_cmd": "Команда для открытия Telnet"
         }
       }
     }
@@ -45,6 +46,7 @@
         "data": {
           "host": "IP-адрес",
           "token": "Токен",
+          "telnet_cmd": "Команда для открытия Telnet",
           "ble": "Поддержка BLE устройств",
           "stats": "Детализация работы Zigbee и BLE",
           "debug": "Отладка",