[Release] WLED MQTT Driver (beta)

muxa · January 9, 2020, 9:25am

Is there anything in the logs that can help identify when this happens? In particular MQTT status.

jchurch · January 9, 2020, 9:47am

I have just turned on Hubitat debug logging on one of my WLEDs so I can monitor it. Btw I'm running the new WLED version 0.9.0-b1 (pre-release) have been since before Xmas but maybe that's part of the issue too. You tried that version? Still works perfectly fine in the WLED app always though.

EDIT: the other thought I had is I run MQTT on my Synology NAS so "maybe" its dropping off after a while. I have just configured RM to do a reconnect daily so I will see how that goes.

jchurch · January 10, 2020, 11:19pm

Seems to be working fine now I have RM reconnecting twice daily (morning and arvo) which is good. If I had to guess it's either the MQTT (pre-release) OR the Synology MQTT broker I am using.

EDIT: I kept having problems so in the end I had to remove the MQTT setup. I am sure it was my environment e.g. Synology running MQTT or something tho. If I ever deploy a seperate box to run MQTT I will try it again but for now I am trying to minimise additional components were I can.

razorface1978 · January 31, 2020, 9:09pm

Do you need am mqtt server for this to work

razorface1978 · January 31, 2020, 11:00pm

Just install the driver and play

welby1978 · January 31, 2020, 11:09pm

Sorry my bad i was thinking of the other WLED driver that i use, it dosn't require MQTT but this one does.

Have a look at this thread.

muxa · February 23, 2020, 7:39am

Here's an alternative driver implementation for WLED. The main difference is that it's configured via HA Discovery topic and available effects are loaded from the device instead of being hard-coded.

Note: it's using the same name, and is intended to replace the old driver.

github.com

muxa/hubitat/blob/master/drivers/wled-mqtt-light.groovy

/*
 * WLED Light 
 *  Device Driver for Hubitat Elevation hub
 *  Version 1.1.0
 *
 * Allows keeping device status in sync with WLED light (https://github.com/Aircoookie/WLED) and controlling it via MQTT broker.
 *
 * Known issues:
 * 1. When HE is restarted the HE device can't control WLED. Only after running Reconnect command it starts working. 
 *
 *  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License. You may obtain a copy of the License at:
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
 *  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
 *  for the specific language governing permissions and limitations under the License.
 * 
 */

This file has been truncated. show original

To configure you'll need to specify the MQTT Client ID that WLED is configured with.

Note: this driver has only been tested with WLED 0.8.6. Let me know if it works with newer versions too.

@jchurch I have not added alarm/strobe capability yet, but with this driver you should be able to set the the right theme by calling setEffect('Police') in Rule Machine.

muxa · February 23, 2020, 8:18am

Doh! I have just discovered that HA Discovery was removed in v0.9.0-b1, which means that the alternative driver won't properly.
Oh, well, will find a different method of loading effects from WLED device.

muxa · February 23, 2020, 8:54am

Update 1.1.0

Ok, here's an update to the original driver. With this update there's now ability to load available effects from the WLED device by calling configure with IP address of your WLED device.

Also improved MQTT reconnect to cap delay at 1 hour.

Tested with WLED v0.9.1

github.com

muxa/hubitat/blob/master/drivers/wled-light.groovy

/*
 * WLED Light 
 *  Device Driver for Hubitat Elevation hub
 *  Version 1.2.0
 *
 * Allows keeping device status in sync with WLED light (https://github.com/Aircoookie/WLED) and controlling it via MQTT broker.
 *
 * Known issues:
 * 1. When HE is restarted the HE device can't control WLED. Only after running Reconnect command it starts working. 
 *
 *  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License. You may obtain a copy of the License at:
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
 *  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
 *  for the specific language governing permissions and limitations under the License.
 * 
 */

This file has been truncated. show original

muxa · February 24, 2020, 6:12am

Update 1.2.0

Added palettes support:

with 2 new attributes paletteNumber and paletteName
with 2 new methods setPalette(string) to set palette by name or setPalette(int) to set palette by number.

To load available palettes please run configure(string) with the IP address of your WLED device.

crispycarlin · March 18, 2020, 10:40pm

How do i use a button press (or anything really) to have the wled change effects? I thought i had it figured but now I can't find the thing i'm looking for.

muxa · March 19, 2020, 5:29am

What you are looking for is "Run Custom Action" in the rule machine:

crispycarlin · March 19, 2020, 4:29pm

There it is. Thank you.

EVOXGSR · April 2, 2020, 5:00pm

muxa appreciate the WLED mqtt driver.

While I do not have mqtt integration I found your driver helpful in creating a non-mqtt version.

I ran across one issue with setPreviousEffect
The numbers would cycle down until 1 and then it would jump to 100 bypassing 0.

I was able to correct this by changing the 1s to 0s

def setPreviousEffect(){
def currentEffectId = device.currentValue("effectNumber") ?: 0
currentEffectId--
if (currentEffectId < 0)
currentEffectId = state.effects.size() - 1
setEffect(currentEffectId)
}

While I am not using your exact driver, I assume the downward number skip of 0 would be the same.

muxa · April 3, 2020, 9:15pm

Update 1.2.1

Fixed setPreviousEffect skipping 0

Thanks @EVOXGSR for pointing this out.

crispycarlin · April 3, 2020, 9:30pm

Your welcome, but i think @EVOXGSR is the real hero here.

muxa · April 3, 2020, 9:44pm

Oops
Updated

pat.richards · July 17, 2020, 9:32pm

OK how do add a new device using this driver do I create a virtual device?

sky320 · July 18, 2020, 5:11am

Yes, you must create a virtual device

crispycarlin · September 25, 2020, 4:03am

I'm now very successfully using this driver on 6 WLED devices.

Thank you Muxa.

A question: Using the group topic in WLED one can control all devices at the same time. This works but I can't add this virtual device to Google Home. I suspect because there is no IP address (tried using one of the device's IP). Any thoughts?