Adding an effect to light bulb

Can anyone point me to a resource that describes how the “Effect” dropdown shown below is populated and how I can further extend it with more effects?

I’m trying to extend some Philips Hue lightbulbs via quirk to support firmware built-in effect such as candelight and fireplace. Right now I can trigger them as ZHA command, but that’s not really user friendly. Having the effects in dropdown and just being able to select one would be the best way to achieve this, but I haven’t found any example of a device that has more than the preset colorloop in there.

You set the effect_list property as a list of strings.

See…

2 Likes

please tell me you found a solution?

1 Like

Is there documentation about the supported light effects for different manufacturers?
Not lucky finding this.

1 Like

Where do you do this though? It’s not clear to me from the link above.

Can it be done so that all lights of a certain type have a list effects assigned to them? I have 17 Philips Hue White Ambiance Downlights, so it would be good to define the available effects at a global level.

Go in Developer tools and search for your Hue lights (one should be enough if they’re all the same model).
You’ll see the effect list in the attributes:

1 Like

Thank you. For the single RGB light that I have, it only lists “Off, colorloop”:

I edited the above to add the Hue built-in effects as shown here (https://hueblog.com/2024/08/30/philips-hue-plans-four-new-effects-for-its-light-sources/) but as soon as I turned the light on, the list was reset.

For the White Ambiance lights, there is nothing:

This is odd since I’m sure the White Ambiance lights support some of the effects.

All my lights are new enough, (bought in the last 2-3 weeks) and support both Zigbee and Bluetooth, to support the effects.

Is it possible to add the built-in Hue effects to HA or does HA somehow read the light’s capability?

I don’t use a Hue Bridge so am not sure if the effects are linked to use of that.

You can’t just add the new effects in the developer tools and expect them to work.

They need to be added to your devices via the ZigBee integration you’re using, either as part of a release or by adding a quirk yourself

1 Like

Oh, I see. I thought that HA was reading the device capabilities. “Colorloop” is presumably an HA effect that could work with any RGB light, not just Philips Hue?

My assumption (which could be completely wrong) is that the effects are built into the Hue Downlights, but maybe they are built into the Hue Hub which then controls the lights. Do you happen to know which is correct?

Edit: do you have Hue lights? If so, where did the list effects that you have in post #6 come from?

Most of those assumptions are incorrect. Let me try to clarify:

Colorloop is not an HA effect that works with any RGB light. The device (or rather, the integration exposing the device) needs to expose it.

For that to happen, you have two three options:

  • Wait until someone submits a PR for the integration (I’m guessing in your case it’s ZHA) with the updated effect list for your bulbs. This would then be rolled out to everyone on the release after the PR is merged.
  • Create your own custom quirk for these lights, as mentioned in the first post. This would be only available to you, and you’d need to write a quirk for each different model (not per device).
  • Switch to using Zigbee2Mqtt instead of ZHA as your zigbee integration. Depending on your exact bulb model, you should get plenty more effect options out of the box. Eg. this random white ambience bulb supports the following effects out of the box: blink, breathe, okay, channel_change, candle, finish_effect, stop_effect, stop_hue_effect

No, I do not have any Hue lights. That list of effects is a random Tuya CCT bulb I bought from Lidl. Z2M exposed those effects without me having to do anything.

1 Like

Thank you @ShadowFist, that all makes much more sense now.

Your guess is correct, I am using ZHA.

I’ve been thinking about this but am going to stick with ZHA in order to prevent my brain from frying. I think I need to be rather more well versed in ZHA before attempting to change to a different system.

I did install ZHA Toolkit and use the scan_device command to try and gleen some more information about my Hue lights but very little was forthcoming. Other devices that I own from Aqara and Clipsal Wiser returned much more information.

Is it possible to view the source for the Z2M quirk (are they called quirks for Z2M?) to see how the effects are implemented with a view to potentially porting them to ZHA? I had a look around but couldn’t find anything but it’s highly likely that I missed it.

I’m not entirely sure that is correct, but also not incorrect since I found this:

in the Zigbee Cluster Library Specification R8 (Revision 8), which seems to imply it is not Philips Hue specific.

I stand corrected :slight_smile: