Fan Module (Hampton Bay)

[mjruotolo]

I would like to use this module with the gateway.
https://www.homedepot.com/p/Hampton-Bay-Universal-Wink-Enabled-White-Ceiling-Fan-Premier-Remote-Control-99432/206591100
This is a universal zigbee fan controller with fan and light controls.
I have included a bunch of screeen shotes of the nodes as well as the device handler from smartthings. Not sure if this will help in any way. Please let me know what other info you will need.

Smartthings Device handler.
https://github.com/dcoffing/KOF-CeilingFan/blob/master/devicetypes/dcoffing/kof-zigbee-fan-controller.src/kof-zigbee-fan-controller.groovy

[gmitch64]

I'd like to second this too please. Fan control is the one main area that I've not touched automation wise.

G

[jjlawren]

I have a couple of these that I’d love to integrate.

[manup]

So this is only the remote? Is there also some data available about the controller?

Can you please also provide the basic cluster attributes? They should be visible when joining the device while sensor search is running.

https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Request-Device-Support

[jjlawren]

The fan/light controller which is wired to the ceiling fan has both an RF antenna and a zigbee controller. The remote it comes with is RF, but the controller can additionally be paired to a zigbee hub.

[ebaauw]

I stumbled across these looking for a solution for my ceiling fans. They are everything you'd want. Unfortunately, only for the North-American market (110V, different mechanism to attach the fan to the ceiling, where the controller fits neatly under the canopy).

[anacozero]

Any other info needed? Been sitting on these units for a while after switching off smartthings. Would love to help in anyway.

[ebaauw]

Receiver on when idle is true, cool. Looks like it would be exposed as a /lights resource if we just whitelist the device type, 0x000e. I wonder if the Level cluster actually links to the fan speed, or if its only used to accept Move to Lebel (with On/Off) commands to turn the fan on or off. Cluster 0x0202 is Fan Control, which defines an attribute for setting the fan speed to off/low/medium/high/auto. This needs to be added to general.xml. Then, we need to find out which of these are actually supported.

[anacozero]

This driver helped me figure some info out:
https://github.com/stephack/Hubitat/blob/master/deprecated/drivers/KOF%20Fan%20Controller.groovy

It looks like x0202 is the fan control. There is no cluster info on x0202 in deCONZ on my device, so i can't provide any screenshots on what that looks like. Not sure how to get that info.

And x0008 is the light dimmer control. the id 0x0000 is the light dimmer level with values between 0 - 255

[anacozero]

added this to general.xml for testing and it seems to be working for all fan control except breeze. It will read the value, but won't write it.

<cluster id="0202" name="Fan Control">
<description>Attributes and commands for switching Fan Control.</description>
<server>
				<attribute-set id="0x000" description="Fan Level">
					<attribute id="0000" name="FanLevel" type="enum8" access="rw" default="0" required="m">
							<value name="Off" value="0"></value>
							<value name="Low" value="1"></value>
							<value name="Medium" value="2"></value>
							<value name="Medium-High" value="3"></value>
							<value name="High" value="4"></value>
							<value name="Breeze" value="6"></value>
					</attribute>
				</attribute-set>
		
	<command id="00" dir="recv" name="Fan Speed Select" required="m">
		<description>Control Fan Speed</description>
		<payload>
			<attribute id="0x0000" type="enum8" name="Fan Speed" required="m" default="0">
				<description>The effect identifier field specifies the fading effect to use.</description>
							<value name="Off" value="0"></value>
							<value name="Low" value="1"></value>
							<value name="Medium" value="2"></value>
							<value name="Medium-High" value="3"></value>
							<value name="High" value="4"></value>
							<value name="Breeze" value="6"></value>
			</attribute>
		</payload>
	</command>			
</server>
<client>
</client>
	
	<!-- TODO -->
</cluster>

[ebaauw]

Ah, so the REST API should expose two resources, one for controlling the light, and one for controlling the fan.

Where did you get the command from? I didn’t see any commands in the Fan Control cluster. I think there also a value 5 for Auto. Value 6 means on while occupancy is detected, which would need an Occupancy Sensing cluster.

Can you control the fan using the command from the deCONZ GUI?

[anacozero]

I just wrote the command based on my limited knowledge of how this works. Pretty new to this whole thing and just trying to be dig in as much as possible to be helpful.

I can't control the fan with the command in the GUI, but i can control the fan in the GUI through the attribute editor:

[ebaauw]

That’s how it’s supposed to work, according to the ZCL spec.

[ebaauw]

I updated general.xml with the ZCL spec for Fan Control.

As the Fan Control cluster is on the same ZigBee endpoint as the On/Off and Level Control cluster, we cannot create an additional /lights resource for the Fan. Also, exposing the fan part as a separate ZHAFan /sensors resource seems both unintuitive and too much work. Therefore, I think the best options is to add state.speed to the /lights resource.

With the above commit, you should see a single /lights resource, with state.on and state.bri reporting and controlling controlling the light, and state.speed reporting the fan speed. Updating the speed hasn't yet been implemented. Also, for now, I expose the raw enum value in state.speed.

Obviously, I cannot test this without the Fan Module. Could you please compile and test this PR? Re-pair the Fan Module, or search for new devices from Phoscon and read the Basic cluster to trigger the creation of the REST resource. Please list the REST resource, so I can check that it's working as intended.