Philips Hue Smart Button - Support Request

[Mincka]

Hello,

I bought a Philips Hue Smart Button and I would like to use it with deCONZ / Home Assistant.
URL: https://www2.meethue.com/en-us/p/hue-smart-button/046677553715

It was a bit tricky to pair it with deConz / Conbee II (multiple resets where required) but I finally managed to do it.

I enabled the advanced log but I did not seen anything for the node address when pressing the button, only the following lines are referencing the address.

11:41:01:668 APS-DATA.indication srcAddr: 0xfea4, srcEp: 0x00 dstAddrMode: 2, profile: 0x0000, cluster: 0x8002, lqi: 255, rssi: -53
11:41:01:668 APS-DATA.indication request id: 143 -> finished
11:41:01:668 APS-DATA.request id: 143 erase from queue
11:41:01:668 ZDP status = 0x00 -> SUCCESS
11:41:01:668 ZDP Node_Descriptor_rsp 0x001788010606815C - 0xFEA4
11:41:01:673 FP indication 0x0000 / 0x8002 (0x001788010606815C / 0xFEA4)
11:41:01:673                       ...     (0x001788010606815C / 0xFEA4)
11:41:01:673 ZDP indication search sensors 0x001788010606815C (0xFEA4) cluster 0x8002
11:41:01:673 ZDP indication search sensors 0x001788010606815C (0xFEA4) clear timeout on cluster 0x8002
11:41:01:679 [2] get active endpoints for 0x001788010606815c
11:41:01:679 APS-DATA.request id: 147, addrmode: 0x02, addr: 0xfea4, profile: 0x0000, cluster: 0x0005, ep: 0x00 -> 0x00 queue: 0 len: 3 tx.options 0x00
11:41:01:746 skip device discovery while end devices is added

Let me know if I can provide any additional information about the device.

Thanks for your help. 😄

[ebaauw]

Hm, it looks like a ZigBee 3.0 version of the Hue dimmer switch, with both endpoints combined. I see they have an EU version of this new switch as well (may only different wall plate?), but none of my regular webshops carry that (yet?).

Whitelisting the device is simple, the trick will be to find out if it reports the buttons on the server 0xfc00 cluster (like the Hue dimmer when paired with the Hue bridge), on the client On/Off and Level Control clusters (like the Hue dimmer switch when paired directly to a light), or maybe both (with some magic setting of 0x0000/0x0031). We'd probably need a sniffer log of the device being paired to a Hue bridge.

If you have a Hue bridge: could you please list the REST API resource(s) it creates for the switch? I asked the same question in the Hue developer's forum.

[Mincka]

Thank you for your quick reply.

Here is the info from the bridge:

"87": {
	"state": {
		"buttonevent": 1002,
		"lastupdated": "2019-11-16T11:48:24"
	},
	"swupdate": {
		"state": "noupdates",
		"lastinstall": "2019-11-16T10:54:58"
	},
	"config": {
		"on": true,
		"battery": 100,
		"reachable": true,
		"pending": []
	},
	"name": "Hue Smart button 2",
	"type": "ZLLSwitch",
	"modelid": "ROM001",
	"manufacturername": "Philips",
	"productname": "Hue Smart button",
	"diversityid": "8b18a40c-eb6a-40d7-a0af-eb0906613d41",
	"swversion": "2.21.0_r29784",
	"uniqueid": "00:17:88:01:06:06:81:5c-01-fc00",
	"capabilities": {
		"certified": true,
		"primary": true,
		"inputs": [
			{
				"repeatintervals": [
					800
				],
				"events": [
					{
						"buttonevent": 1000,
						"eventtype": "initial_press"
					},
					{
						"buttonevent": 1001,
						"eventtype": "repeat"
					},
					{
						"buttonevent": 1002,
						"eventtype": "short_release"
					},
					{
						"buttonevent": 1003,
						"eventtype": "long_release"
					}
				]
			}
		]
	}
}

It looks like that additionnal virtual sensors are created to maintain the different states:

