Skip to main content

Controller - Xiaomi WXCJKG12LM Aqara Opple 4 button remote

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 blueprint provides universal support for running any custom action when a button is pressed on the provided Xiaomi WXCJKG12LM Aqara Opple 4 button remote. Supports controllers integrated with deCONZ, ZHA, Zigbee2MQTT. Just specify the integration used to connect the remote to Home Assistant when setting up the automation, and the blueprint will take care of all the rest.

In addition of being able to provide custom actions for every kind of button press supported by the remote, the blueprint allows to loop the long press actions while the corresponding button is being held. Once released, the loop stops. This is useful when holding down a button should result in a continuous action (such as lowering the volume of a media player, or controlling a light brightness).

tip

Automations created with this blueprint can be connected with one or more Hooks supported by this controller. Hooks allow to easily create controller-based automations for interacting with media players, lights, covers and more. See the list of Hooks available for this controller for additional details.

Requirements​

deCONZ Integration

Optional

If you plan to integrate the with deCONZ, you must have this integration set up. The deCONZ integration can be configured from the Home Assistant UI and requires an additional container to run deCONZ on. Head over to the documentation for full details on the required hardware and how to set up deCONZ on your system.

deCONZ Integration Docs

ZHA Integration

Optional

If you plan to integrate the with ZHA, you must have this integration set up. The ZHA integration can be configured from the Home Assistant UI. Check the documentation for full details on the required hardware and how to set up ZHA on your system.

ZHA Integration Docs

Zigbee2MQTT Integration

Optional

If you plan to integrate the with Zigbee2MQTT, you must have this integration set up. Installation methods differ between different installation types. Check out the documentation for full details on the required hardware and how to set up Zigbee2MQTT on your system.

Zigbee2MQTT Docs

Input Text Integration

Required

This integration provides the entity which must be provided to the blueprint in the Helper - Last Controller Event input. Learn more about this helper by reading the dedicated section in the Additional Notes.

Input Text Integration Docs

Inputs​

Integration Select Required

Integration used for connecting the remote with Home Assistant. Select one of the available values.

Controller Device Device deCONZ, ZHA Required

The controller device to use for the automation. Choose a value only if the remote is integrated with deCONZ, ZHA.

Controller Entity Entity Zigbee2MQTT Required

The action sensor of the controller to use for the automation. Choose a value only if the remote is integrated with Zigbee2MQTT.

Helper - Last Controller Event Entity Required

Input Text used to store the last event fired by the controller. You will need to manually create a text input entity for this, please read the blueprint Additional Notes for more info.

Button 1 short press Action Optional

Action to run on short button 1 press.

Button 1 long press Action Optional

Action to run on long button 1 press.

Button 1 release Action Optional

Action to run on button 1 release after long press.

Button 1 double press Action Optional

Action to run on double button 1 press.

Button 1 triple press Action Optional

Action to run on triple button 1 press.

Button 2 short press Action Optional

Action to run on short button 2 press.

Button 2 long press Action Optional

Action to run on long button 2 press.

Button 2 release Action Optional

Action to run on button 2 release after long press.

Button 2 double press Action Optional

Action to run on double button 2 press.

Button 2 triple press Action Optional

Action to run on triple button 2 press.

Button 3 short press Action Optional

Action to run on short button 3 press.

Button 3 long press Action Optional

Action to run on long button 3 press.

Button 3 release Action Optional

Action to run on button 3 release after long press.

Button 3 double press Action Optional

Action to run on double button 3 press.

Button 3 triple press Action Optional

Action to run on triple button 3 press.

Button 4 short press Action Optional

Action to run on short button 4 press.

Button 4 long press Action Optional

Action to run on long button 4 press.

Button 4 release Action Optional

Action to run on button 4 release after long press.

Button 4 double press Action Optional

Action to run on double button 4 press.

Button 4 triple press Action Optional

Action to run on triple button 4 press.

Button 1 long press - loop until release Boolean Optional

