🧯 Zigbee2MQTT - Xiaomi Cube Controller

leonkunst88 · January 11, 2023, 6:46am

Thanks for you quick responses! I’m thinking, isn’t it possible to check if there is an action_angle in the payload? If yes, use that, if not, use angle?

Sir_Goodenough · January 12, 2023, 5:29pm

My update here will be exactly that. They both hold the same information. Just inconsistencies in implementation by the driver author(s).

Add Notes about angle vs action_angle.
HINT: (Either will work, use the one that you see in the sensor list.)

Fnordcorps1 · January 19, 2023, 10:27am

Hi - just a note for anyone experiencing the same problem as me - I was getting an error in the trace saying the template had failed

I had an underscore in my entity name in Zigbee2mqtt (Funcube_Office)

After trying out various things I changed the entity name in Z2M to FuncubeOffice and also in the automation topic and this solved the problem.

Thanks for the blueprint @Sir_Goodenough

Also - not sure if I was doing something wrong but I could not get my HA to see an entity for ‘last action trigger’ you mention in the docs. Do I need to set anything up to use this or should it just appear?

Sir_Goodenough · January 19, 2023, 7:28pm

I’m not sure wherein the Docs you are referring to. There have been several iterations of this blueprint and older versions my have referred to that sensor. This version uses MQTT triggering to get the ‘event’ captured.
Perhaps a link to the paragraph you are referring to would help?

Fnordcorps1 · January 20, 2023, 11:33am

This bit in your original post. But as you say I can use the mqtt message so no problem.

Thanks again

Sir_Goodenough · January 26, 2023, 8:12am

Added new Blueprint for the Pro Cube.

Zigbee2MQTT Aqara Magic Cube T1-Pro CTP-R01 Xiaomi Lumi cagl02

This Blueprint gives you literally hundreds of actions available on the new Magic Cube.

Gerben321 · January 28, 2023, 11:35am

Thanks for this blueprint. However, I just can’t get it to work. I keep getting the error that the entity ID must be given. I set the Topic like how it should be . So ‘zigbee2mqtt/Aqara Cube’ and it just doesn’t work. What am I missing here? I tried to press the link on how to find the topic in the blueprint but it gives me a 404.

Sir_Goodenough · January 28, 2023, 6:25pm

No spaces or punctuation in the topic to make this work.

github.com

SirGoodenough/HA_Blueprints/blob/bbe62e771bae287f5868b621e07992c3f6b946f8/Automations/Zigbee2MQTT-Xiaomi_Cube_Controller_MQTT_Triggered.md#-to-make-the-blueprint-work-it-will-need

(128 possible actions!!) Works with MQTT Directly bypassing both Legacy and non-Legacy trigger issues. Uses a Zigbee2MQTT built MQTT sensor to sort out the 38(+54) commands available from the Xiaomi Magic Cube. This gives you the ability to trigger actions using the remote. NOTICE: Using this Blueprint and example scripts, this cube *can* be triggered 98 ways, but only 38(+54) of them are unique...

## 📑 Changelog

* **2022-12-28**: Code cleanup.
* * Add note to fix configuration conflict template error:
* * Update angle configuration text to help with config errors.  No Code Change.
* *  **Error while executing automation automation.friendly_name_automations: TemplateError: Must provide a device or entity ID**
* **2022-12-22**: Change instances of the attribute ```angle``` to ```action_angle``` to fix non-legacy bug.
* * Add note not to use spaces and non alpha in MQTT topics.
* **2022-12-12**: Add Update Method Note, minor code change.
* * Name of Blueprint may have changed meaning you have to re-download with a new link.
* * If name changed, it is similar. Variables have not changed.
* **2022-12-04**: Re-did the backend to use MQTT instead of the Z2M Legacy configuration.
* * This removes the legacy trigger requirement and makes it respond much faster.
* * Old version Deprecated and available on the original Github link but will be no longer supported.
* * Old Github link still works if you need it for something...
* **2022-05-05**: Updated for 2022.5.0 HA. Added Markdown to !input Descriptions plus shortcut or.
* **2022-04-26 update-B**: UPDATE: No code changes. Added examples to provide another 30 more ways to trigger something using conditionals in Group 3 🍐,
* **2022-04-26 update-A** UPDATE: No code changes. Added examples to provide 24 more ways to trigger something using the rotate sensor as a device toggle, both long and short for each rotate sensor.