"82": {
	"state": {
		"status": 1,
		"lastupdated": "none"
	},
	"config": {
		"on": true,
		"reachable": true
	},
	"name": "dimDirection",
	"type": "CLIPGenericStatus",
	"modelid": "HUELABSENUM",
	"manufacturername": "Philips",
	"swversion": "1.0",
	"uniqueid": "2:10:9237-6fb7-4329-9315",
	"recycle": true
},
"83": {
	"state": {
		"status": 1,
		"lastupdated": "none"
	},
	"config": {
		"on": true,
		"reachable": true
	},
	"name": "isDimming",
	"type": "CLIPGenericStatus",
	"modelid": "HUELABSENUM",
	"manufacturername": "Philips",
	"swversion": "1.0",
	"uniqueid": "2:11:9cc2-2e04-4b05-9e3b",
	"recycle": true
},
"84": {
	"state": {
		"status": 0,
		"lastupdated": "none"
	},
	"config": {
		"on": true,
		"reachable": true
	},
	"name": "slotState",
	"type": "CLIPGenericStatus",
	"modelid": "HUELABSENUM",
	"manufacturername": "Philips",
	"swversion": "1.0",
	"uniqueid": "0:12:496a-10d7-46fa-936c",
	"recycle": true
},
"85": {
	"state": {
		"status": 1,
		"lastupdated": "none"
	},
	"config": {
		"on": true,
		"reachable": true
	},
	"name": "cycling",
	"type": "CLIPGenericStatus",
	"modelid": "HUELABSENUM",
	"manufacturername": "Philips",
	"swversion": "1.0",
	"uniqueid": "3:13:d595-91ab-439a-ad81",
	"recycle": true
},

[ebaauw]

Here is the info from the bridge:

Thanks, that's very useful. Looking at the uniqueid it reports the buttonevent values on cluster 0xfc00. I'll see if I can whitelist the sensor and re-use the logic for the Hue dimmer switch.

Could you try and (in deCONZ) create a group, add a light to that group, and then bind the client On/Off cluster to that group? With luck, the switch should be able to control the light directly, without help from the gateway.

It looks like that additionnal virtual sensors are created to maintain the different states:

Yes, these are created by the Hue labs formulae. You'll probably find matching rules and resourcelinks. Getting Hue labs (and more generally, the Hue app) to run on deCONZ is a different story (much related to API differences for groups and scenes).

[Mincka]

Can you explain me how to "bind the client On/Off cluster to that group"?

I am not sure how to do this since I usually don't do it with deCONZ directly.

I am using Hass.io with Phoscon and deCONZ. The Smart Button is not appearing yet as a switch in Phoscon.
I paired my Philips Hue Dimmer to a Test group (n°3) in Phoscon, with key bindings and it works properly.

I found the "Bind Dropbox" panel and tried the following:

I tried with of the clusters of the Smart Button, it's not switching the smart plug but it may be interesting to know that there is a LED feedback of the button with FC00 cluster. After a bind, first click gives a solid red for 2 seconds, then each push gives a short green light feedback. The short green flash feedback is the default behavior when using the Hue hub.

Edit: I tried with the On/Off cluster and with Group "3".
Edit 2: I tried to bind On/Off cluster of the Dimmer Switch with the On/Off cluster of the Smart Plug and it works properly. I just don't have such "On/Off" cluster for the Smart Button.

[Mincka]

There is another "issue". After a few minutes, the Button goes in "deep sleep". It is not available in deCONZ and it's not possible to wake up it by pressing the button for a short or long period. A reset is mandatory and a new pairing must be done.

[ebaauw]

Clusters come in pairs:

• The device being controlled implements the server (blue) cluster;
• The controlling device implements the client (grey) cluster.

A binding tells a device (Source) where (Destination) to send messages associated with the cluster:

• Either a (list of) unicast(s) to (an)other device(s), where you specify the IEEE address and endpoint by dragging and dropping the endpoint (not the cluster);
• Or a groupcast, where you specify the group ID, by selecting the radio button and edit the group id in hex.

