Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apollon77/iobroker.meross

ioBroker Adapter to integrate Meross Cloud based devices
https://github.com/apollon77/iobroker.meross

iobroker iobroker-adapter meross meross-cloud

Last synced: 13 days ago
JSON representation

ioBroker Adapter to integrate Meross Cloud based devices

Awesome Lists containing this project

README 

        
![Logo](admin/meross-logo.png)

# ioBroker.meross



![Number of Installations](http://iobroker.live/badges/meross-installed.svg) 

![Number of Installations](http://iobroker.live/badges/meross-stable.svg)

[![NPM version](http://img.shields.io/npm/v/iobroker.meross.svg)](https://www.npmjs.com/package/iobroker.meross)



![Test and Release](https://github.com/Apollon77/iobroker.meross/workflows/Test%20and%20Release/badge.svg)

[![Translation status](https://weblate.iobroker.net/widgets/adapters/-/meross/svg-badge.svg)](https://weblate.iobroker.net/engage/adapters/?utm_source=widget)

[![Downloads](https://img.shields.io/npm/dm/iobroker.meross.svg)](https://www.npmjs.com/package/iobroker.meross)



**This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.** For more details and for information how to disable the error reporting see [Sentry-Plugin Documentation](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Sentry reporting is used starting with js-controller 3.0.



## Disclaimer

**All product and company names or logos are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them or any associated subsidiaries! This personal project is maintained in spare time and has no business goal.**

**MEROSS is a trademark of Chengdu Meross Technology Co., Ltd.**



## Description

This adapter allows to control Meross devices by connecting to the Meross cloud servers.



You need to provide your Cloud login credentials. The adapter connects to your cloud account and subscribe to all device data via MQTT. Because of this the devices need to be connected to their cloud. Currently no way is known to control the devices locally.



One Adapter instance will show all devices from one Meross Cloud account and allows to control them.



If new devices are added to Meross Cloud account, it is necessary to restart the Meross adapter to update the adapters iobroker data tree accordingly.



## Note when using MFA

The adapter allows to enter the current MFA code in the settings. Please be aware that a code is only valid 30s, so enter and save fast :-)



The adapter tries to remember the token but this token runs out after some time! So when using MFA this means that no new login can be done when the adapter is restarted because the token is invalid and the MFA code too! In this case the adapter will stay offline until you enter a new MFA code.



## Known working devices



All devices should work from my current knowledge. But please check the logs or report any feature or new devices types that are not creating states (new device types needs to be added manually by me, so an issue is important).



## How to report issues and feature requests



Please use GitHub issues for this.



Best is to set the adapter to Debug log mode (Instances -> Expert mode -> Column Log level). Then please get the logfile from disk (subdirectory "log" in ioBroker installation directory and not from Admin because Admin cuts the lines). If you do not like providing it in GitHub issue you can also send it to me via email ([email protected]). Please add a reference to the relevant GitHub issue AND also describe what I see in the log at which time.



## Changelog

### 1.17.0 (2023-12-30)

* (Apollon77) Adjust Signin API and add support for MFA

* (Apollon77) Store login token and try to reuse it for reconnections, but also do not log out anymore

* (Apollon77) Add support for DoorWindow Sensor MS200HK



### 1.16.1 (2023-11-27)

* (Apollon77) Fixes initial Temperature/Humidity/Voltage values of MS100 sensors



### 1.16.0 (2023-11-25)

* IMPORTANT: Node.js 16.x or higher is required

* (Apollon77) Prevented crash case reported by Sentry



### 1.15.1 (2023-05-15)

* (Apollon77) Fix an issue when committing devices delayed



### 1.15.0 (2023-01-03)

* (Apollon77) Add support for MAP100 air purifier

* (Apollon77) Add Energy Consumption states



### 1.14.0 (2022-08-12)

* (Apollon77) Add Smoke Sensor



### 1.13.0 (2022-07-12)

* (Apollon77) Add new option to prevent the Cloud communication fallback when the device is not available locally for data queries (enabled by default).



### 1.12.2 (2022-06-27)

* (Apollon7) prevent crash case reported by Sentry



### 1.12.1 (2022-06-27)

* (Apollon7) prevent crash case reported by Sentry



### 1.12.0 (2022-06-24)

* (Apollon77) Add new state to allow controlling whether to connect locally first or not for each device (but global setting takes precedence if set there to never use local connection!)

* (Apollon77) Detect reconnection issues to Meross Cloud and try to handle them better



### 1.11.0 (2022-06-02)

* (Apollon77) Add online status configuration to show online status in Admin UI

* (Apollon77) Optimize device initialization to make sure it finishes also whe not all devices are initialized successfully



### 1.10.5 (2022-04-14)

* (Apollon77) Adjust to recent API changes from Meross services



### 1.10.4 (2022-03-15)

* (Apollon77) Add battery value for ms100 devices in hub if supported



### 1.10.3 (2022-03-11)

* (Apollon77) Fix switch state for thermostats



### 1.10.2 (2022-02-19)

* (Apollon77) Correctly set the garageDoorWorking flag after starting a control action



### 1.10.1 (2022-01-26)

* (Apollon77) Fix pot. crash case



### 1.10.0 (2022-01-20)

* (Apollon77) Optimize Meross Communication to first try to communicate with the device locally before sending data to MQTT - enabled by default, you can disable it in settings!

* (Apollon77) Optimize Meross Communication by using only one MQTT connection instead of one per device when cloud is used

* (Apollon77) Add new state "disabled" to ignore connection error of a device; reconnections are still tried, but no error are logged if not successful

* (Apollon77) Add support for Online status reports from MTS100 hub devices

* (Apollon77) Automatically logout from meross cloud on adapter end; next start will do a new Login

* (Apollon77) Automatically delete old devices if no longer existing (when js-controller >=2.2)

* (Apollon77) Optimize MTS200 handling



### 1.8.0 (2022-01-05)

* (Apollon77) Add support for MTS200 Wifi Thermostat



### 1.7.1 (2021-11-13)

* (Apollon77) Allow to enter passwords with more than 15 characters



### 1.7.0 (2021-11-13)

* (Apollon77) Add support for MTS150 Thermostats

* (Apollon77) Add support for MRS100 RollerShutter devices



### 1.6.3 (2021-06-04)

* (Apollon77) Update translations



### 1.6.2 (2021-05-07)

* (Apollon77) optimize for js-controller 3.3



### 1.6.1 (2021-04-23)

* (Apollon77) prevent crash case (Sentry IOBROKER-MEROSS-Z)



### 1.6.0 (2021-04-18)

* (Apollon77) add MOD100 Diffuser Spray device



### 1.5.1 (2020-12-05)

* (Apollon77) generate an unique uuid for each connection, fixes the "Server not available"



### 1.5.0 (2020-06-25)

* (Apollon77) Prevent crash cases (Sentry IOBROKER-MEROSS-G, IOBROKER-MEROSS-F)

* (Apollon77) Add warning about poll interval and cloud deactivation and reset poll interval to 30s for now



### 1.4.1 (2020-06-12)

* (Apollon77) Fix Admin finally



### 1.4.0 (2020-06-12)

* (Apollon77) Fix Admin

* (Apollon77) Remove the automatic cutting of passwords to 15 characters, but log info message



### 1.3.13 (2020.04.12)

* (Apollon77) add auto decryption handling with js-controller 3.0

* (Apollon77) update meross library to prevent some crash cases



### 1.3.12 (2020.03.08)

* (Apollon77) update dependencies



### 1.3.11 (2020.02.05)

* (Apollon77) optimize error handling

* (Apollon77) Switch Sentry to iobroker own instance hosted in germany



### 1.3.9 (2019.12.18)

* (Apollon77) Prevent some error cases on disconnects



### 1.3.8 (2019.12.07)

* (Apollon77) update dependencies



### 1.3.7 (2019.12.01)

* (Apollon77) Prevent some error cases on disconnects



### 1.3.6 (2019.11.28)

* (Apollon77) Prevent some error cases on disconnects



### 1.3.5 (2019.11.28)

* (Apollon77) Prevent some error cases on disconnects



### 1.3.4 (2019.11.26)

* (Apollon77) Add Temperature/Humidity support for MTS100



### 1.3.1 (2019.11.25)

* (Apollon77) Add names to hub sub devices



### 1.3.0 (2019.11.25)

* (Apollon77) Add msg100 with Garage Door Reed contact

* (Apollon77) Add reconnection handling

* (Apollon77) Add light support (e.g. MSL120 RGB bulb)

* (Apollon77) Add units and roles for electricity

* (Apollon77) Add support for MSXH0 (Air Purifyer)

* (Apollon77) Add support for Hub and Thermostates

* (Apollon77) Allow to control DND mode (LED) - be aware then if controlled via meross app it my get out of sync!

* (Apollon77) Integrate sentry.io for automated error/exception reporting

* (Apollon77) Add support for mts100v3

* (Apollon77) add Compact mode

* (Apollon77) add control option for (rgb) lights



### 1.0.0 (2018.12.16)

* (Apollon77) finalize and move to 1.0.0



### 0.4.1 (2018.11.26)

* (Apollon77) finalize version and allow electricity polling interval to be configured



### 0.3.0 (2018.11.16)

* (Apollon77) add support for mss310 devices



### 0.1.0 (2018.11.14)

* (Apollon77) First release to support ToggleX devices



## License

The MIT License (MIT)



Copyright (c) 2018-2023 Apollon77 



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.