connecting Refoss EM06 via local MQTT

[cbergmann]

Hi,

I have a Refoss Smart Energy Monitor EM06 to monitor the power usage of some of my appliances. It seems that Refoss and Meross are somehow connected/the same company therefore I tried this integration but only with limited success. Following is my writeup of what I did and what works.

When using the Refoss app I can pair the device with the Refoss cloud and see the collected data. On my HA setup I strive to not have any dependencies to external cloud services. Therefore I wanted to pair this device locally to my local mosquitto MQTT server. As my mosquitto Server normally does not allow anonymous connections I added another listener with the following config:

listener 8884
allow_anonymous true
require_certificate false
use_username_as_clientid true
acl_file /etc/mosquitto/meross.acl
certfile /etc/mosquitto/certs/tls.crt
cafile /etc/mosquitto/certs/tls.crt
keyfile /etc/mosquitto/certs/tls.key

The DHCP server is configured to give the EM06 a fixed IP and the firewall is configured to only allow that IP to connect to that port. /etc/mosquitto/meross.acl reads as follows:

user 48:e1:e9:e9:2d:1d
topic readwrite /appliance/#

Next I did a hardware-reset on the EM06 by pressing the button for around 5 seconds. The device confirmed that by a red LED and after restarting blinking green.

Thereafter I installed Version v5.3.0 of the meross_lan Integration from via HACS and restarted Home Assistant.

I then installed the MerossBLE app onto my phone. The device was found and correctly reported in the Discovered Device secion as followed.

I entered the hostname of my MQTT Server (redacted as mqtt.my.local) in the "Server" field and 8884 in the "Port" field. I kept 0 the UserId field and entered a short passphrase as "Key". Then I selected "Write". In the "Time Configuration" section I selected "Europe/Berlin" as my "Timezone" and also selected "Write". As a last step in the app I selecte "Scan" in the "WIFI Configuration" section. Then selecting my wifi and entering the password before also confirming with "Write". The LED of the device then turns to solid green.

In the mosquitto log I see the device connecting with username 48:e1:e9:e9:2d:1d. It subscribes to /appliance/2401066372070174070148e1e9e92d1d/subscribe and the following three messages are exchanged:

/appliance/2401066372070174070148e1e9e92d1d/publish {"header":{"messageId":"39fb7d784b361cdca356b4c184962afc","namespace":"Appliance.Control.Bind","triggerSrc":"DevBoot","method":"SET","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/subscribe","uuid":"2401066372070174070148e1e9e92d1d","timestamp":1721545595,"timestampMs":371,"sign":"33b22ff8d7889391f54b5dc12de28a6a"},"payload":{"bind":{"bindTime":1721545595,"time":{"timestamp":1721545595,"timezone":"Europe/Berlin","timeRule":[[1729990800,3600,0],[1743296400,7200,1],[1761440400,3600,0],[1774746000,7200,1],[1792890000,3600,0],[1806195600,7200,1],[1824944400,3600,0],[1837645200,7200,1],[1856394000,3600,0],[1869094800,7200,1],[1887843600,3600,0],[1901149200,7200,1],[1919293200,3600,0],[1932598800,7200,1],[1950742800,3600,0],[1964048400,7200,1],[1982797200,3600,0],[1995498000,7200,1],[2014246800,3600,0],[2026947600,7200,1]]},"hardware":{"type":"em06","subType":"eu","version":"2.0.0","chipType":"esp32-c3","uuid":"2401066372070174070148e1e9e92d1d","macAddress":"48:e1:e9:e9:2d:1d"},"firmware":{"version":"2.3.8","compileTime":"May 14 2024 -- 15:59:34","encrypt":1,"wifiMac":"48:e1:e9:e9:2d:1d","innerIp":"192.168.2.174","server":"mqtt.my.local","port":8884,"userId":0}}}}
/appliance/2401066372070174070148e1e9e92d1d/subscribe {"header":{"messageId":"39fb7d784b361cdca356b4c184962afc","namespace":"Appliance.Control.Bind","method":"SETACK","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/publish","triggerSrc":"CloudControl","timestamp":1721545596,"timestampMs":0,"sign":"be70c34a6db56609e2e9d3ade91d335e"},"payload":{}}
/appliance/2401066372070174070148e1e9e92d1d/publish {"header":{"messageId":"39fb7d784b361cdca356b4c184962afc","namespace":"Appliance.Control.Bind","triggerSrc":"CloudControl","method":"ERROR","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/publish","uuid":"2401066372070174070148e1e9e92d1d","timestamp":1721545595,"timestampMs":431,"sign":"33b22ff8d7889391f54b5dc12de28a6a"},"payload":{"error":{"code":5001,"detail":"sign error"}}}

This seems to repeat every few seconds.

Next I go to Home Assistant and it discovers the Meros Lan Integration (my HA is in german so some labels might be not correct here). I select "Configure" and enter the same passphrase as device key. It discovers the em06 device immediately and I can configure it.

While doing that the following MQTT messages are exchanged:

/appliance/2401066372070174070148e1e9e92d1d/publish {"header":{"messageId":"447d01e1e2ac841a327279a4598fe69a","namespace":"Appliance.Control.Bind","triggerSrc":"DevBoot","method":"SET","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/subscribe","uuid":"2401066372070174070148e1e9e92d1d","timestamp":1721545846,"timestampMs":141,"sign":"6bb4b4c076b21ee8e9133a3758b2fc0b"},"payload":{"bind":{"bindTime":1721545846,"time":{"timestamp":1721545846,"timezone":"Europe/Berlin","timeRule":[[1729990800,3600,0],[1743296400,7200,1],[1761440400,3600,0],[1774746000,7200,1],[1792890000,3600,0],[1806195600,7200,1],[1824944400,3600,0],[1837645200,7200,1],[1856394000,3600,0],[1869094800,7200,1],[1887843600,3600,0],[1901149200,7200,1],[1919293200,3600,0],[1932598800,7200,1],[1950742800,3600,0],[1964048400,7200,1],[1982797200,3600,0],[1995498000,7200,1],[2014246800,3600,0],[2026947600,7200,1]]},"hardware":{"type":"em06","subType":"eu","version":"2.0.0","chipType":"esp32-c3","uuid":"2401066372070174070148e1e9e92d1d","macAddress":"48:e1:e9:e9:2d:1d"},"firmware":{"version":"2.3.8","compileTime":"May 14 2024 -- 15:59:34","encrypt":1,"wifiMac":"48:e1:e9:e9:2d:1d","innerIp":"192.168.2.174","server":"mqtt.my.local","port":8884,"userId":0}}}}
/appliance/2401066372070174070148e1e9e92d1d/subscribe {"header":{"messageId":"447d01e1e2ac841a327279a4598fe69a","namespace":"Appliance.Control.Bind","method":"SETACK","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/publish","triggerSrc":"CloudControl","timestamp":1721545847,"timestampMs":0,"sign":"28666f3c265c452074c5a4bd2c21e336"},"payload":{}}
/appliance/2401066372070174070148e1e9e92d1d/subscribe {"header":{"messageId":"19441976e37c4caaa63059a7eb6b21c3","namespace":"Appliance.System.Ability","method":"GET","payloadVersion":1,"from":"/appliance/meross_lan/publish","timestamp":1721545847,"timestampMs":0,"sign":"479ed97aec5452e9ce30c07275989254"},"payload":{"ability":{}}}
/appliance/meross_lan/publish {"header":{"messageId":"19441976e37c4caaa63059a7eb6b21c3","namespace":"Appliance.System.Ability","method":"GETACK","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/publish","uuid":"2401066372070174070148e1e9e92d1d","timestamp":1721545846,"timestampMs":400,"sign":"4aa92852c5194199113c1372a04813bc"},"payload":{"payloadVersion":1,"ability":{"Appliance.Config.Key":{},"Appliance.Config.WifiList":{},"Appliance.Config.Wifi":{},"Appliance.Config.WifiX":{},"Appliance.Config.Trace":{},"Appliance.Config.Info":{},"Appliance.System.All":{},"Appliance.System.Hardware":{},"Appliance.System.Firmware":{},"Appliance.System.Debug":{},"Appliance.System.Online":{},"Appliance.System.Time":{},"Appliance.System.Clock":{},"Appliance.System.Ability":{},"Appliance.System.Runtime":{},"Appliance.System.Report":{},"Appliance.System.Position":{},"Appliance.Control.Multiple":{"maxCmdNum":3},"Appliance.Control.Bind":{},"Appliance.Control.Unbind":{},"Appliance.Control.Upgrade":{},"Appliance.Control.ConsumptionH":{},"Appliance.Control.ElectricityX":{},"Appliance.Control.CircuitFactor":{},"Appliance.Control.AlertConfig":{},"Appliance.Control.AlertReport":{},"Appliance.Control.Sensor.History":{}}}}
/appliance/2401066372070174070148e1e9e92d1d/subscribe {"header":{"messageId":"35dccd8783194427aa69603494c5f5f9","namespace":"Appliance.System.All","method":"GET","payloadVersion":1,"from":"/appliance/meross_lan/publish","timestamp":1721545847,"timestampMs":0,"sign":"ff4ab4c8313bbd3dd0d5e649fc7c6e3e"},"payload":{"all":{}}}
/appliance/meross_lan/publish {"header":{"messageId":"35dccd8783194427aa69603494c5f5f9","namespace":"Appliance.System.All","method":"GETACK","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/publish","uuid":"2401066372070174070148e1e9e92d1d","timestamp":1721545846,"timestampMs":467,"sign":"e51325069980776e64bac3ac1981020c"},"payload":{"all":{"system":{"hardware":{"type":"em06","subType":"eu","version":"2.0.0","chipType":"esp32-c3","uuid":"2401066372070174070148e1e9e92d1d","macAddress":"48:e1:e9:e9:2d:1d"},"firmware":{"version":"2.3.8","compileTime":"May 14 2024 -- 15:59:34","encrypt":1,"wifiMac":"48:e1:e9:e9:2d:1d","innerIp":"192.168.2.174","server":"mqtt.my.local","port":8884,"userId":0},"time":{"timestamp":1721545846,"timezone":"Europe/Berlin","timeRule":[[1729990800,3600,0],[1743296400,7200,1],[1761440400,3600,0],[1774746000,7200,1],[1792890000,3600,0],[1806195600,7200,1],[1824944400,3600,0],[1837645200,7200,1],[1856394000,3600,0],[1869094800,7200,1],[1887843600,3600,0],[1901149200,7200,1],[1919293200,3600,0],[1932598800,7200,1],[1950742800,3600,0],[1964048400,7200,1],[1982797200,3600,0],[1995498000,7200,1],[2014246800,3600,0],[2026947600,7200,1]]},"online":{"status":1,"bindId":"0sImwZY8DdGukrQh","who":1}},"digest":{}}}}
/appliance/2401066372070174070148e1e9e92d1d/publish {"header":{"messageId":"3a769bcad0bd0ef3525f3ffaee380da4","namespace":"Appliance.System.Report","method":"PUSH","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/publish","uuid":"2401066372070174070148e1e9e92d1d","timestamp":1721545849,"timestampMs":261,"sign":"0e3f0ddbba1b6abfdc58a5929e3f03fc"},"payload":{"report":[{"type":"1","value":"1","timestamp":1721545849}]}}

