Shelly Device Handlers for Hubitat

LeDo · April 27, 2023, 2:06pm

Kk I'll set everything up and provide the data

dmitry.rozovik · April 28, 2023, 9:34am

I updated driver with Pro 3 EM code in the repo. But I cannot test it. So I assume by default that there are issues

Driver should spawn 4 child devices: Phase A, Phase B, Phase C and Total. For now I did not exposed aparent power and returned energy readings. Also neutral wire current value is not exposed.

To properly spawn child devices:
0. Enable debug logging to see all the request and responses in the device log

Set IP and save settings
Press 'Configure'.

'Configure' clears all previous child devices, polls device for all the componets and their instance counts, spawns child devices according to the fetched info, opens web socket connection and sends status request over it to start getting device notifications.

Ideally there should be no errors
If by chance everything will work as you expect, you may disable debug logging.

LeDo · April 28, 2023, 12:59pm

Ok I removed the device and added it anew. I dont think it connects properly

I get an error importing the driver code

Logs

dmitry.rozovik · April 28, 2023, 1:06pm

You picked only a single file. Driver uses libraries and custom generic component devices (due to the lack of needed capabilities in the builtin generic driver set).

You either need to install libraries listed at the driver code top, or simply take the whole bundle (as a single operation). Taking bundle is simpler: go to the bundle tab on the left; there will be import button that will ask you for a ZIP file. ZIP-file contains all the dependencies inside.

Bundle can be downloaded from repo and uploaded. Or it can be uploaded directly from repo URL copying link from

If you want to install driver manually, then you will need 4 child device drivers and 3 library files.

LeDo · April 28, 2023, 9:14pm

Ok connected to the device,

No child devices present. We have readings. Im still waiting for my solar plant so the sensors aren't attached... but that's no problem I believe... no child devices

2023-04-28 23:13:13.961info(null) Meter generic report: Electric:voltage - 234.2V

dev:322023-04-28 23:13:13.960info(null) Meter generic report: Electric:voltage - 0.1V

dev:322023-04-28 23:13:13.958info(null) Meter generic report: Electric:voltage - 0.1V

dev:322023-04-28 23:13:13.957info(null) Phase C power factor 1.00

dev:322023-04-28 23:13:13.955info(null) Phase B power factor 1.00

dev:322023-04-28 23:13:13.954info(null) Phase A power factor 1.00

dev:322023-04-28 23:13:13.952info(null) Meter generic report: Electric:amperage - 0.082A

dev:322023-04-28 23:13:13.951info(null) Meter generic report: Electric:amperage - 0.027A

dev:322023-04-28 23:13:13.949info(null) Meter generic report: Electric:amperage - 0.027A

dev:322023-04-28 23:13:13.948info(null) Meter generic report: Electric:amperage - 0.028A

dev:322023-04-28 23:13:13.946info(null) Meter generic report: Electric:power - -0.135W

dev:322023-04-28 23:13:13.945info(null) Meter generic report: Electric:power - -0.1W

dev:322023-04-28 23:13:13.943info(null) Meter generic report: Electric:power - 0.0W

dev:322023-04-28 23:13:13.942info(null) Meter generic report: Electric:power - 0.0W

dev:322023-04-28 23:13:13.939info(null) parseShellyEnergyMeterStatus [a_act_power:0.0, b_aprt_power:0.0, b_act_power:0.0, total_current:0.082, n_current:null, total_act_power:-0.135, a_voltage:0.1, c_current:0.027, b_current:0.027, a_current:0.028, b_voltage:0.1, a_aprt_power:0.0, c_voltage:234.2, a_pf:1.00, c_aprt_power:6.2, total_aprt_power:6.241, id:0, c_pf:1.00, b_pf:1.00, c_act_power:-0.1]

dev:322023-04-28 23:13:10.959info(null) Meter generic report: Electric:voltage - 234.2V

dev:322023-04-28 23:13:10.957info(null) Meter generic report: Electric:voltage - 0.1V

dev:322023-04-28 23:13:10.956info(null) Meter generic report: Electric:voltage - 0.1V

dev:322023-04-28 23:13:10.954info(null) Phase C power factor 1.00

dev:322023-04-28 23:13:10.953info(null) Phase B power factor 1.00

dev:322023-04-28 23:13:10.951info(null) Phase A power factor 1.00

dev:322023-04-28 23:13:10.950info(null) Meter generic report: Electric:amperage - 0.083A

dev:322023-04-28 23:13:10.948info(null) Meter generic report: Electric:amperage - 0.028A

