Control LEDs and LED Effects on Inovelli Black, Red, and Blue Devices by Floor, Area, Group, Device ID, or Entity

Blueprints Exchange
, , , ,
3

@kschlichter I’m trying to use the script version with LZW-31SN switches (1.61 firmware). It just isn’t working at all for me. If I use the blueprint version I can get them to change color, but effects don’t seem to work. I’m not sure what I’m doing wrong.

Edit: Actually, I was wrong. It doesn’t work with blueprints either. The only thing that works are the “color when on” and “color when off” settings

service: script.1708468893547
data:
  device:
    - 5f68f034d2c137aa5dc15acb1bc5f91a
  duration: Forever
  effect: Solid
  brightness: "11"
  color: Green
4

The maximum brightness is 10. The code isn’t executed if the brightness is set to 11. This is so that you can change the effect or color without changing the brightness (which might be set by a separate day / night automation).

By the way, the LZW31-SN doesn’t have a “color when off” option so that code will be skipped unless you also have a VZW31-SN (Red 800 Series) or VZM31-SN (Blue Series).

 Setting the LED indicator
   LEDcolor: (int or string) Sets color of status LED.  If LEDcolor_off is defined and supported by the device, this is only used for "on" status.
   LEDbrightness: (whole integer 1 – 10) Sets the brightness of the status LED.  If LEDbrightness_off is defined and supported by the device, this is only used for "on" status.
   LEDbrightness_off: (whole integer 1 – 10) Sets the brightness of the status LED when off, for devices that support this feature.
   LEDcolor_off: (int or string) Sets color of status LED when off, for devices that support this feature.
     Note that the Blue 2-in-1 switch/dimmer and Red 2-in-1 switch/dimmer support separate colors for on and off while the Black 500 and Red 500 Series devices do not.

 Required for setting LED effects
   duration: (string or whole integer of seconds) Either "Off", an integer of seconds, or a whole integer followed by "Seconds", "Minutes", "Hours", "Indefinitely", or "Forever".
   effect: (string) Where older devices don't support a new effect, that effect has been mapped to something that is supported.
   brightness: (integer 1 – 10) Sets the brightness of the LED's effect
   color: (string) Sets color of LED effect.

Try this:

service: script.1708468893547
data:
  device:
    - 5f68f034d2c137aa5dc15acb1bc5f91a
  duration: Forever
  effect: Solid
  brightness: 10
  color: Green
5

That was it. I didn’t actually change the brightness, just left it as what the default was set to. But shouldn’t it have still changed the color and just left the brightness alone? Or did I misunderstand what you meant.

6

Hmm… You did not misunderstand me; I said the wrong thing. For effects it needs everything set. For the LED status bar you can send bits and pieces. It wouldn’t be hard to enable that for effects, if that’s something you think would be valuable. The quirky bit is that any changes reset the timer. If you have a 30sec effect in green and change it to red with 10sec left, it’ll restart the timer and you’ll have red for 30sec.

Anyway, I could modify the script this weekend to accept incomplete changes for effects. Right now it’s just for the LED status bar.

7

Thanks, it isn’t something I really need, just trying to understand.

8

Is there any way to select individual LEDs?

I have a couple of VZM35-SN (Blue Fan Switch) and can control each LED using Zanix blueprint. Do you have any idea if that is even possible through scripts or blueprints for the VZW31-SN?

9

All VZM and VZW devices do support that feature. I could certainly add that. I have a pretty good idea of how I would do it and I don’t think it would be complicated. I don’t have any so I would need someone to check a beta release for me and ensure everything is working. It’ll be a few weeks before I have a free weekend again but I bet I could do this by the end of the month. I just haven’t done it before because I thought it would clutter the UI, which is already burdened with a lot of options, but maybe that isn’t necessarily the case.

Let me know if you’re willing to beta test something for me near the end of the month.

10

@kschlichter This blueprint has stopped working for me after upgrading to Zigbee2MQTT version 1.36.0-1. After upgrading, the script doesn’t cause the LED colors to change, although all other functions of the switch still seem to work within HA.

After downgrading back to version 1.35.3-1, it works again. I tested upgrading and downgrading a couple times and every time I upgrade the LED functions stop working, and they start working again right after downgrading.

I don’t see any errors in the logs. Here is an example of a log entry after running a script using the blueprint.