The device is added to Home Assistant with two entities. A disabled one for the sensor protocol and one for the signal strenght which reports 100%.

This is it. After that I don't get any more information in Home Assistant.

While testing this I also got the following messages but I was not able to reproduce them. They are not sent frequently. Maybe the are only sent after a certain power usage but I don't know that.

/appliance/2401066372070174070148e1e9e92d1d/publish {"header":{"messageId":"6ec51bc49cedfced2fcc4c923bc30f4d","namespace":"Appliance.Control.Sensor.History","triggerSrc":"energy task","method":"PUSH","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/publish","uuid":"2401066372070174070148e1e9e92d1d","timestamp":1721547256,"timestampMs":93,"sign":"23d1775268e1045f0a0f0b387657b1cd"},"payload":{"history":[{"channel":1,"capacity":16,"value":[{"timestamp":1721545532,"power":0},{"timestamp":1721545590,"power":0},{"timestamp":1721545647,"power":0},{"timestamp":1721545704,"power":0},{"timestamp":1721545762,"power":0},{"timestamp":1721545820,"power":0},{"timestamp":1721545878,"power":0},{"timestamp":1721545938,"power":0},{"timestamp":1721545998,"power":0},{"timestamp":1721546058,"power":0},{"timestamp":1721546118,"power":0},{"timestamp":1721546178,"power":0},{"timestamp":1721546238,"power":0},{"timestamp":1721546297,"power":0},{"timestamp":1721546357,"power":0},{"timestamp":1721546417,"power":0},{"timestamp":1721546477,"power":0},{"timestamp":1721546537,"power":0},{"timestamp":1721546597,"power":0},{"timestamp":1721546657,"power":0},{"timestamp":1721546717,"power":0},{"timestamp":1721546777,"power":0},{"timestamp":1721546836,"power":0},{"timestamp":1721546896,"power":0},{"timestamp":1721546956,"power":0},{"timestamp":1721547016,"power":0},{"timestamp":1721547076,"power":0},{"timestamp":1721547136,"power":0},{"timestamp":1721547196,"power":0},{"timestamp":1721547255,"power":0}]},{"channel":2,"capacity":16,"value":[{"timestamp":1721545532,"power":3365},{"timestamp":1721545590,"power":4616},{"timestamp":1721545647,"power":0},{"timestamp":1721545704,"power":81946},{"timestamp":1721545762,"power":125777},{"timestamp":1721545820,"power":125795},{"timestamp":1721545878,"power":126069},{"timestamp":1721545938,"power":126385},{"timestamp":1721545998,"power":126401},{"timestamp":1721546058,"power":126568},{"timestamp":1721546118,"power":126500},{"timestamp":1721546178,"power":126094},{"timestamp":1721546238,"power":125653},{"timestamp":1721546297,"power":125380},{"timestamp":1721546357,"power":125057},{"timestamp":1721546417,"power":124911},{"timestamp":1721546477,"power":124677},{"timestamp":1721546537,"power":124380},{"timestamp":1721546597,"power":124207},{"timestamp":1721546657,"power":124025},{"timestamp":1721546717,"power":123784},{"timestamp":1721546777,"power":123628},{"timestamp":1721546836,"power":123340},{"timestamp":1721546896,"power":123313},{"timestamp":1721546956,"power":123143},{"timestamp":1721547016,"power":122988},{"timestamp":1721547076,"power":122788},{"timestamp":1721547136,"power":122736},{"timestamp":1721547196,"power":122936},{"timestamp":1721547255,"power":122888}]},{"channel":3,"capacity":16,"value":[{"timestamp":1721545532,"power":0},{"timestamp":1721545590,"power":0},{"timestamp":1721545647,"power":0},{"timestamp":1721545704,"power":0},{"timestamp":1721545762,"power":0},{"timestamp":1721545820,"power":0},{"timestamp":1721545878,"power":0},{"timestamp":1721545938,"power":0},{"timestamp":1721545998,"power":0},{"timestamp":1721546058,"power":0},{"timestamp":1721546118,"power":0},{"timestamp":1721546178,"power":0},{"timestamp":1721546238,"power":0},{"timestamp":1721546297,"power":0},{"timestamp":1721546357,"power":0},{"timestamp":1721546417,"power":0},{"timestamp":1721546477,"power":0},{"timestamp":1721546537,"power":0},{"timestamp":1721546597,"power":0},{"timestamp":1721546657,"power":0},{"timestamp":1721546717,"power":0},{"timestamp":1721546777,"power":0},{"timestamp":1721546836,"power":0},{"timestamp":1721546896,"power":0},{"timestamp":1721546956,"power":0},{"timestamp":1721547016,"power":0},{"timestamp":1721547076,"power":0},{"timestamp":1721547136,"power":0},{"timestamp":1721547196,"power":0},{"timestamp":1721547255,"power":0}]}]}}
/appliance/2401066372070174070148e1e9e92d1d/publish {"header":{"messageId":"566f8d482bada1f8323337d1919833d1","namespace":"Appliance.Control.Sensor.History","triggerSrc":"energy task","method":"PUSH","payloadVersion":1,"from":"/appliance/2401066372070174070148e1e9e92d1d/publish","uuid":"2401066372070174070148e1e9e92d1d","timestamp":1721547260,"timestampMs":829,"sign":"4222a56ad388c4b33effbd3fa02c7762"},"payload":{"history":[{"channel":4,"capacity":16,"value":[{"timestamp":1721545532,"power":-108},{"timestamp":1721545590,"power":-115},{"timestamp":1721545647,"power":-107},{"timestamp":1721545704,"power":-95},{"timestamp":1721545762,"power":-112},{"timestamp":1721545820,"power":-102},{"timestamp":1721545878,"power":-105},{"timestamp":1721545938,"power":-98},{"timestamp":1721545998,"power":-100},{"timestamp":1721546058,"power":-110},{"timestamp":1721546118,"power":-105},{"timestamp":1721546178,"power":-110},{"timestamp":1721546238,"power":-106},{"timestamp":1721546297,"power":-105},{"timestamp":1721546357,"power":-91},{"timestamp":1721546417,"power":-82},{"timestamp":1721546477,"power":-119},{"timestamp":1721546537,"power":-109},{"timestamp":1721546597,"power":-102},{"timestamp":1721546657,"power":-97},{"timestamp":1721546717,"power":-105},{"timestamp":1721546777,"power":-119},{"timestamp":1721546836,"power":-108},{"timestamp":1721546896,"power":-105},{"timestamp":1721546956,"power":-99},{"timestamp":1721547016,"power":-113},{"timestamp":1721547076,"power":-117},{"timestamp":1721547136,"power":-107},{"timestamp":1721547196,"power":-105},{"timestamp":1721547255,"power":-81}]},{"channel":5,"capacity":16,"value":[{"timestamp":1721545532,"power":0},{"timestamp":1721545590,"power":0},{"timestamp":1721545647,"power":0},{"timestamp":1721545704,"power":0},{"timestamp":1721545762,"power":0},{"timestamp":1721545820,"power":0},{"timestamp":1721545878,"power":0},{"timestamp":1721545938,"power":0},{"timestamp":1721545998,"power":0},{"timestamp":1721546058,"power":0},{"timestamp":1721546118,"power":0},{"timestamp":1721546178,"power":0},{"timestamp":1721546238,"power":0},{"timestamp":1721546297,"power":0},{"timestamp":1721546357,"power":0},{"timestamp":1721546417,"power":0},{"timestamp":1721546477,"power":0},{"timestamp":1721546537,"power":0},{"timestamp":1721546597,"power":0},{"timestamp":1721546657,"power":0},{"timestamp":1721546717,"power":0},{"timestamp":1721546777,"power":0},{"timestamp":1721546836,"power":0},{"timestamp":1721546896,"power":0},{"timestamp":1721546956,"power":0},{"timestamp":1721547016,"power":0},{"timestamp":1721547076,"power":0},{"timestamp":1721547136,"power":0},{"timestamp":1721547196,"power":0},{"timestamp":1721547255,"power":0}]},{"channel":6,"capacity":16,"value":[{"timestamp":1721545532,"power":-426},{"timestamp":1721545590,"power":-438},{"timestamp":1721545647,"power":-443},{"timestamp":1721545704,"power":-502},{"timestamp":1721545762,"power":-497},{"timestamp":1721545820,"power":-493},{"timestamp":1721545878,"power":-498},{"timestamp":1721545938,"power":-498},{"timestamp":1721545998,"power":-490},{"timestamp":1721546058,"power":-506},{"timestamp":1721546118,"power":-506},{"timestamp":1721546178,"power":-501},{"timestamp":1721546238,"power":-492},{"timestamp":1721546297,"power":-490},{"timestamp":1721546357,"power":-503},{"timestamp":1721546417,"power":-497},{"timestamp":1721546477,"power":-514},{"timestamp":1721546537,"power":-513},{"timestamp":1721546597,"power":-495},{"timestamp":1721546657,"power":-506},{"timestamp":1721546717,"power":-509},{"timestamp":1721546777,"power":-497},{"timestamp":1721546836,"power":-498},{"timestamp":1721546896,"power":-505},{"timestamp":1721546956,"power":-500},{"timestamp":1721547016,"power":-499},{"timestamp":1721547076,"power":-506},{"timestamp":1721547136,"power":-502},{"timestamp":1721547196,"power":-494},{"timestamp":1721547255,"power":-517}]}]}}

It seems that these contain the correct power consumtions of the devices in mW. The negative numbers seem to be related to the accuracy of the sensor.

I don't know if this is the correct integration or if I should try something different. If this seems interessting for this integration I am more then happy to provied more information or test a new version. I am sufficentily fluent in python to also write a PR if youre are able to give me a hint where to start.

with kind regards Clemens

[krahabb]

Hello @cbergmann, We're almost there I guess... The problem is this device exposes features (through its 'Abilities') which are not currently supported/understood by meross_lan so we'd need some reverse engineering of these features in order to implement these.

As a starter (and hopefully finisher) we'd need at least a 'Download diagnostics' from the device so that these features (called 'namespaces' in Meross jargon) are euristically queried and dumped. After that, if everything works as usual, we should be able to infer the meaning of the different data and add decoding/encoding capabilities to meross_lan in order to map these to useful entities.

Another option (in parallel), would be to enable the 'Create diagnostic entities' in meross_lan -> Configuration -> Diagnostic. This would try to decode the data exposed by these namespaces and map every single value to a plain sensor entity so that you 'd just have some sensors reporting the raw device state.

The final (more powerful) option would be to use the 'Start diagnostic trace' (always in meross_lan-> Conf -> Diagnostics) to grab the full protocol exchange over a longer period of time so that you could physically operate the device (if anything is 'operable' from that) and meross_lan would dump every single message occuring.