dev:322023-04-28 23:13:10.947info(null) Meter generic report: Electric:amperage - 0.027A

dev:322023-04-28 23:13:10.945info(null) Meter generic report: Electric:amperage - 0.028A

dev:322023-04-28 23:13:10.944info(null) Meter generic report: Electric:power - -0.05W

dev:322023-04-28 23:13:10.942info(null) Meter generic report: Electric:power - 0.0W

dev:322023-04-28 23:13:10.941info(null) Meter generic report: Electric:power - 0.0W

dev:322023-04-28 23:13:10.939info(null) Meter generic report: Electric:power - 0.0W

dev:322023-04-28 23:13:10.937info(null) parseShellyEnergyMeterStatus [a_act_power:0.0, b_aprt_power:0.0, b_act_power:0.0, total_current:0.083, n_current:null, total_act_power:-0.050, a_voltage:0.1, c_current:0.028, b_current:0.027, a_current:0.028, b_voltage:0.1, a_aprt_power:0.0, c_voltage:234.2, a_pf:1.00, c_aprt_power:6.5, total_aprt_power:6.477, id:0, c_pf:1.00, b_pf:1.00, c_act_power:0.0]

dmitry.rozovik · April 28, 2023, 9:37pm

I will investigate tomorrow.
Good news is that WS stream is live. Device sends reports as expected. Component names turned to be correct. The issue is strictly in missing child devices (to which to put these readings).

Would be helpfull to see log of "Configue" operation (when button is pressed). There could be some usefull error.
And component list from the bottom of the driver (to see how exactly EM and EMData components were detected)

LeDo · April 29, 2023, 6:09am

No problem everything You need to get this going.

Logs spat few errors

dev:322023-04-29 08:04:35.135info(null) parseShellyEnergyMeterStatus [a_act_power:0.0, b_aprt_power:0.0, b_act_power:0.0, total_current:0.081, n_current:null, total_act_power:-0.185, a_voltage:0.1, c_current:0.027, b_current:0.027, a_current:0.028, b_voltage:0.1, a_aprt_power:0.0, c_voltage:234.5, a_pf:1.00, c_aprt_power:6.3, total_aprt_power:6.258, id:0, c_pf:1.00, b_pf:1.00, c_act_power:-0.2]

dev:322023-04-29 08:04:34.464infoDevice updates [:]

dev:322023-04-29 08:04:33.206errorCan't get device status for null: Bad Request

dev:322023-04-29 08:04:33.195infoparseShellyCloudStatus [connected:true]

dev:322023-04-29 08:04:33.192errorjava.lang.NullPointerException: Cannot get property 'value' on null object on line 895 (method parse)

dev:322023-04-29 08:04:33.170infoparseShellyCloudStatus [connected:true]

dev:322023-04-29 08:04:33.122errorjava.lang.NullPointerException: Cannot get property 'value' on null object on line 890 (method parse)

dev:322023-04-29 08:04:33.050errorjava.lang.NullPointerException: Cannot get property 'value' on null object on line 895 (method parse)

dev:322023-04-29 08:04:33.038errorjava.lang.NullPointerException: Cannot get property 'value' on null object on line 890 (method parse)

dev:322023-04-29 08:04:32.980infoWS query: {"params":{id:0}, "id":40, "method":"EMData.GetStatus", "src":"hub"}

dev:322023-04-29 08:04:32.958infoWS query: {"params":{id:0}, "id":30, "method":"EM.GetStatus", "src":"hub"}

dev:322023-04-29 08:04:32.940infoHTTP query: Wifi.GetStatus([:])

dev:322023-04-29 08:04:32.925infoHTTP query: Shelly.CheckForUpdate([:])

dev:322023-04-29 08:04:32.909infoHTTP query: Cloud.GetStatus([:])

dev:322023-04-29 08:04:32.869infoWS query: {"params":{id:0}, "id":40, "method":"EMData.GetStatus", "src":"hub"}

dev:322023-04-29 08:04:32.859infoWS query: {"params":{id:0}, "id":30, "method":"EM.GetStatus", "src":"hub"}

dev:322023-04-29 08:04:32.851infoHTTP query: Wifi.GetStatus([:])

dev:322023-04-29 08:04:32.847infoHTTP query: Shelly.CheckForUpdate([:])

dev:322023-04-29 08:04:32.841infoHTTP query: Cloud.GetStatus([:])