Zigbee2MQTT:info 2024-03-05 15:51:14: MQTT publish: topic 'zigbee2mqtt/Front Porch Lights', payload '{"action":null,"activeEnergyReports":10,"activePowerReports":10,"autoTimerOff":0,"auxSwitchUniqueScenes":null,"bindingOffToOnSyncLevel":null,"brightness":254,"brightnessLevelForDoubleTapDown":null,"brightnessLevelForDoubleTapUp":null,"buttonDelay":"0ms","defaultLed1ColorWhenOff":255,"defaultLed1ColorWhenOn":255,"defaultLed1IntensityWhenOff":101,"defaultLed1IntensityWhenOn":101,"defaultLed2ColorWhenOff":255,"defaultLed2ColorWhenOn":255,"defaultLed2IntensityWhenOff":101,"defaultLed2IntensityWhenOn":101,"defaultLed3ColorWhenOff":255,"defaultLed3ColorWhenOn":255,"defaultLed3IntensityWhenOff":101,"defaultLed3IntensityWhenOn":101,"defaultLed4ColorWhenOff":255,"defaultLed4ColorWhenOn":255,"defaultLed4IntensityWhenOff":101,"defaultLed4IntensityWhenOn":101,"defaultLed5ColorWhenOff":255,"defaultLed5ColorWhenOn":255,"defaultLed5IntensityWhenOff":101,"defaultLed5IntensityWhenOn":101,"defaultLed6ColorWhenOff":255,"defaultLed6ColorWhenOn":255,"defaultLed6IntensityWhenOff":101,"defaultLed6IntensityWhenOn":101,"defaultLed7ColorWhenOff":255,"defaultLed7ColorWhenOn":255,"defaultLed7IntensityWhenOff":101,"defaultLed7IntensityWhenOn":101,"defaultLevelLocal":254,"defaultLevelRemote":254,"deviceBindNumber":null,"dimmingSpeedDownLocal":127,"dimmingSpeedDownRemote":25,"dimmingSpeedUpLocal":127,"dimmingSpeedUpRemote":25,"doubleTapClearNotifications":"Disabled","doubleTapDownToParam56":null,"doubleTapUpForFullBrightness":"Button Press Event + Set Load to 100%","doubleTapUpToParam55":null,"energy":0.87,"firmwareUpdateInProgressIndicator":"Enabled","higherOutputInNonNeutral":null,"individual_led_effect":null,"internalTemperature":null,"invertSwitch":"No","ledBarScaling":null,"ledColorWhenOff":170,"ledColorWhenOn":170,"ledIntensityWhenOff":0,"ledIntensityWhenOn":100,"led_effect":{"color":0,"duration":255,"effect":"off","level":40},"linkquality":72,"loadLevelIndicatorTimeout":"5 Seconds","localProtection":"Disabled","maximumLevel":254,"minimumLevel":60,"onOffLedMode":"All","outputMode":"Dimmer","overheat":null,"periodicPowerAndEnergyReports":10,"power":0,"powerType":null,"quickStartFan":null,"quickStartLightLevel":null,"quickStartLightTime":null,"rampRateOffToOnLocal":0,"rampRateOffToOnRemote":0,"rampRateOnToOffLocal":0,"rampRateOnToOffRemote":0,"relayClick":"Enabled (Click Sound Off)","remoteProtection":null,"smartBulbMode":"Disabled","state":"OFF","stateAfterPowerRestored":255,"switchType":"Single Pole","update":{"installed_version":16908815,"latest_version":16908815,"state":"idle"},"update_available":null}'

11

@soonerfan237, in “developer tools” → template, if you replace my light entity in the template below with your light entity, what does it give you?

{{ device_attr('light.guest_room_lights_level','model') }}

12

It gives:

Inovelli 2-in-1 switch + dimmer (VZM31-SN)

13

That’s with version 1.36? It looks like Inovelli may have renamed the device so I was thinking it might end up with nothing to send because the script can’t find a device with the exact name it’s looking for.

Can you send me the Home Assistant trace from the script or blueprint (whichever you’re using)?

14

Sorry, that was the output from the downgraded version. Here is the output from version 1.36. Looks like the name did change.

2-in-1 switch + dimmer (VZM31-SN)

15

Inovelli changed the device name. I can update this pretty easily but I’m swamped at work right now so it might take me until the weekend. Can you hold off on the update until then?

Are you using the blueprint or the script? I can tell you how to modify it quickly using the script. I don’t use blueprints though, so I don’t know if a way to modify the backend code for them.

–
Note to @kschlichter - Don’t forget to check the Red 800 series to see if they changed too.

16

That’s totally fine - thank you for the help!

17

