Skip to main content

Hook - Light

Import this blueprint

My Home Assistant

Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.
(Home Assistant 2021.3.0 or higher)

Direct Link

tip

This blueprint is part of the Controllers-Hooks Ecosystem. You can read more about this topic here.

Description​

This Hook blueprint allows to build a controller-based automation to control a light. Supports brightness and color control both for white temperature and rgb lights.

info

An automation created with this blueprint must be linked to a Controller automation. Controllers are blueprints which allow to easily integrate a wide range of controllers and use them to run a set of actions when interacting with them. They expose an abstract interface used by Hooks to create controller-based automations.

See the list of Controllers supported by this Hook for additional details.

Requirements​

Controller Automation

Required

To use this blueprint you need to first create an automation with a Controller blueprint. You can then create an automation with this Hook, making sure that you provide the same controller device or entity used in the corresponding Controller blueprint. This key step will link the two automations and ensure the Hook will respond to events fired by the Controller.

List of Supported Controllers - Controllers Docs

Light Integration

Required

This integration provides the entity which represents a light in Home Assistant. It should be activated by default so unless you tweaked the default configuration you're good to go.

Light Integration Docs

Inputs​

Controller Device Device Required

The controller device which will control the Light. Choose a value only if the integration used to connect the controller to Home Assistant exposes it as a Device. This value should match the one specified in the corresponding Controller automation.

Controller Entity Entity Required

The controller entity which will control the Light. Choose a value only if the integration used to connect the controller to Home Assistant exposes it as an Entity. This value should match the one specified in the corresponding Controller automation.

Controller model Select Required

The model for the controller used in this automation. Choose a value from the list of supported controllers.

Light Entity Required

Light which will be controlled with this automation.

Light color mode Select Optional

Specify how the controller will set the light color. Choose "Color Temperature" and "Hue - Saturation" depending on the features supported by your light. If you are not sure you can select "Auto". "None" will disable color control features.

Light Transition Number Optional

Number that represents the time (in milliseconds) the light should take turn on or off, if the light supports it.

Light minimum brightness Number Optional

The minimum brightness the light can be set with this automation.

Light maximum brightness Number Optional

The maximum brightness the light can be set with this automation.

Light brightness steps - short actions Number Optional

Number of steps from min to max brightness when controlling brightness with short actions (eg. button press).

Light brightness steps - long actions Number Optional

Number of steps from min to max brightness when controlling brightness with long actions (eg. button hold or controller rotation).

Force brightness value at turn on Boolean Optional

Force brightness to the "On brightness" input value, when the light is being turned on.

On brightness Number Optional

Brightness value to force when turning on the light

Smooth power on Boolean Optional

Force the light to turn on at minimum brightness when a brightness up command (single or continuous) is triggered and light is off.

Smooth power off Boolean Optional

Allow a brightness down command (single or continuous) to turn off the light when at minimum brightness. Disabling this will prevent the light from being turned off by brightness down commands.

Supported Controllers​

Additional Notes​

If you want to link multiple lights to the same controller you can either use Light Groups or build multiple Hooks linked to the same Controller.

Changelog​

  • 2021-03-04: first blueprint version 🎉
  • 2021-03-07: add support for IKEA E1744 SYMFONISK rotary remote
  • 2021-03-14: add support for IKEA E1812 Shortcut button, fix E1743 naming
  • 2021-03-25: update action mapping for IKEA E1744. If you're using this Hook with an IKEA E1744, please update also the corresponding Controller blueprint
  • 2021-03-26:
    • set minimum and maximum light brightness
    • specify number of steps from min to max brightness, both for short and long actions, when controlling the light
    • allow to force brightness to a specific value when turning on the light
  • 2021-03-27: add support for Philips Hue dimmer switch
  • 2021-04-06: fix light color modes not allowing to configure an automation with color temperature control.
  • 2021-04-15:
    • add smooth power on/off features
    • breaking change: by default the light now turns off when a brightness down command is received and light is at minimum brightness. To disable this behaviour, turn off the smooth power off feature.
    • fix some optional fields name.
  • 2021-04-19: remove unused variable, fix warnings for undefined variables in Home Assistant Core >=2021.4.0
  • 2021-05-16: Add support for Osram SMART+ Switch Mini
  • 2021-07-03: Add support for Philips Hue Smart Button
  • 2021-08-02: Improve inputs documentation and organization
  • 2021-10-26:
    • Standardize blueprints structure and inputs naming across the whole collection.
    • Improve blueprint documentation.
    • 🎉 Add support for alternate mappings. Additional mappings for currently supported controllers will be added from now on. Refer to the documentation of your controller for more details.
    • ⚠️ Breaking Change: update controller names in the Controller Model input, to match the full name of controllers, prevent ambiguities and enable support for alternate mappings. After updating this blueprint, please reconfigure your automations by selecting again the value for the Controller Model input, matching the full name of the controller you're using with this hook.
    • Fix for remembering brightness level when turning on, where brightness level unavailable when light off.
    • Added secondary mapping for IKEA E1743 TRÅDFRI On/Off Switch & Dimmer
  • 2021-10-29: Add support for IKEA E1766 TRÅDFRI Open/Close Remote.
  • 2021-11-07:
    • Add support for IKEA E2001/E2002 STYRBAR Remote control.
    • Fix color mode automatic detection not working properly with color temperature lights.
    • Add "None" color mode to completely disable color control features.
  • 2021-11-21: Add support for Philips 929002398602 Hue Dimmer switch v2.
  • 2021-12-03: Add support for Xiaomi WXCJKG11LM, WXCJKG12LM, WXCJKG13LM.
  • 2021-12-05: Added secondary mapping for IKEA E2001/E2002
  • 2022-07-22: Add support for Xiaomi WXKG11LM.
  • 2022-07-30: Add support for SONOFF SNZB-01.