Add the support of Aqara Gateways

Author: niceboy

README.md

@@ -11,6 +11,12 @@ Home Assistant custom component for control **Xiaomi Multimode Gateway** (aka Ga
 | Xiaomi Multimode Gateway 2 (CN) | DMWG03LM              | **yes**           |
 | Xiaomi Multimode Gateway 2 (EU) | ZNDMWG04LM, BHR6765GL | **yes**           |
 | Aqara Hub E1 (CN)               | ZHWG16LM              | **yes**           |
+| Aqara Gateway M2 PoE (CN)       | ZHWG19LM              | **yes** See Note  |
+| Aqara Camera Hub G3 CN          | ZNSXJ13LM             | **yes** See Note  |
+| Aqara Gateway M3 (CN)           | ZHWG24LM              | **yes** See Note  |
+| Aqara Hub M100 (CN)             | ZHWG24LM              | **yes** See Note  |
+| Aqara Gateway M200 (CN)         | AG047GLB02            | **yes** See Note  |
+| Aqara Doorbell G410 (CN)        | ZNKSML05              | **yes** See Note  |
 | Xiaomi Gateway 2 (CN)           | DGNWG02LM             | **no**, [goto][1] |
 | Xiaomi Gateway (EU)             | DGNWG05LM             | **no**, [goto][2] |
 
@@ -20,13 +26,15 @@ Home Assistant custom component for control **Xiaomi Multimode Gateway** (aka Ga
 [2]: https://openlumi.github.io/
 [3]: https://github.com/niceboygithub/AqaraGateway
 
+Note: Only Zigbee supported. Manually add the gateway that enabled telnet and use "aiot" or "aqara" as Token
+
 Thanks to [@Serrj](https://community.home-assistant.io/u/serrj-sv/) for [instruction](https://community.home-assistant.io/t/xiaomi-mijia-smart-multi-mode-gateway-zndmwg03lm-support/159586/61) how to enable Telnet on old firmwares. And thanks to an unknown researcher for [instruction](https://gist.github.com/zvldz/1bd6b21539f84339c218f9427e022709) how to open telnet on new firmwares.
 
 ---
 
 * [Supported Firmwares](#supported-firmwares)
 * [Supported Devices](#supported-devices)
-  * [Add new device](#add-new-device) 
+  * [Add new device](#add-new-device)
 * [Installation](#installation)
 * [Configuration](#configuration)
 * [Network configuration](#network-configuration)
@@ -83,7 +91,7 @@ Recommended firmwares:
 | Xiaomi Multimode Gateway (CN/EU), Xiaomi Multimode Gateway 2 (CN/EU), Aqara Hub E1 (CN) | worked previously in the Hass, but you updated it to latest firmware                | [use button click method](https://github.com/AlexxIT/Blog/issues/13) |
 | Xiaomi Multimode Gateway (CN/EU)                                                        | firmware 1.5.5 and more, never worked in the Hass                                   | [use UART](https://github.com/AlexxIT/XiaomiGateway3/issues/1057)    |
 | Xiaomi Multimode Gateway 2 (CN/EU)                                                      | firmware 1.0.7 and more, never worked in the Hass                                   | [use UART](https://github.com/AlexxIT/XiaomiGateway3/issues/1166)    |
-| Aqara Hub E1 (CN)                                                                       | firmware 4.0.4 and more, never worked in the Hass                                   | no solution                                                          |
+| Aqara Hub E1 (CN)                                                                       | firmware 4.0.4 and more, never worked in the Hass                                   | use button click method                                              |
 
 - Read more https://github.com/AlexxIT/Blog/issues/13
 
@@ -102,7 +110,7 @@ Gateway Zigbee chip can work in three modes:
 
    - Support Xiaomi/Aqara Zigbee devices simultaneously in Mi Home and Hass
    - Support some Zigbee devices from other brands only in Hass
-   
+
 **2. Zigbee Home Automation (ZHA)**
 
    - Support for [Zigbee devices of hundreds of brands](https://zigbee.blakadder.com/zha.html) only in Hass ([read more](#zigbee-home-automation-mode))
@@ -150,9 +158,9 @@ You may skip 1st step if you know token for you Gateway. If you have multiple Ga
 
 You need gateway `key` only for Xiaomi Multimode Gateway on fw 1.5.5, [read more](https://github.com/AlexxIT/Blog/issues/13).
 
-**ATTENTION:** If you using two Hass with one gateway - you should use same integration version on both of them! 
+**ATTENTION:** If you using two Hass with one gateway - you should use same integration version on both of them!
 
-## Network configuration 
+## Network configuration
 
 All settings are **important** or you may have an unstable operation of the gateway.
 
@@ -165,7 +173,7 @@ All settings are **important** or you may have an unstable operation of the gate
    - Authentication: WPA2 (don't use WPA3)
 - MikroTik Router settings:
    - Wireless > Security Profiles > Group Key Update: **01:00:00** (1 hour or more)
-- Keenetic Router settings: 
+- Keenetic Router settings:
    - Disable "[Airtime Fairness](https://help.keenetic.com/hc/en-us/articles/360009149400)" for 2.4GHz
    - Disable "[256-QAM](https://help.keenetic.com/hc/en-us/articles/4402854785170)" for 2.4GHz
 
@@ -248,7 +256,7 @@ params:                              # all decoded params in one message
   occupancy: false
   occupancy_duration: 0
 ttl: 50m                             # time to live (TTL) - available timeout (maximum last_seen value)
-uid: 649e31xxxxxx                    # hass UID - "12 hex mac" for BLE and Mesh, "0x + 16 hex IEEE" for Zigbee 
+uid: 649e31xxxxxx                    # hass UID - "12 hex mac" for BLE and Mesh, "0x + 16 hex IEEE" for Zigbee
 ```
 
 **Device update** - manual call for device params update. Don't work for many Zigbee battery devices. Don't work for all BLE devices. Don't work for offline Mesh devices.
@@ -556,7 +564,7 @@ Read more in [wiki](https://github.com/AlexxIT/XiaomiGateway3/wiki/Handle-BLE-Lo
 
 ## Xiaomi Multimode Gateway beeper
 
-You can run beeper/buzzer with service: 
+You can run beeper/buzzer with service:
 
 - duration in seconds
 - volume from 1 to 3
@@ -606,7 +614,7 @@ After rebooting the gateway, all changes will be reset. The component will launc
 
 ## Troubleshooting
 
-Put your Gateways and your child bluetooth/zigbee devices far away from **USB 3.0 devices and cables, SSDs, WiFi routers**, etc. USB3 hub can almost completely block the Zigbee signal from your Xiaomi Plug up to 20 centimeters away. 
+Put your Gateways and your child bluetooth/zigbee devices far away from **USB 3.0 devices and cables, SSDs, WiFi routers**, etc. USB3 hub can almost completely block the Zigbee signal from your Xiaomi Plug up to 20 centimeters away.
 
 [![](https://img.youtube.com/vi/tHqZhNcFEvA/mqdefault.jpg)](https://www.youtube.com/watch?v=tHqZhNcFEvA)
 
@@ -674,42 +682,42 @@ logger:
 
 ## FAQ
 
-**Q. Does this integration support Xiaomi Robot Vacuum, Xiaomi Philips Bulb...?**  
+**Q. Does this integration support Xiaomi Robot Vacuum, Xiaomi Philips Bulb...?**
 A. No. The integration does not support Xiaomi Wi-Fi devices.
 
-**Q. Which Mi Home region is best to use?**  
+**Q. Which Mi Home region is best to use?**
 A. Most devices are supported in the China region. In European regions the new Zigbee devices E1/H1/T1-series and some Mesh devices may not work. Read more about [regional restrictions](#regional-restrictions).
 
-**Q. What do multimode gateway beeps mean?**  
+**Q. What do multimode gateway beeps mean?**
 A. Beeps AFTER adding Zigbee devices:
 1. No new devices found, the pair is stopped.
 2. New device successfully added.
 3. Unsupported device model.
 
-Also, if you are using hacked motion sensor - the gateway will periodically beeps. You can [disable it](https://github.com/AlexxIT/XiaomiGateway3/issues/919). 
+Also, if you are using hacked motion sensor - the gateway will periodically beeps. You can [disable it](https://github.com/AlexxIT/XiaomiGateway3/issues/919).
 
-**Q. Does the integration work without internet?**  
+**Q. Does the integration work without internet?**
 A. Partially. The component connects to a hub on the local network. Adding new devices from/to Mi Home requires Internet.
 
-**Q. Does the integration support non Xiaomi Zigbee devices?**  
+**Q. Does the integration support non Xiaomi Zigbee devices?**
 A. Yes. There are three ways to connect third party Zigbee devices. All methods have a different set of supported devices. There is no exact supported list. Don't expect absolutely every device on the market to be supported in any of these methods.
 
-**Q. Will the Zigbee devices continue to work in Mi Home?**  
+**Q. Will the Zigbee devices continue to work in Mi Home?**
 A. Yes. If you do not enable ZHA or z2m mode, the devices will continue to work in Mi Home. And you can use automation in both Mi Home and Hass.
 
-**Q. Do I need to receive a token or enable Telnet manually?**  
+**Q. Do I need to receive a token or enable Telnet manually?**
 A. No. The token is obtained automatically using the login / password from the Mi Home account. Telnet turns on automatically using token.
 
-**Q. Should I open or solder the hub?**  
+**Q. Should I open or solder the hub?**
 A. No.
 
-**Q. Should I use ZHA mode?**  
+**Q. Should I use ZHA mode?**
 A. You decide. If all of your Zigbee devices are supported in Mi Home, it is best to use it. If you have two hubs - you can use one of them in Mi Home mode, and the second in ZHA mode. Or you can also use the hub in Mi Home mode with Xiaomi devices and a Zigbee USB Dongle for other Zigbee devices.
 
-**Q. How many Zigbee devices does the hub support?**  
+**Q. How many Zigbee devices does the hub support?**
 A. The hub can connect directly up to 32 battery-powered devices (end devices). And **additionaly** up to 26 powered devices (routers). Other devices on your network can work through routers. The maximum number of devices is unknown. Official Xiaomi documentation writes about 128 devices.
 
-**Q. Why does the two-button switch only have one entity action?**  
+**Q. Why does the two-button switch only have one entity action?**
 A. All button clicks are displayed in the status of that one entity.
 
 ## Useful links

custom_components/xiaomi_gateway3/core/converters/const.py

@@ -65,3 +65,48 @@
 # lock: On means open (unlocked), Off means closed (locked)
 STATE_UNLOCK = True
 STATE_LOCKED = False
+
+LOCK_NOTIFY = {
+    3235774464: "Frequent door opening failures due to incorrect passwords",  # 0xC0DE0000
+    3235774465: "Frequent door opening failures due to incorrect fingerprints",  # 0xC0DE0001
+    3235774469: "Frequent door opening with abnormal keys",  # 0xC0DE0005
+    3235774470: "Foreign objects in the keyhole",  # 0xC0DE0006
+    3235774471: "Keys not removed",  # 0xC0DE0007
+    3235774472: "Frequent door opening failures with incorrect NFC",  # 0xC0DE0008
+    3235774473: "Door unlocked after timeout",  # 0xC0DE0009
+    3235774474: "Multiple verification failures (advanced protection)",  # 0xC0DE000A
+    3235778564: "Automatic lock body abnormal"  # 0xC0DE1004
+}
+
+GESTURE_MAP = {
+    2: "Two",
+    4: "Four",
+    5: "Five",
+    6: "Eight",
+    10: "OK",
+    101: "Both Two",
+    102: "Both Four",
+    103: "Both Four",
+    104: "Both Eight",
+    105: "Both OK"
+}
+
+PETS_MAP = {
+    0: "",
+    1: "Cat",
+    2: "Dog",
+    3: "Cat or Dog"
+}
+
+ALARM_INDEX_MAP = {
+    0: "Police car 1",
+    1: "Police car 2",
+    2: "Safety accident",
+    3: "Missile countdown",
+    4: "Ghost scream",
+    5: "Sniper rifle",
+    6: "Battle",
+    7: "Air raid alarm",
+    8: "Dog bark",
+    10000: "default"
+}

custom_components/xiaomi_gateway3/core/converters/lumi.py

@@ -115,6 +115,9 @@ def decode(self, device: "XDevice", payload: dict, value):
         elif self.attr == "key_id":
             payload["action"] = "lock"
             payload[self.attr] = value
+        elif self.attr == "event":
+            payload["action"] = "lock"
+            payload["lock_event"] = self.map.get(value)
         elif self.attr == "alarm":
             v = self.map.get(value)
             if v != "doorbell":

custom_components/xiaomi_gateway3/core/core_utils.py

@@ -41,7 +41,12 @@ async def gateway_info(host: str, token: str = None, key: str = None) -> dict |
         return None
 
     # try to enable telnet and return miio info
-    result = await enable_telnet(host, token, key)
+    if token == "aiot" or token == "aqara":
+        if not await check_port(host, 23):
+            return {"error": "wrong_telnet"}
+        return {"host": host}
+    else:
+        result = await enable_telnet(host, token, key)
 
     # waiting for telnet to start
     await asyncio.sleep(1)

custom_components/xiaomi_gateway3/core/device.py

@@ -10,7 +10,7 @@
 from .converters.base import BaseConv, decode_time, encode_time
 from .converters.lumi import LUMI_GLOBALS
 from .converters.zigbee import ZConverter
-from .devices import DEVICES
+from .devices import DEVICES, DEVICES_AIOT_ZIGBEE, DEVICES_AIOT_GATEWAY
 
 if TYPE_CHECKING:
     from .gate.base import XGateway
@@ -236,7 +236,7 @@ def assert_extra(self):
         if ieee := self.extra.get("ieee"):
             assert RE_ZIGBEE_IEEE.match(ieee), ieee
         if did := self.extra.get("did"):
-            if type in (GATEWAY, MESH):
+            if type in (MESH):
                 assert did.isdecimal()
             elif type == ZIGBEE:
                 assert did.startswith("lumi.")
@@ -267,7 +267,15 @@ def init_converters(self):
         # support custom model from yaml
         model = self.extra.get("model") or self.model
 
-        for desc in DEVICES:
+        devices = []
+        if self.extra.get("cloud", "") == "aiot":
+            if self.type == ZIGBEE:
+                devices.extend(DEVICES_AIOT_ZIGBEE)
+        if self.type == GATEWAY:
+            devices.extend(DEVICES_AIOT_GATEWAY)
+        devices.extend(DEVICES)
+
+        for desc in devices:
             # if this spec for current model
             if info := desc.get(model):
                 self.extra["market_brand"] = info[0]