Loop the button 1 action until the button is released.

Button 1 long press - Maximum loop repeats Number Optional

Maximum number of repeats for the custom action, when looping is enabled. Use it as a safety limit to prevent an endless loop in case the corresponding stop event is not received.

Button 2 long press - loop until release Boolean Optional

Loop the button 2 action until the button is released.

Button 2 long press - Maximum loop repeats Number Optional

Maximum number of repeats for the custom action, when looping is enabled. Use it as a safety limit to prevent an endless loop in case the corresponding stop event is not received.

Button 3 long press - loop until release Boolean Optional

Loop the button 3 action until the button is released.

Button 3 long press - Maximum loop repeats Number Optional

Maximum number of repeats for the custom action, when looping is enabled. Use it as a safety limit to prevent an endless loop in case the corresponding stop event is not received.

Button 4 long press - loop until release Boolean Optional

Loop the button 4 action until the button is released.

Button 4 long press - Maximum loop repeats Number Optional

Maximum number of repeats for the custom action, when looping is enabled. Use it as a safety limit to prevent an endless loop in case the corresponding stop event is not received.

Helper - Debounce delay Number Optional

Delay used for debouncing RAW controller events, by default set to 0. A value of 0 disables the debouncing feature. Increase this value if you notice custom actions or linked Hooks running multiple times when interacting with the device. When the controller needs to be debounced, usually a value of 100 is enough to remove all duplicate events.

Available Hooks​

Light​

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.

Default Mapping​

  • Button 1 short press -> Turn on
  • Button 1 long press -> Brightness up (continuous, until release)
  • Button 1 double press -> Color up
  • Button 2 short press -> Turn off
  • Button 2 long press -> Brightness down (continuous, until release)
  • Button 2 double press -> Color down

Mapping #2​

  • Button 3 short press -> Turn on
  • Button 3 long press -> Brightness up (continuous, until release)
  • Button 3 double press -> Color up
  • Button 4 short press -> Turn off
  • Button 4 long press -> Brightness down (continuous, until release)
  • Button 4 double press -> Color down

Light Hook docs

Media Player​

This Hook blueprint allows to build a controller-based automation to control a media player. Supports volume setting, play/pause and track selection.

Default Mapping​

  • Button 1 short press -> Volume up
  • Button 1 long press -> Volume up (continuous, until release)
  • Button 1 double press -> Next track
  • Button 2 short press -> Volume down
  • Button 2 long press -> Volume down
  • Button 2 double press -> Play/Pause

Mapping #2​

  • Button 3 short press -> Volume up
  • Button 3 long press -> Volume up (continuous, until release)
  • Button 3 double press -> Next track
  • Button 4 short press -> Volume down
  • Button 4 long press -> Volume down
  • Button 4 double press -> Play/Pause

Media Player Hook docs

Cover​

This Hook blueprint allows to build a controller-based automation to control a cover. Supports opening, closing and tilting the cover.

Default Mapping​

  • Button 1 short press -> Open cover
  • Button 1 long press -> Open the cover tilt
  • Button 2 short press -> Close cover
  • Button 2 long press -> Close the cover tilt
  • Button 2 double press -> Stop cover and cover tilt

Mapping #2​

  • Button 3 short press -> Open cover
  • Button 3 long press -> Open the cover tilt
  • Button 4 short press -> Close cover
  • Button 4 long press -> Close the cover tilt
  • Button 4 double press -> Stop cover and cover tilt

Cover Hook docs

Additional Notes​

Helper - Last Controller Event​

The helper_last_controller_event (Helper - Last Controller Event) input serves as a permanent storage area for the automation. The stored info is used to implement the blueprint's core functionality. To learn more about the helper, how it's used and why it's required, you can read the dedicated section in the Controllers-Hooks Ecosystem documentation.

Changelog​

  • 2021-12-03: first blueprint version 🎉
  • 2022-08-08: Optimize characters usage for the helper_last_controller_event text input.