I wasn’t going to be able to let this go so I’ve made the changes. Would you mind testing it in script form with both Zigbee2MQTT 1.35 and 1.36? I want to make sure it picks up both the old and new device names so people don’t need to worry about forward / backward compatibility. I’ve typed out steps for you below, in case you need them. It would really help me out. I don’t have any Blue Series devices. If this works, I can publish a new blueprint tomorrow.

  • In Home Assistant:
    • Click on “Settings” in the left-hand navigation pane.
    • “Automations & Scenes”
    • “Scripts” near the top in a horizontal menu / tab.
    • Blue, “+ Add Script” button in the lower-right.
    • “Create new script”
    • In the upper-right click the vertical ellipsis (three dot) menu and then “edit in Yaml”.
    • Delete the pre-populated lines.
  • Open a new tab
  • In Github (beta script)
    • Since this hasn’t been merged into master yet, in the left-hand nav pane, under files, there’s a drop-down that says “master”. Change that to “Zigbee2MQTT-Inovelli-Device-Name-Change”.
    • On the right side, click the “copy raw file” in between the “raw” and “download” buttons.
  • In Home Assistant:
    • Paste the contents into the Yaml editor.
    • In the vertical ellipsis select “Edit in Visual Editor”
    • Blue, “Save Script” button in the lower right.

To test the script, you can use “developer tools” → “Services” and type “Inovelli LED Settings and Effects” to use the UI, and “Go to Yaml Mode” to see the code for automations. That code can be modified with templates.

18

I can confirm that this is working for me. Thank you for the quick response!

19

Thanks for this amazing blueprint/script! Would it be possible to enhance this to support using the Hubitat integration as well? I’m running HA in a VM and using that integration to expose my Hubitat-connected devices to HA via the Maker API.

I’d love to be able to make a group of Inovelli switches (as exposed via the Hubitat integration) within HA and have this script send the appropriate commands to each device in the group. My group would be mixing and matching various Inovelli switch models, of course.

20

I’ve published this release. Update the blueprint and let me know if you run into any issues. I don’t use blueprints so I’m not sure if there’s something I need to do for the “import” button to update.

21

I don’t have Hubitat so I’d need you to do all the testing. The first step would be to figure out what the service calls look like for Z-Wave and Zigbee devices. From there it’s probably just a lot of copy / paste. Once you have that, open an issue on GitHub and we’ll go from there.

# Zwave JS
- service: zwave_js.set_config_parameter
  data:
    entity_id: "{{ repeat.item.entities }}"
    parameter: >-
      {% set effect_param = repeat.item.device_type + '_ledbrightness_off' %} 
      {{ "off" if parameters[effect_param] == 0 else parameters[effect_param] }}
    value: "{{ LEDbrightness_off }} "

# Zigbee2mqtt
- service: mqtt.publish
  data:
    topic: >-
      zigbee2mqtt/{{ states[repeat.item].attributes.friendly_name }}/set
      payload: >-
        { "ledIntensityWhenOff": {{ (LEDbrightness_off * 256 / 10) }} }
22

If anyone has a Red 800 Series “2-in-1” device, I could use some help testing some new code to enable brightness in steps of 1 instead of 10. Previously the script and blueprint could only set brightness to 10%, 20%, … 100%. The new code will set it from 1% to 100% in steps of one for Red 800 Series and Blue Series devices. I don’t have any Red 800 Series devices to test.

Red 500 Series and Black 500 Series are limited by the device to only support steps of 10% so this feature doesn’t apply to these devices.

Beta code to test

How to import and test:

  • In Home Assistant:
    • Click on “Settings” in the left-hand navigation pane.
    • “Automations & Scenes”
    • “Scripts” near the top in a horizontal menu / tab.
    • Blue, “+ Add Script” button in the lower-right.
    • “Create new script”
    • In the upper-right click the vertical ellipsis (three dot) menu and then “edit in Yaml”.
    • Delete the pre-populated lines.
  • Open a new tab
  • In Github (“Beta code to test” link above)
    • Since this hasn’t been merged into master yet, in the left-hand nav pane, under files, there’s a drop-down that says “master”. Change that to “Zigbee2MQTT-Inovelli-Device-Name-Change”.
    • On the right side, click the “copy raw file” in between the “raw” and “download” buttons.
  • In Home Assistant:
    • Paste the contents into the Yaml editor.
    • In the vertical ellipsis select “Edit in Visual Editor”
    • Blue, “Save Script” button in the lower right.

To test the script, you can use “developer tools” → “Services” and type “Inovelli LED Settings and Effects” to use the UI, and “Go to Yaml Mode” to see the code for automations.