dev:322023-04-29 08:04:32.828errorconfigure: No signature of method: user_driver_drozovyk_Shelly_Plus_Pro_xPM_591.getMeterDevice() is applicable for argument types: (java.lang.Short) values: [1]
Possible solutions: getMeterDevices(java.lang.Short), getCoverDevice(java.lang.Short), getInputDevice(java.lang.Short), getMeterDeviceName(java.lang.Short, int), getSwitchDevice(java.lang.Short). Can't configure child devices. Please, re-try.

Device details

dmitry.rozovik · April 29, 2023, 11:09am

I updated the driver with fixes. Just reimport the bundle (no need to reinstall device itself)

Configured device should look now somethin like this

Thanks to your logs I was able to emulate device notifications locally. Also I added powerFactor attribute to the child defices.

Readings that are currently not supplied to any attribute are 'aparent power' and ' returned energy'. Also per-channel error are not reported. These can be added later taking into account desired use case scenario.

Also atm there were no notifications regarding energy (as according to the device documentation such notification should arrive when device stores accumulated energy readings in the internal memory).

LeDo · April 29, 2023, 12:29pm

I'll try to test it today. Hope it works😃

Ok looks good

Although I got a warning

dmitry.rozovik · April 29, 2023, 3:16pm

I suspect this might be caused by the device notification frequency. Should be configurable on the device itself (notification interval and notification threshold.. something like that)

LeDo · April 29, 2023, 3:26pm

Event history? Nothing else seems to influence reporting

dmitry.rozovik · April 29, 2023, 3:28pm

No. Not in the driver but on the device itself.

LeDo · April 29, 2023, 3:33pm

Nothing like that sadly

dmitry.rozovik · April 29, 2023, 3:52pm

Try to check event history to identify what specific events were spammed. It shows mainly Phase-C channel. So it might be related to some line activity.

In general my Pro2PM sends notifications once a minute. Events are not trigerred because values mostly remain unchanged. ECO mode has no effect on this.

Actually might be a good idea to contact Shelly to get more info on this.