There's nothing magical about a binding, its just a configuration on the source device. Unfortunately, the deCONZ GUI doesn't support querying the binding table, so there's no easy way to check bindings. Most devices have limited (non-volatile) memory for the binding table, so a single binding to a group is preferred over multiple bindings to individual devices.

Now here's the tricky part:

• Client clusters send commands to the associated server cluster. Typically you want to use a groupcast message for these, so you'd create a binding from a client (grey) cluster to a group;
• Server clusters send notifications (reports) about their (changed) state. Typically you want a unicast message for these, so you'd create a binding from a server (blue) cluster to (typically) the coordinator (RaspBee/ConBee).

Now here's the really tricky part:

• A physical device typically implements multiple functions (clusters) and might be the controller for one function and, at the same time, the controlled device for another function. This is actually the case for the Hue dimmer (and, I assume, the smart button), see below;
• The same logical function might be implemented differently by different devices. Typically Hue and Xiaomi devices act as controlled devices, sending notifications to the bridge/gateway, whereas Trådfri and most other devices act as controllers, sending commands to (a group of) lights. In other words: Xiaomi switches behave like sensors and the Trådfri motion sensors behave like wireless switches. The device type might give a clue, but better check the clusters to be sure.

Now here's the really, really tricky part: The Hue dimmer and, I assume, the Hue smart button are hybrids:

• When paired with the Hue bridge, they act as a sensor, sending notifications about the buttonevent to the bridge.
• When used standalone, they act as wireless switch, sending commands to the bound (group of) lights.

This is reflected well by device types on the Hue dimmer endpoints: Non color scene controller on endpoint 0x01 (with the client On/Off and Level control clusters) vs Simple sensor on endpoint 0x02 (with the server 0xfc00 cluster).

So you need the following bindings for the Hue dimmer and, I assume, the Hue smart button:

• From the server 0xfc00 cluster to endpoint 0x01 of the ConBee/RaspBee, so that the switch sends buttonevent notifications to the gateway;
• From the server Power Configuration cluster to endpoint 0x01 of the ConBee/RaspBee, so that the switch sends battery reports to the gateway (you also need to configure reporting for the Battery Percentage Remaining attribute 0x0021);
• From the client On/Off and Level Control clusters to the associated group (which will be reported as config.group once the switch will be supported), to control the lights in that group, even when deCONZ is not running.

Once supported, the REST API plugin should setup these bindings on the switch. Sometimes this fails, and manually creating the bindings fixes this.

After a few minutes, the Button goes in "deep sleep". It is not available in deCONZ and it's not possible to wake up it by pressing the button for a short or long period.

I've seen other switches (Trådfri) hibernate when no appropriate bindings have been setup.

[imuncas]

Hi,

I would like to vote for this device request as well. I picked up a switch today, but couldn't make it properly work.

Br, Botond

[b-cole]

Hi, I have this new smart button as well.

With home-assistant I am able to configure the button using
zigpy-deconz and then detect the button presses, (both long and
short). I've also been able to automate on/off behavior in
home-assistant by matching the ZHA events in a simple automation
script.

I patched deconz-rest-plugin to attempt to add support for the smart button,
see the enclosed patched. With the patch, the deconz gui now shows
the zigbee device with the name "ROM001 2" however I still cannot get
the device to be detected thru phoscon. I wonder what else needs to
be done to make this work with deconz?
diffs.txt

[Mincka]

@ebaauw : Thank you so much for taking the time to explain it. Really appreciated. 👍

@b-cole : Thank you for the patch and good job! 🎉 Does the device have to be visible in Phoscon to be visible in HA? Or getting it recognized by deconz is enough to get the events in HA? From what I saw in other issues, the support for the device in Phoscon may require an update from @manup . It would be so great if Phoscon was open source to get pull requests from the community. 😄

[manup]

@b-cole, cool can you please make a PR for the patch? I have a hue button here for testing (sadly still in the package). For the next release it can be made visible at least in the Phoscon App switches list, with a proper integration wizard and Phoscon App switch editor support following later on.

[Mincka]

