A full-featured Homeassistant component to drive Meross devices. This component is based on the underlying MerossIot library available here.
Dear users, Meross I recently received a notice from Meross asking to take down versions up to 1.1.4, as they believe there is some sort of bug causing high traffic volumes on their servers. For this reason, all versions from v1.0.7 up to 1.1.4 (excluded) have been temporarely withdrawn from GitHub and HACS. In order to avoid service denial from Meross, you are urged to upgrade to version v1.1.4 or downgrade to v1.0.7 (which was the previously stable version).
Even though this might sound as an ultimatum from Meross, we are finally given the opportunity to collaborate with their security team in order to agree on some MQTT/HTTP rate limits and make sure this HA component works flawlessly. For this reason, I'd really appreciate if you could comply with that request: it would be easier for us to establish a collaborative partnership.
I had promised to the community that I would have focused my development efforts in the local-addon, and... so I am doing :) As already mentioned many times, the reason why it takes so much time is because everything done here is the result of hours and hours of procotol inspection sessions, reverse engineering and hacking.
Just to rise the hype, here there are some screens of the on-going development addon, which is 75% completed:
Meross Plugin has gained great success and popularity among the HomeAssistant users. However, the Meross engineers are imposing new limits on their MQTT broker system, which cause problems to the HA users who want to implement aggressive polling or have more than 10 devices connected to HA. For this reason, I am working on a new HomeAssistant addon, namely "Meross Local Addon", which aims at re-implementing the Meross MQTT Broker and HTTP API layer locally to the addon. This would basically allow users to rely only on LAN-local connection, using HomeAssistant as command center.
As you can imagine, there is a huge work behind that: first I need to reverse-engineer the Meross protocols, then I need to implement any "logic-layer" implemented on Meross Systems on the new addon I am developing and, eventually, I have to make sure that everything works together. That means that I am not able to spend much time in solving issues that may arise in the meantime, and for that I apologize. If you like this project and you want to support me, please consider donating: that motivates me and helps me buy more ram which is absolutely necessary when developing on a virtualized environment.
After months of work and sleepless weekends, it's finally time to present to the Meross community the new version of the HomeAssistant component that allows Meross device controlling. The new version of this library is based on the complete refactored low-level MerossIot library. It's now fully async, based on Meross push notifications and much more robust and resilient to network disconnections.
In case you are updating the component from legacy versions, you need to remove the previous one and fully remove cached devices/entities from your HomeAssistant installation. This is necessary as the library completely changed the device/entity naming system and is unable to remove previous entities installed by old versions of the component. Sorry about that.
You can install this component in two ways: via HACS or manually. HACS is a nice community-maintained components manager, which allows you to install git-hub hosted components in a few clicks. If you have already HACS installed on your HomeAssistant, it's better to go with that. On the other hand, if you don't have HACS installed or if you don't plan to install it, then you can use manual installation.
If you have HACS, well, it's piece of cake! Just search for "Meross" (Full name is Meross Cloud IoT) in the default repository of HACS and it'll show up. Click on Install. When the installation completes, you must restart homeassistant in order to make it work. As soon as HomeAssistant is restarted, you can proceed with component setup.
-
Download the latest zip release archive from here
-
Unzip/copy the meross_cloud directory within the
custom_components
directory of your homeassistant installation. Thecustom_components
directory resides within your homeassistant configuration directory. Usually, the configuration directory is within your home (~/.homeassistant/
). In other words, the configuration directory of homeassistant is where the config.yaml file is located. After a correct installation, your configuration directory should look like the following.βββ ... βββ configuration.yaml βββ secrects.yaml βββ custom_components βββ meross_cloud βββ __init__.py βββ common.py βββ cover.py βββ ...
Note: if the custom_components directory does not exist, you need to create it.
After copy-pasting the meross_cloud directory into the custom_components folder, you need to restart HomeAssistant. As soon as HomeAssistant is restarted, you can proceed with component setup.
Once the component has been installed, you need to configure it in order to make it work. To do so, navigate to "Configuration -> Integrations -> Add Integration" and look for "Meross Cloud IoT". As soon as you add it, you'll be asked to configure it. The following table summarizes the fields that the wizard will require you to fill in:
Field Name | Example Value | Description |
---|---|---|
HTTP Api Endpoint | https://iot.meross.com | Is the HTTP(s) API endpoint used by the Meross Manager. This might vary in accordance with your country |
Email Address | [email protected] | Your Meross account username/email. If connecting to the official Meross cloud, use the same from the Meross App |
Password | R4nd0mS3cret | Your Meross account password. If connecting to the official Meross cloud, use the same from the Meross App |
Skip MQTT certificate validation | True (Checked) | Configures MQTT certificate validation. When unchecked it requires a valid certificate to be exposed from the Meross Server. If checked, it skips the MQTT certificate validation. If connecting to the official Meross cloud, you can uncheck this. When connecting to local-lan or custom MQTT brokers, you might want to check this. |
The following animation shows an example of component configuration
Starting from version 1.1.0, this component has introduced the possibility to configure MQTT messaging rate limits. You can configure such feature via component options configuration.
The current version of this component implements a classic Token Bucket
algorithm. More specifically, every device is subjected to its own token-bucket algorithm, driven by
Single device MQTT burst limit
and Single device MQTT rate limit
parameters.
On top of that, there is a global MQTT rate limiter (still implemented via Token Bucket), driven by
Global MQTT burst limit
and Global MQTT rate limit
parameters.
Field Name | Example Value | Description |
---|---|---|
Enable MQTT Rate limits | True (Checked) | When checked, enables MQTT rate limiting. If unchecked, rate limiting is disabled. |
Global MQTT burst limit | 10 | Maximum number of global MQTT messages that can be sent in a short time burst |
Global MQTT rate limit | 4 | Global MQTT messages/second rate to allow |
Single device MQTT burst limit | 3 | MQTT burst limit for a single device |
Single device MQTT rate limit | 2 | MQTT rate limit for a single device |
Single device max command queue length | 5 | Maximum commands that can be queued (delayed) for a single device. MQTT commands exceeding the queue length will be dropped by the limiter |
This library supports all the Meross devices currently exposed by the Meross IoT library. In particular Bulbs, Switches, Garage Door Openers and Smart Valves/Thermostat are fully supported and perfectly integrated with HomeAssistant.
Since I'm aiming at making this component part of the official HA repo, I've put a lot of effort into following HomeAssistant best practices, in particular:
- Asynchronous functions when possible;
- No polling: the library is event-based. It saves bandwidth and makes the UI much more reactive.
- Robust to disconnection: the library handles network disruption;
- Lovelace notification: supports UI persistent event notification;
- PEP8 code styling
By buying me a coffee, not only you make my development more efficient, but also motivate me to further improve my work. On the other hand, buying me a beer will certainly make me happier: a toast to you, supporter! In case you are a pro and a strong opensource supporter, you might also consider sponsoring my GitHub work.