This file has been truncated. show original

Gerben321 · January 28, 2023, 6:38pm

Thanks, that’s what I figured. Is there any way I can get a suitable MQTT topic without renaming my devices in Z2M? I would like to use ‘Aqara Cube’ as name and maybe use ‘aqara_cube’ as topic for example.

How come spaces don’t work? I’ve made a blueprint for dimming lights with a Friends of Hue switch, and I use spaces in those blueprints without issues.

Sir_Goodenough · January 28, 2023, 7:21pm

Use the method mentioned in the instructions to change the name. Clicking the update HA box will set the Friendly names for you. The entity name will not change in HA.
This naming problem is a by-product of the BP making the helper file for you and not having to deal with legacy mode or not legacy mode in the Z2M setup, both of which caused problems before.
There may be a better way that I can deal with spaces and punctuation and I may eventually figure that out, but for now, this is the only way it works.

New Version:

Changelog

2023-03-01: Add Author Tag. Bump HA required Version to 2023-3-0

smefa · March 10, 2023, 9:30am

Thanks, this solved my issue too.
Got stuck in the trace with Aqara_Cube, AcaraCube works

redding43 · April 17, 2023, 8:00am

I am struggling as a bit new to all of this.

If I understand correctly I find the cube in ZHA, which I have done. I assume I then need to disable ZHA and go back to using Z2M and find the device again?

I have added the helper and the Blueprint but when I try to automate using the Blueprint it does not show the cube as an option (I can see the cube in HA when I search for devices otherwise)

Sir_Goodenough · April 17, 2023, 8:57pm

What integration are you using?
I have blueprints available for both ZHA and for Z2m.
Pick the right blueprint to match the integration you have installed the cube into.
All my Blueprints are listed in the end of the top post.

Sir_Goodenough · April 24, 2023, 7:28am

I have added 3 new script blueprints to replace the yaml scripts I had offered as samples before. I have also cleaned the coding up on these and simplified them.
They may now be suitable for use in other people Blueprints and/or your bare automation to help with light dimming with the cube, color change with the cube, and simulating long / short button press with the cube.
I am now working on one to do volume control.

Cube Light Dimming:

Cube Color Change:

Cube Long/Short Press Simulation:

unicon · April 24, 2023, 8:37am

Same here. No errors visible. But the automation didn’t work. I renamed my device in z2m as cube01 instead of switch.cube01 (i.e. removed the full stop / period) and it worked. Thank you!

unicon · April 24, 2023, 9:09am

Dimming blueprint - you should change the sensitivity description. It looks like it should take whole numbers. But if you use the default 40 for sensitivity, it becaomse 40x not 40%. So you need to input via YAML as 0.4 to get something reasonable!

Sir_Goodenough · April 24, 2023, 5:52pm

Oops…
Pulled the wrong variable down…
Should be fixed now…
It;s meant to have the whole percentage in the top to make it easier for people to understand.

Good catch, sorry for the bobo.

IamDan · May 30, 2023, 7:21am

I have a dumb question. I am trying to use the cube as dimmer. Clockwise will brighten the light no problem, however it does not dim counter clockwise. Am I missing something?

Sir_Goodenough · May 30, 2023, 9:50am

The examples I provide work for me. Check your code closely, there might be a typo in the CCW action or something.
It could even be in my code, I don’t always test 100% after updates. That one got a few updates recently.

IamDan · May 30, 2023, 10:18am

Reading from the instructions, should it not just read the angle as negative and dim? Im sorry if I am incorrect, your blueprint looks like amazing work. Its just so big and complicated for new users. Not a complaint, just an observation from a new user of your blueprint.

EDIT: So I am an idiot. I wasnt using a minus sign ( - ) for my angle