Any update on this? Thank you in advance for the support.

[derwolfk]

Hi Mincka,
I managed to get the short press reading in fhem by using the patch from b-cole.
Wolf

[Mincka]

Thank you for the confirmation @derwolfk

I think it's a bit complicated for me to patch it manually since I use Hassio and the Deconz integration (with the Docker image). I think I would have to access the container, install the dev package and recompile it. Still, it would be ephemeral. That's why I hope for an integration in deconz-rest-plugin so the Docker image that relies on the precompiled binaries will benefit from the update.

[carloscae]

any news on this? I'm having a real bad time to follow the developments on Deconz since the release pages have no updates since .71 release back in November... :(

[carpii]

Hoping for Smart Button support to be added to deConz also.
Do you need more info? Is there something we can help with?

This issue tracker is a bit inconclusive on whether a solution was ever found

[carloscae]

It adds to the confusion the fact that the last 3 releases have no changelog.

[ebaauw]

I don't have the smart button myself, so cannot test, but I'll try to add support cf. the Hue dimmer switch.

[carpii]

@ebaauw Is there a way I could ship you one from UK, for testing?

Or maybe an Amazon code or Paypal so you can order one?

[ebaauw]

Sure. The contribute shield on homebridge-hue should link to my Paypal account. It's still hard to get here in the Netherlands, but I can order it from store.meethue.com for EUR 25 (incl. delivery). If it's cheaper to send from the UK, please contact me by email for my address.

[carpii]

@ ebaauw Awesome! Paypal on it's way :-)

[ebaauw]

Cool, thank you. Ordered the button right away. Will report back here when I'll receive it.

[ebaauw]

Above commit should add support for the smart button. It's quite a sophisticated device, so I expect to have made some errors and/or overlooked something. Of course, I'll test when I'll have received the button, but if some-one feels like testing in the meantime:

• Please list the ZHASwitch /sensors resource created for the smart button;
• Please check that you receive buttonevents 1000, 1001, 1002, 1003 for press, hold, release, long release;
• Please check that the button reports how long it's been pressed through state.eventduration (my latest addition for the dimmer switch);
• Please check that config.battery gets populated (should be after 5 minutes or so);
• Please check that config.group gets populated (after pressing the button);
• Please check that button indeed controls lights added to that group. I'm not quite sure what commands the button will be sending, though; maybe the Scenes cluster needs to be bound to the group as well.

[jannnfe]

Above commit should add support for the smart button

How to install this commit? When will be the next release including this Huw Button Commit?

[carpii]

Is support likely to be added into Phoscon once it's working, or are you not associated with that project?

I'm a little confused on whether I am even using the REST API plugin right now
Im using Home Assistant with its deConz add-on, which also exposes the Phoscon GUI

[ebaauw]

WIth above PR, the Hue smart button is fully supported in the REST API; button events as well as directly controlling lights through the associated group.

There was quite some ancient and even dead code for the Hue dimmer switch. I refactored it to the latest patterns for ZB3 devices and uniform handling of the Hue dimmer and the Hue smart button.

I'm a little confused on whether I am even using the REST API plugin right now

You are; (web) apps (like Phoscon) and plugins for home automation systems connect to deCONZ through the REST API.

Is support likely to be added into Phoscon once it's working, or are you not associated with that project?

That's not an open source project, so it's up to dresden elektronik.

[carpii]

@ebaauw Thanks for the explanation. I had assumed this was an official dresden-electronik repo, and so you were involved in the development of Phoscon too.

I will start digging into accessing the REST API directly from Home Assistant, and perhaps find a way to avoid using Phoscon altogether.

[ebaauw]

I hardly ever use Phoscon. I control my devices from HomeKit using homebridge-hue. I've created the rules in deCONZ using scripts, that interact directly with the API thru ph.

[Mincka]

Hi!
The Deconz addon for HA has just been updated to V2.05.75.

I am very happy to confirm that I was able to pair the button and get the events in HA.
I used Phoscon and enabled the pairing in Switches, type Other.