I don't know the device but it looks like being just an energy/power sensor with maybe some configuration options. I think we could get it to work at least in a basic scenario, maybe more...

[cbergmann]

Hi, Attach is the downloaded diagnostics information. I also activated diagnostic entities and now have around 20 entities with more or less usefull information. For each of the 6 sensors I get a total consumption (in Wh it seems), A capacity which is 16 (A I think) in all cases and "circuitfactor_factor" of 1. The one missing information that I can see in the original app that is not here up until now is the current usage in W. I also started the diagnostic trace. How can I download that trace information?

config_entry-meross_lan-98f787ca444fe061299056061a3fddc6.json

[krahabb]

Awesome! The trace is saved under <HA config>custom_components/meross_lan/traces

[krahabb]

The History message looks like reporting the (instant?) power every 60 seconds over the last few minutes. At least, the timestamps of the reported values are spaced by 60 seconds ...

The ConsumptionH reminds me of the similar ConsumptionX usually reported by Meross metering plugs and is likely reporting the energy over last few hours together with total energy x channel (that should be easily implemented).

I think the last missing value (i.e. the actual power reading) is being reported by ElectricityX message which isn't correctly queried by standard euristics..I'll better check what else might be done to correctly query this. At any rate, it could also be PUSHED (asynchronously) by the device itself from time to time so, if we're in luck, the trace could report the layout of the message.

[cbergmann]

Hi, attached are traces from yesterday and today. Unfortunately they stop after a few minutes. Is there something I am doing wrong? traces.tar.gz

[krahabb]

I've released a preview with some (small) improvements on entities mapping for EM06. It is still unknown how to decode current power/current readings but I have patched a bit of the 'discovery/diagnostics' code hoping this new preview could better trace these messages (the candidate for this feature is Appliance.Control.ElectricityX namespace)

You could try install the preview and see if anything improves (the consumption readings should be there though). We'd then need to grab the 'Download diagnostics' again and see if we can extract better info with this new release.

[cbergmann]

Hi, I installed the preview version and got a new diagnostics file. At the first glance this has not helped but maybe you can see something in the file. When this does not help, maybe looking a little deeper into the vendors app might give some insight. config_entry-meross_lan-98f787ca444fe061299056061a3fddc6.json

[krahabb]

Hello, I've searched a bit the internet and found that Refoss has its own integration for HA. Nevertheless, it doesn't look very 'complete' and I don't really know how and if it works so I'm reverse engineering their python code to implement support for EM06 in meross_lan. I have 1 question though, if you're up to help with a bit of 'manual querying' before proceeding: In HA -> Developer Tools -> Services look for service named meross_lan.request and setup the parameters as follows:

• set the Device identifier or the Host address (whichever is easier to type)
• set the Method to GET
• set the Namespace to Appliance.Control.Electricity (more on this later)
• set the Payload to {"electricity": {}} (more on this later)

Now switch to YAML mode and correct the Namespace field to Appliance.Control.ElectricityX (this is needed because this namespace is not provided by the UI list...)

Now to the (verbose) details: I've found in the original Refoss code that the query payload should be {"electricity": {"channel":65535}} but this is actually 'hard' to implement in meross_lan because of a lot of euristics which (actually) don't expect this query format so, in order to implement this, I would need to introduce new euristics/rules but I don't want to do that if they're not necessary. So, if the {"electricity": {}} payload works then we're all happy and I'd quickly proceed to a 'simple' coding to add the namespace feature, else, if we really need to send {"electricity": {"channel":65535}} no problem, it will just take some more time (and add complexity to the code which I always try to avoid)