I will try to change ping interval for websocket connection in case it might have some relation.
(Update: no effect from pingInterval change, so it's completely on device side)

LeDo · April 29, 2023, 4:22pm

The sensors aren't atached maybe that's cosing the traffic.

dmitry.rozovik · April 29, 2023, 4:27pm

Not sure if traffic is caused by missing sensors. But rather values might fluctuate due to this reason. And fluctuating values may be the reason of atribbute change events.

Anyway looking at event history you can see what specific attributes are constantly changing.

dmitry.rozovik · May 3, 2023, 4:51pm

Small announcement : I'm experimenting with Shelly script component. Somewhere closer to the upcoming weekend I'm planning to update my driver with this feature.

If device has configured scripts, driver will spawn new child devices accordingly. Each such device has commands to start/stop/refresh corresponding script (attribute for the current status). And attribute for the arbitrary data, sent from script to hub. This attribute is from 'Variable' device capability. Any Hubitat app that can work with 'variables' can benefit from it.

Script sample (JavaScript on the Pro2PM) and generated trafic:

let alertTimer = null;

function startTimer() {
  let timeStep = 10* 1000; // 10S
  alertTimer = Timer.set(timeStep, true, function (ud) {
    Shelly.emitEvent("ping", "ping_event_data");
  }, null );
}

startTimer()

info(Shelly Pro 2PM Test script 1) Script event [component:script:1, data:ping_event_data, id:1, event:ping, ts:1683132133.01]
info(Shelly Pro 2PM Test script 1) Script event [component:script:1, data:ping_event_data, id:1, event:ping, ts:1683132123.01]

Example use case: It is possible to filter power/energy reports by the shelly device schedule to emulate reporting of the electricity for multizone tariff.

In fact the absolute majority of such logic can be made with RM. Just a way to distribute computational load if such solutions looks more convinient.

dmitry.rozovik · May 5, 2023, 1:13pm

Driver is updated:
Added Shelly digest authentification support
Added script support

LeDo · May 16, 2023, 7:17pm

Hi I've managed to setup everything in my solar palnt. Shelly pro meter is running like crazy.

Is it possible to add longer refresh times to the driver?

Logs

dev:322023-05-16 21:15:41.315info(null meter 1 Phase C) Meter generic report: Electric:voltage - 234.2V

dev:322023-05-16 21:15:41.299info(null meter 1 Phase B) Meter generic report: Electric:voltage - 234.6V

dev:322023-05-16 21:15:41.282info(null meter 1 Phase A) Meter generic report: Electric:voltage - 233.7V

dev:322023-05-16 21:15:41.265info(null meter 1 Phase C) Meter generic report: Electric:powerFactor - 1.0cos(φ)

dev:322023-05-16 21:15:41.249info(null meter 1 Phase B) Meter generic report: Electric:powerFactor - 1.0cos(φ)

dev:322023-05-16 21:15:41.234info(null meter 1 Phase A) Meter generic report: Electric:powerFactor - 0.05cos(φ)

dev:322023-05-16 21:15:41.218info(null meter 1 Total) Meter generic report: Electric:amperage - 0.338A

dev:322023-05-16 21:15:41.201info(null meter 1 Phase C) Meter generic report: Electric:amperage - 0.113A

dev:322023-05-16 21:15:41.185info(null meter 1 Phase B) Meter generic report: Electric:amperage - 0.11A

dev:322023-05-16 21:15:41.169info(null meter 1 Phase A) Meter generic report: Electric:amperage - 0.115A

dev:322023-05-16 21:15:41.154info(null meter 1 Total) Meter generic report: Electric:power - -1.834W

dev:322023-05-16 21:15:41.136info(null meter 1 Phase C) Meter generic report: Electric:power - -0.9W

dev:322023-05-16 21:15:41.121info(null meter 1 Phase B) Meter generic report: Electric:power - 0.3W

dev:322023-05-16 21:15:41.105info(null meter 1 Phase A) Meter generic report: Electric:power - -1.2W

dev:322023-05-16 21:15:41.102info([null meter 1 Phase A, null meter 1 Phase B, null meter 1 Phase C, null meter 1 Total]) parseShellyEnergyMeterStatus [a_act_power:-1.2, b_aprt_power:25.7, b_act_power:0.3, total_current:0.338, n_current:null, total_act_power:-1.834, a_voltage:233.7, c_current:0.113, b_current:0.110, a_current:0.115, b_voltage:234.6, a_aprt_power:26.8, c_voltage:234.2, a_pf:0.05, c_aprt_power:26.5, total_aprt_power:78.999, id:0, c_pf:1.00, b_pf:1.00, c_act_power:-0.9]

dev:322023-05-16 21:15:39.538warnUnknown NotifyStatus wifi={rssi=0, sta_ip=null, ssid=null, status=connecting}

dev:322023-05-16 21:15:39.532infoNotifyEvent event [reason:201, component:wifi, event:sta_connect_fail, ts:1684264540.24]

dev:322023-05-16 21:15:38.337info(null meter 1 Phase C) Meter generic report: Electric:voltage - 234.2V

dev:322023-05-16 21:15:38.322info(null meter 1 Phase B) Meter generic report: Electric:voltage - 234.4V

dev:322023-05-16 21:15:38.306info(null meter 1 Phase A) Meter generic report: Electric:voltage - 233.6V

dev:322023-05-16 21:15:38.289info(null meter 1 Phase C) Meter generic report: Electric:powerFactor - 1.0cos(φ)

dev:322023-05-16 21:15:38.273info(null meter 1 Phase B) Meter generic report: Electric:powerFactor - 1.0cos(φ)

dev:322023-05-16 21:15:38.257info(null meter 1 Phase A) Meter generic report: Electric:powerFactor - 0.05cos(φ)

dev:322023-05-16 21:15:38.241info(null meter 1 Total) Meter generic report: Electric:amperage - 0.339A

dev:322023-05-16 21:15:38.223info(null meter 1 Phase C) Meter generic report: Electric:amperage - 0.112A

dev:322023-05-16 21:15:38.206info(null meter 1 Phase B) Meter generic report: Electric:amperage - 0.111A

dev:322023-05-16 21:15:38.190info(null meter 1 Phase A) Meter generic report: Electric:amperage - 0.115A

dev:322023-05-16 21:15:38.172info(null meter 1 Total) Meter generic report: Electric:power - -1.632W

dev:322023-05-16 21:15:38.143info(null meter 1 Phase C) Meter generic report: Electric:power - -0.9W

dev:322023-05-16 21:15:38.125info(null meter 1 Phase B) Meter generic report: Electric:power - 0.2W

dev:322023-05-16 21:15:38.107info(null meter 1 Phase A) Meter generic report: Electric:power - -0.9W

dev:322023-05-16 21:15:38.104info([null meter 1 Phase A, null meter 1 Phase B, null meter 1 Phase C, null meter 1 Total])

dmitry.rozovik · May 16, 2023, 7:36pm

There are no refresh time as such. These are device initiated reports.

I'll try to add thresholds on a driver side to ignore incoming data accordingly

P.S.: I've made a ticket to Shelly support regarding this topic around a week ago requesting ability to control these reports. No feedback on the matter.