I unpaired the Hue button from the bridge and reset it with the button near the battery (held for 10 seconds, till the light blinks with all the colors).

Nothing will appear in Phoscon but I was confident that the button was paired when I got the green light feedback on click.

I can confirm the events and the delay of 800 ms between repeat:

"events": [
	{
		"buttonevent": 1000,
		"eventtype": "initial_press"
	},
	{
		"buttonevent": 1001,
		"eventtype": "repeat"
	},
	{
		"buttonevent": 1002,
		"eventtype": "short_release"
	},
	{
		"buttonevent": 1003,
		"eventtype": "long_release"
	}
]

Very good job to everyone! 🎉 Thanks @ebaauw @manup @carpii (for the donation) @stickpin (for the add-on update in HA)

[Mincka]

Not sure why but after playing a bit with the button (almost 1000 events... with short, long, very long presses), I get two green blinks instead of one for a single push and release. Do you have the same behavior @ebaauw ? I am going to reset it again. I don't think it was like this just after the pairing. Sometimes, during a long press sequence, I get intermittent 1002/1000 events between the 1001s.

[carpii]

@Mincka I'm seeing this too. It blinks on button press, then button release.
For button hold it continues blinking (but doesn't necessarily blink once more on release)

I have the events coming into Home Assistant, but not yet sure how to trigger an automation based on it

[ebaauw]

I didn't really look at the led before, but indeed, two green blinks on press/release. I take it, it doesn't do that when connected to the Hue bridge?
I would guess it's because deCONZ puts the button in hybrid mode, controlling lights directly trough it's associated group, and reporting the event to the coordinator.

I get intermittent 1002/1000 events between the 1001s.

I would expect to see a 1003/1000 before any 1002/1000. It does seem possible for the button to register intermittent contact while holding it, not pressing too hard (but still hard enough to prevent the button from "popping"). E.g. below, I managed to get three presses within 0.1 second. The wrong order is probably due to deCONZ handling events asynchronously (I didn't have the sniffer active to confirm).

Mar 10 21:24:23 pi1 dc_eventlog[783]: /sensors/2/state: {"buttonevent":1000,"eventduration":0,"lastupdated":"2020-03-10T20:24:23"}
Mar 10 21:24:23 pi1 dc_eventlog[783]: /sensors/2/state: {"buttonevent":1002,"lastupdated":"2020-03-10T20:24:23"}
Mar 10 21:24:23 pi1 dc_eventlog[783]: /sensors/2/state: {"buttonevent":1002,"lastupdated":"2020-03-10T20:24:23"}
Mar 10 21:24:23 pi1 dc_eventlog[783]: /sensors/2/state: {"buttonevent":1000,"lastupdated":"2020-03-10T20:24:23"}
Mar 10 21:24:23 pi1 dc_eventlog[783]: /sensors/2/state: {"buttonevent":1000,"lastupdated":"2020-03-10T20:24:23"}
Mar 10 21:24:24 pi1 dc_eventlog[783]: /sensors/2/state: {"buttonevent":1001,"eventduration":8,"lastupdated":"2020-03-10T20:24:24"}
Mar 10 21:24:24 pi1 dc_eventlog[783]: /sensors/2/state: {"buttonevent":1003,"eventduration":14,"lastupdated":"2020-03-10T20:24:24"}

[Mincka]

I have the events coming into Home Assistant, but not yet sure how to trigger an automation based on it

- id: '1581172155087'
  alias: Turn on Julien's lamp
  description: ''
  trigger:
  - event_data:
      event: 1002
      id: rom001_29
    event_type: deconz_event
    platform: event
  condition: []
  action:
  - device_id: 8a2b486817a4476aab4813eb01630755
    domain: light
    entity_id: light.julien
    type: turn_on

[carpii]

@Mincka Thanks, that's very helpful
I wasn't quite sure how to structure the event data in the trigger condition, but all working now

@ebaauw, thanks too, for your great work in adding support for this

[jannnfe]

I don't know why the Hue Button is not working in Phoscon? I have the newest Gateway Version, newest RaspBee Version and newest Button Version updated with Hue Bridge. Pairing is working in GUI, but 0xFC00 cluster is unknown. In Phoscon the button is not showing up.
Can anybody tell me how to pair it into Phoscon?

[ebaauw]

0xFC00 cluster is unknown

That's normal. I could add it to general.xml, so the GUI would display a name, but the cluster has nothing to expose in the Cluster Info panel.

Can anybody tell me how to pair it into Phoscon?

dresden elektronik needs to add support for the button in Phoscon first.

[dschraven]

Can anybody tell me how to pair it into Phoscon?

Just now I have added the Smart Button to Phoscon. What I've done is:

1. Remove the backplate of the button;
2. Use a paperclip to factory reset the button;
3. The Smart Button was now blinking orange.
4. I went to Phoscon and searched for 'Other' buttons;
5. I pressed the Smart Button for ~10 sec;
6. The Smart Button was blinking green;
7. All my lights in the living room flashed (another sign that the button was paired succesfully);
8. The smart button is now visible in Phoscon app.

I've just checked, the presses are registered in NodeRed. Hope this helps.

[ghost]

I was able to pair the smart button. I had 1 issue. Of i short press for on. It always set the dim level to 100% instead of the level i had turned off the light. Does somebody knows why?

[ebaauw]

How do you control the lights? Directly by adding them to the associated group? Using deCONZ rules? Using some other Home Automation system? What type of lights are you using?

[MiAutomations]

Can anybody tell me how to pair it into Phoscon?

Just now I have added the Smart Button to Phoscon. What I've done is:

1. Remove the backplate of the button;
2. Use a paperclip to factory reset the button;
3. The Smart Button was now blinking orange.
4. I went to Phoscon and searched for 'Other' buttons;
5. I pressed the Smart Button for ~10 sec;
6. The Smart Button was blinking green;
7. All my lights in the living room flashed (another sign that the button was paired succesfully);
8. The smart button is now visible in Phoscon app.

I've just checked, the presses are registered in NodeRed. Hope this helps.

Hello

Can you please let me know if you have success in to pair this button as a swicth on the deconz Home Assistant ? I'm trying but without success for now I only see the battery as entity for this device and neither over the events I have the result of pressing the physical button ...

Thank you

[carpii]

Can you please let me know if you have success in to pair this button as a swicth on the deconz Home Assistant ? I'm trying but without success for now I only see the battery as entity for this device and neither over the events I have the result of pressing the physical button ...

My original button (firmware 2.21.0_r29784) is working fine.
I also bought a new one a few days ago (firmware 2.30.0_r30777) and that is working with DeConz and Home Assistant too.

It does seem to take a few attempts to pair sometimes, although I've never had it where it exposes the battery entity yet sends no button events

[rEs-84]

Can you please let me know if you have success in to pair this button as a swicth on the deconz Home Assistant ? I'm trying but without success for now I only see the battery as entity for this device and neither over the events I have the result of pressing the physical button ...

My original button (firmware 2.21.0_r29784) is working fine.
I also bought a new one a few days ago (firmware 2.30.0_r30777) and that is working with DeConz and Home Assistant too.

It does seem to take a few attempts to pair sometimes, although I've never had it where it exposes the battery entity yet sends no button events

Having same issue as others. pairing it as other button after resetting it. Tried 3 times
i always just get the battery
Ver 2.09.03 / 12/23/2020 / Firmware 26660700
core-2021.3.4 / supervisor-2021.03.6

[pfrenssen]

I also had this problem that the button paired correctly, but only the battery status was reported and button pressed were not being registered. Re-pairing and resetting the button didn't work but the following steps finally solved it for me:

1. In Phoscon, delete the switch.
2. Remove the battery from the button and re-insert it.
3. Press the "setup button" next to the battery for a few seconds until the LED lights up and changes color. IIRC it first lit up in orange then changed to green, but I can be mistaken about the color sequence.
4. Now add the switch again in Phoscon.

[rsedlmeier]

Had the same issue /w HUE smart button.
However, a phoson delete and re-connect solved it.