Having said that, you should try and see if any of these queries work and then post the service reply (I'm confident at least 1 should work) so that I have the correct payload response to inspect.

Thank you! (by the way, just curious: did you try to use the Refoss integration? if so did it work or not?)

[cbergmann]

Hi this is the result for "{\"electricity\": {}}":

request:
  header:
    messageId: fca51ded841b4746aeaa38435b74f56f
    namespace: Appliance.Control.ElectricityX
    method: GET
    payloadVersion: 1
    from: /appliance/meross_lan/publish
    timestamp: 1721722213
    timestampMs: 0
    sign: 726fb500e6620bb07acf8c4f4ca50e6a
  payload:
    electricity: {}
response:
  header:
    messageId: fca51ded841b4746aeaa38435b74f56f
    namespace: Appliance.Control.ElectricityX
    method: GETACK
    payloadVersion: 1
    from: /appliance/2401066372070174070148e1e9e92d1d/publish
    uuid: 2401066372070174070148e1e9e92d1d
    timestamp: 1721722213
    timestampMs: 384
    sign: 726fb500e6620bb07acf8c4f4ca50e6a
  payload:
    electricity:
      - channel: 1
        current: 0
        voltage: 233546
        power: 0
        mConsume: 1967
        factor: 0
      - channel: 2
        current: 576
        voltage: 232037
        power: 115523
        mConsume: 4878
        factor: 0.8636192083358765
      - channel: 3
        current: 0
        voltage: 232124
        power: 0
        mConsume: 59
        factor: 0
      - channel: 4
        current: 308
        voltage: 233777
        power: 770
        mConsume: 0
        factor: 0.010665059089660645
      - channel: 5
        current: 0
        voltage: 232290
        power: 0
        mConsume: 0
        factor: 0
      - channel: 6
        current: 335
        voltage: 232328
        power: -750
        mConsume: 0
        factor: -0.009644150733947754

and this is the result for "{\"electricity\": {\"channel\":65535}}"

request:
  header:
    messageId: f235da9ebe8d4a52bc8288465e5cdd31
    namespace: Appliance.Control.ElectricityX
    method: GET
    payloadVersion: 1
    from: /appliance/meross_lan/publish
    timestamp: 1721722301
    timestampMs: 0
    sign: 535cd26ec302c66ec9c27faaf190e5ad
  payload:
    electricity:
      channel: 65535
response:
  header:
    messageId: f235da9ebe8d4a52bc8288465e5cdd31
    namespace: Appliance.Control.ElectricityX
    method: GETACK
    payloadVersion: 1
    from: /appliance/2401066372070174070148e1e9e92d1d/publish
    uuid: 2401066372070174070148e1e9e92d1d
    timestamp: 1721722301
    timestampMs: 87
    sign: 535cd26ec302c66ec9c27faaf190e5ad
  payload:
    electricity:
      - channel: 1
        current: 0
        voltage: 233680
        power: 0
        mConsume: 1967
        factor: 0
      - channel: 2
        current: 574
        voltage: 233184
        power: 115185
        mConsume: 4881
        factor: 0.8602570295333862
      - channel: 3
        current: 0
        voltage: 232021
        power: 0
        mConsume: 59
        factor: 0
      - channel: 4
        current: 311
        voltage: 233748
        power: 324
        mConsume: 0
        factor: 0.004454255104064941
      - channel: 5
        current: 0
        voltage: 233313
        power: 0
        mConsume: 0
        factor: 0
      - channel: 6
        current: 339
        voltage: 232127
        power: -10
        mConsume: 0
        factor: -0.0001285076141357422

That looks good.

On your question about the Refoss integration: I looked into this but at that time i did not figure out a way to join the device to the WIFI without using the official app and therefore also using the refoss cloud. That was not an option for me. Now that You mentioned that I tried adding it and after fiddeling a little bit with my firewall I got it working. The only problem was that my HA and the device are on differnt networks. The Integration has no option to specify the IP and relies on sending a broadcast to port 9988. That would not reach the device and therefore setup would fail. When configuring iptables to rewrite the broadcast adress to the device adress before sending the udp datagram out the setup completes and everything works. It seems that the Refoss integration communicates via UDP directly. It queries for the information every 15 seconds and gets a reply with the information. This seems to remove the need for a local MQTT Server. If you are interested in implementing this protocol I have captured a pacap file containing the initial setup and the first minutes of updates. As this contains internal IP adresses and potentialy other sensetive information I am more than happy to send it to you via a secure channel.

[krahabb]

I didn't dig too much in the refoss-ha library supporting this but the traffic over UDP could just be the discovery part since I've found parts of code using 'standard' http traffic to query the device. At any rate, I would not go too far (at the moment) since the http stack should work correctly without many issues.

But the trace could become useful in the future...I've sent you a PM

[cbergmann]

I looked into the pcap files and it seems that your are right. The UDP datagrams are always the same and seem to only contain basic information. The main data seems to be transmitted via http.

[krahabb]

Updated pre-release. Beside the naive naming of some sensors it should work. I've removed the decoding of consumption hourly history since the statistics should be better available through HA.

The only 'open question', provided everything else works as expected, is the interpretation of the energy reading. HA has different configurations in order to manage the possible scenarios and these are more or less based off when (and if) the accumulated values resets from time to time (daily-monthly-yearly....) but I don't have a clear understanding of when the EM06 eventually resets these energy readings. The refoss-ha library uses the label/name "Monthly energy" so I would expect these energy values to reset every month but, even if this is a correct assumption, the reset could actually happen anytime: likely the start of the month but not surely.

We have to see what will happen on these.

At the moment I've just used state_class == total for the entity since the energy might flow in any direction if I'm correct and the meter (and HA statistics too) could then track energy import/export. Just, the code never tells HA if the value has been reset (start of new cycle)

[cbergmann]

Hi thanks again for the fast reply. I will monitor this information and give feedback what happens. Unfortunately I will be on vacation next week and might not have time to see if the reading changes.

Regarding energy flow it might be interesting that the original integration also adds a sensorsensor.em06_xx_this_month_energy_returned entity. I would think that this one would count if energy is flowing back to the provider but I can not see this because I currently don't have that in my setup.

If it helps I here is a screenshot of all the entities for one of the sensors of the original integration. This is the same for all 6 sensors (a1,b1,c1,a2,b2,c2).

[cbergmann]

Also I would suggest naming the entities with a1,b1,c1,a2,b2,c2 because the sensors on the device are labeld like this. This would make it more easy to identify which reading is from wich sensor.

[gponzo]

Hello, I'd like to read data from my em06 to publish it on EmonCMS. I've installed the integration on Home Assistant (temporary on a VM) and it works like a charm, so I tried inspecting the Python code, but I'm not so expert in this and after 3h of attempts decided to write here.

Would it be possible to have a simple sample code to gather infos via API?

I've tried this:

import requests
import json

request_data = {
    "header": {
        "messageId": "fca51ded841b4746aeaa38435b74f56f",
        "namespace": "Appliance.Control.ElectricityX",
        "method": "GET",
        "payloadVersion": 1,
        "from": "/appliance/meross_lan/publish",
        "timestamp": 1721722213,
        "timestampMs": 0,
        "sign": "726fb500e6620bb07acf8c4f4ca50e6a"
    },
    "payload": {
        "electricity": {}
    }
}

url = 'http://192.168.11.195'

try:
    # Sends the request
    response = requests.post(url, json=request_data)

    # Checks the answer
    if response.status_code == 200:
        print("Reply from the device:", response.json())
    else:
        print("Error in the request:", response.status_code, response.text)

except requests.exceptions.RequestException as e:
    print("Connection error:", e)

but the device replies this: 404 Nothing matches the given URI

I guess that in /appliance/meross_lan/publish I should probably replace meross_lan with the specific UUID which I don't know yet. I've just installed merossBLE but not yet tested on my device.

Could someone please help me? Thanks in advance!

[krahabb]

Hello @gponzo, in meross_lan, the low level interface to the device(s) is almost completely isolated inside the (sub)module custom_components/meross_lan/merossclient. This python module is totally 'isolated' from any HA api and so it could (or should) easily work as a standalone library to access the device. Specifically, the httpclient.py module contains the class responsible for managing the HTTP access. There you'll find all the helpers to build messages, sign, send, get replies and so.

Going back to your code, the first thing to check by the way is the url: devices respond to the http://hostaddress/config endpoint so you're missing a bit of the path in your example. As for the 'from' field in the message header it should not be relevant when using the HTTP endpoint. Some devices just complain if it's empty or not set at all but, generally, they don't care (over HTTP) since it's purpose is to tell the device which MQTT topic to use when replying to the request.

[gponzo]

Grazie @krahabb, I've just analyzed the code you suggested me, but unfortunately my knowledge on Python is not so deep. Anyway I'll try this evening to do some test.

Consider that I did git clone of the whole meross_lan repo. How should I invoke it? something like Python3.8 custom_components/meross_lan/merossclient(192.168.11.195) ? Please forgive my ignorance and, considering that this stuff could be boring for many here, feel free to contact me privately if you wish and prefer it (even in Italian ;--)

[krahabb]

Hey @gponzo,

I'm also not very expert with python running modules and stuff..I've just started learning python while developing meross_lan and, in the beginning, I was just copying over samples for HA components development so I'm a bit lost too when trying to use the code outside of HA. Anyway...

I suggest you a few steps (just tried and confirmed working):

• Run the code with python 3.12 (I'm not sure about compatibility with previous versions..it might work but...)
• Use vscode + docker desktop (if not yet) to set a friendly development environment (I'm using that on Windows)
• Clone the repo (already done that!)
• put a file named __main__.py in custom_components folder and start with

  
  import asyncio

from meross_lan.merossclient.httpclient import MerossHttpClient

async def async_main(): client = MerossHttpClient("192.168.1.70", key="")

response = await client.async_request("Appliance.System.All", "GET", {})
print(response)

response = await client.async_request("Appliance.Control.Electricity", "GET", {"electricity": {}})
print(response)

if name == "main": loop = asyncio.new_event_loop() loop.run_until_complete(async_main())

Once the file is in place you can either run it from vscode ('Run python file' from the top-right corner of the editor window) or, from the command line by just typing `python custom_components`

When initializing the MerossHttpClient, beside the host address, you have to provide the 'device key' (long story here if you don't know what I mean...but if you have installed and running in HA you can copy the device key from the configuration there)

The first request ("Appliance.System.All") works on every device and replies a general device status/config while the second one ("Appliance.Control.Electricity") is very specific for metering plugs (like mss310) and will not work on every device. For EM06 you should be good using "Appliance.Control.ElectricityX" instead (every other param is the same).

The `client.async_request` call will automatically create the 'header' part of the message based on 'namespace' and 'method' (will then use the current time and the configured key to fill all of the other header fields.
The 3rd parameter (dict) is the 'payload' part of the request

This could be a start for some experiments, feel free to ask more if any. As for the call we could arrange that on skype when you want.

[gponzo]

Thank you so much!

I've just tried creating main.py with the code you wrote, but when I run it I receive this error:

File "meross_lan/custom_components/meross_lan/__init__.py", line 337
    match ConfigEntryType.get_type_and_id(config_entry.unique_id):
          ^
SyntaxError: invalid syntax

I'm afraid that the previous line contains a referral to HomeAssistant:

336         for config_entry in hass.config_entries.async_entries(mlc.DOMAIN):
337             match ConfigEntryType.get_type_and_id(config_entry.unique_id):`

I didn't fill the key value: where can I find the device key in Home Assistant?

[krahabb]

I'm afraid that the previous line contains a referral to HomeAssistant:

Yep...I was scared of that since the package itself as a whole is an HA custom component so it has to have all of the dependencies installed (using pip install -r requirements_test.txt should automatically install all of these..but in the end it would be better to let vscode create the docker container for the environment..everything is then automatically configured) In order to 'break' these dependencies you'd have to copy the merossclient folder to a different path and use it as if it were a standalone package.

Getting some help here in order to correctly import everything I've tried this:

• create a folder for your project
• copy the merossclient folder inside that
• create a test.py in your project folder with:

  
  import asyncio

from merossclient.httpclient import MerossHttpClient

async def async_main(): client = MerossHttpClient("192.168.1.70", key="")

response = await client.async_request("Appliance.System.All", "GET", {})
print(response)

response = await client.async_request("Appliance.Control.Electricity", "GET", {"electricity": {}})
print(response)

if name == "main": loop = asyncio.new_event_loop() loop.run_until_complete(async_main())

- now you should have in your project folder:
-- test.py
-- merossclient (folder)
- at the command line you could use `python -m test`

> I didn't fill the key value: where can I find the device key in Home Assistant?

If you succesfully configured your EM06 in HA (so that's working) then you're done: enter the meross_lan integrations page and hit 'CONFIGURE' for the device entry. On the menu choose 'Configure' and you should see the device key there. This value was likely automatically retrieved from your Meross cloud account when you configured that in HA too - if you did it)

[gponzo]

No way :(

I've done what you wrote but I stil get an error:

File "merossclient/namespaces.py", line 97
    match name.split("."):
          ^

About the key, I've been able to configure and I'm using the em06 in Home Assistant, but via Refoss integration. Trying with Meross_lan it asks me a Meross account, which I don't have (I ahave a Refoss one but it doesn't accept it) or the UUID of the device which I don't have too (yet?). I've also attempted to find the key in the Refoss integration but with no luck.

I'm so frustrated about not being able to simply ask the info to this device... I've been inspecting Refoss integration code too, but I didn't find anywhere an http request...

[krahabb]

I don't understand the error tbh...what's the complete output (when you run the python -m .. script it should be verbose enough) ? My guess is the name value is empty or more likely None so the parser throws an error there. Maybe the namespaces.py file was 'corrupted' ?

I'm pretty sure my suggested approach is working (i'm testing it on the 'dev' branch but the 'master' one should be safer in this regard)

regarding the key, I've digged a bit into the refoss_ha repo and it is using an empty key (i.e. a void string: "") so that my example should work as is. Only, the ...Electricity namespace is likely not supported for the device and you should just plainly use ...ElectricityX instead.

As for the uuid it is normally not needed to communicate over http by Meross device and I guess it is not needed too for Refoss ones.

I'm curious about what happens when you try to configure the device in meross_lan. Which procedure are you following? the Meross account is only 'needed' to retrieve the device key in case you don't know it but in my understanding (so far...) you should be able to make it work by just providing the device ip/address and the key (empty as supposed by looking at the refoss_ha repo)

[gponzo]

Hi, sorry for being silent for so long...

That's the complete output:

Traceback (most recent call last):
  File "/usr/lib/python3.8/runpy.py", line 194, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "/usr/lib/python3.8/runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "/home/gabriele/dev/refoss_lan/test.py", line 3, in <module>
    from merossclient.httpclient import MerossHttpClient
  File "/home/gabriele/dev/refoss_lan/merossclient/__init__.py", line 14, in <module>
    from . import const as mc, namespaces as mn
  File "/home/gabriele/dev/Python/refoss_lan/merossclient/namespaces.py", line 97
    match name.split("."):
          ^
SyntaxError: invalid syntax

It tells about syntax... just like if the name object is not recognized...

About the code in namespace.py

My guess is the name value is empty or more likely None

I'd say that it enters that if block explicitly because the payload_get is None...

so the parser throws an error there

So the parser shouldn't rise an error, as if it is None it is expected, am I wrong?

     96         if payload_get is None:
     97             match name.split("."):
     98                 case (_, "Hub", *_):
     99                     self.payload_get_inner = _LIST
    100                     self.payload_type = list
    101                     self.need_channel = False
    102                 case (_, "RollerShutter", *_):
    103                     self.payload_get_inner = _LIST
    104                     self.payload_type = list
    105                     self.need_channel = False
    106                 case (
    107                     (_, "Control", "Thermostat", *_)
    108                     | (_, "Control", "Screen", *_)
    109                     | (_, "Control", "Sensor", *_)
    110                 ):
    111                     self.payload_get_inner = [{mc.KEY_CHANNEL: 0}]
    112                     self.payload_type = list
    113                     self.need_channel = True
    114                 case _:
    115                     self.payload_get_inner = _DICT
    116                     self.payload_type = dict
    117                     self.need_channel = False
    118         else:
    119             self.payload_get_inner = payload_get
    120             self.payload_type = type(payload_get)
    121             self.need_channel = bool(payload_get)
    122 
    123         self.key_channel = key_channel or (mc.KEY_ID if self.is_hub else mc.KEY_CHANNEL)
    124         self.has_get = has_get
    125         self.has_push = has_push
    126         NAMESPACES[name] = self

[gponzo]

Anyway I solved!!!

The solution is in this file: https://github.com/Refoss/refoss-homeassistant/blob/main/custom_components/refoss_lan/refoss_ha/device.py In particular in these lines:

        if self.device_type == "r10":
            path = f"http://{self.inner_ip}/config"
        else:
            path = f"http://{self.inner_ip}/public"

So, my final code is:

import requests
import json
import random
from hashlib import md5
import string

def randomstring():
        # Hash it as md5
        md5_hash = md5()
        md5_hash.update("".join(
        random.SystemRandom().choice(string.ascii_uppercase + string.digits)
                for _ in range(16)
            ).encode("utf8"))
        return md5_hash.hexdigest().lower()

# Dati della richiesta
request_data = {
    "header": {
#        "messageId": "fca51ded841b4746aeaa38435b74f56h",
        "messageId": randomstring(),
        "namespace": "Appliance.Control.ElectricityX",
        "method": "GET",
        "payloadVersion": 1,
        "from": "",
        "timestamp": 1721722213,
        "timestampMs": 0,
        "sign": "726fb500e6620bb07acf8c4f4ca50e6a"
    },
    "payload": {
        "electricity": {}
    }
}

# Indirizzo del tuo dispositivo
url = 'http://192.168.11.195/public'

try:
    # Invia la richiesta
    response = requests.post(url, json=request_data)

    # Controlla la risposta
    if response.status_code == 200:
        print("Risposta dal dispositivo:", response.json())
    else:
        print("Errore nella richiesta:", response.status_code, response.text)

except requests.exceptions.RequestException as e:
    print("Errore nella connessione:", e)

[krahabb]

Awesome! I didn't spotted that url 'patching' in the refoss-ha library...I wonder if current meross_lan code is working or not for those using the EM06. In fact, after initial issue raising I didn't have any more confirmation or reply...