[BETA v0515] Hampton Bay Zigbee Ceiling Fan/Light Controller

  1. Copy the device handler text into a text editor, e.g. Notepad. Search for “zigbee.” (note the dot at the end). Wherever you see an instance, precede that line with “device.endpointId = 1”. There should be seven areas. For example,

    device.endpointId = 1
    zigbee.onOffRefresh() + zigbee.levelRefresh() + zigbee.readAttribute(0x0202, 0x0000)

    Also, search for the following and give it a unique name

    metadata {
    definition (name: “KOF Zigbee Fan Controller”,…

  2. Create and publish a new Device Handler with the modified text from Step 1.

  3. Create your fan device manually and choose the new device handler for your device. You’ll also need your Device Network ID (dni) and Zigbee ID (d) from the zbjoin event which you can get from Hub Events (Go to “My Hubs”, click “List Events”). If you don’t see the zbjoin event, reset and pair the fan controller again. You should see it now.

  4. Make sure the light child device uses the original child device handler and has the same Device Network ID as the parent (with “-light” appended to it).

Assuming your fan is paired and the above is complete, it should work.

1 Like

@sblock23 - Thank you for taking the time to reply and give me some advice. I know you probably have better things to do, but your help is much appreciated.
After 4+ hours of trying, I could not get this to work.
I created a copy of the KOF device handler and added the device.endpointId = 1 to the line above all seven sections that have the Zigbee. statement in them, and created a new device handler with this modified copy.
I manually added a device and used the Device Network ID and Zigbee ID, which was easy found as you directed in your post.
I can see the new Fan and child devices in my ST app, but cannot control the physical unit, and its not showing the correct device status in the app either. When I go to the events of this new fan device, I do see the logs correctly display my actions in the app (Turn On, Off, Refresh, etc), but nothing happens to the physical device.

I still don’t understand how I had this working for years, and after removing the device, not able to re-add or add a new fan.
Here is the modified code I used: https://github.com/cadocomp/SmartThingsPublic/blob/master/devicetypes/KOF_Modified

I hope this is something blatantly obvious that I am doing wrong. I guess I can post some screenshots/video clips of what I actually see.

I installed my 2nd fan controller tonight… When I went to add it to smart things it showed up as thing. I had a little trouble logging into the IDE which was odd to me but OK whatever. I went in and simply selected the DTH and restarted smart things. Works exactly how I expect it to.

I have one controller left in my inventory to install and I have 4 more fans to control but 3 of them need to be replaced. 1 of them is a hugger style that just isn’t compatible in 2 of them have bed wobbles to them. 1 of them I got the wobble out but the bracket that mounts with is completely incompatible I would have to basically get a Hampton Bay downright assembly same fit the collar and the hangar assembly so that I could make this work. It is a possibility because my wife and I both like the looks of this 1 fan. The other fan screens 1980s as it is polished brass and cut glass.

The funny thing is the one fan that I don’t really need to replace my wife wants to because it’s just a plain white fan.

I have seen folks here say they need to “republish” their DTHs, not only for this one, but for other custom DTHs. I am assuming since mine are working I don’t need to… Any idea what happened to cause this for other folks?

For anyone else following this thread, @sblock23 was spot on! I also had the Device ID and Zigbee ID reversed, which obviously was never going to work, but the above instructions should get you squared away.

Im not sure at all what the problem was besides maybe a ST issue in itself. prior to my recent conundrum id been running the same DTH since it was upgraded to BETA. I thought it was related to trying to add it to an Nvidia ST link but it did the same thing when i repaired to my original v2 hub.

I’ve heard it mentioned with other DTHs recently which is why I asked. I am not seeing the problem even when I added say the second Hampton Bay controller…

I spent hours trying to figure this out. All it was was that I was using the new app. Installed smartthings classic and now it looks like I expected. Thank you so much.

I apologize if this has been discussed before, but I’m wondering what it would take to make this device handler work with the new Smarttings Connections App. I prefer to use the new app, and the only one of my “things” that doesn’t work well with the new app is this KOF fan controller.

1 Like

Begging and pleading with Samsung to integrate a native device handler for this device into the app. To my knowledge teh new SmartThings Connect app doesn’t do custom code… So you are more or less out of luck…

Hi All, hope you can help. DHs are installed and published.
When I add device manually, what category are the fan controls in? I can’t find them. and it’s not being found automatically. I have a v2 hub, and I can’t get the hub closer than 25ft. I’m also only using the wall switch prescribed, not a handheld remote. thoughts?

Is it being discovered as a “thing”? If it is, try manually change the DTH to the the KOF in the IDE. If it isn’t being found, you may have to grab a 25ft Ethernet cable and move the hub closer to the fan. These things have really weak radios. I would bet money you will need a zigbee repeater in the room with the fan to keep it connected once you get it paired too This has been my experience with that controllers (I have 2).

1 Like

I have my whole setup now on V3 Mesh Wifi Hubs… Love it my only issue is that these are not Battery backed up. Ok here is how Im set up. I am changing out my Direct KOF controllers for the Universal Smart 4-Speed Ceiling Fan Remote. First one got installed yesterday and its showing up as THING like the older ones when they got hit by a brown out. (kinda hard to put a UPS backup on a ceiling fan hehe) Love the fact that now I have a remote and if the fan scrambles Im not stuck without my fan till I do the reset and rejoin method. Im hoping these new ones fix the problem if not still keeping them due to the remotes… Now gotta print some Wall holders. Also Need to find out why I cannot Dim them … Guess it’s code digging time.

1 Like

There is a dip switch in the remote that you flip to enable dimming. BTW, they will only dim down to 20%. The 20% is a hardware thing.

I bet if I look at the instructions it will say HAL you idiot read this instruction if you want to dim the lights :slight_smile: Thanks for the help

1 Like

@SuperMouseDV LOL… I did the same thing when I installed my first one!

I had 3 of the King of Fans versions. Now switching them out for these new ones due to HOW Much cheaper they are and the remotes if Florida Flicker and Flash (aka FPL) brown out the system again (Which looses most of the current fans on the system and need to be re added)
hopefully the new ones won’t. I got 2 more to install and the look great…

I’m on Peace River here in Florida and have had our share of power issues too, though it’s been good for quite awhile.

I’ve had a Hampton Bay controller drop off the network after power outages and quick drops multiple times. It’s the controller that requires a repeater (using an Almond peanut plug) to stay connected that will drop. The controller connected directly to my V1 hub has been rock solid.

The last time I rejoined the dropped controller I ended up with 2 lights, 2 low speed, 2 medium speed, etc. devices. It isn’t an issue in the classic app but the V3 app is showing the device as disconnected so I’m going to have to delete the children and recreate them at some point. I haven’t done it because I haven’t felt like messing with all the rules that these devices are used in. :crazy_face:

I have to do it each Time (hopefully this time round it won’t do it as I accidentally reset one of the new ones and it kept its name and Device handler something the older models didn’t) Im glad I have 2 I won’t use anymore as I accidentally damaged the antenna for the Zwave in the install.
So I gots me 2 spare antenna. the older ones were not that fraggel.

1 Like

Scratch the last comment I posted. Had a BAD Lightning storm (welcome to Florida) last night and the 2 new Home Depo ones went out Glad to have remote controls for them. Im going to do a test probably a wast of money but worth a try. Im wondering if NON standard DH enabled devices have this issue when the power goes out for a moment due to them not being hard coded (this is a guess and probably most likely absolutely wrong here hehe) SO they get lost due to being in the program ram not the rom. SO meaning this nut here is going to get a small cheap UPS for his Smartthings hub and Ill let you know in a month how many times I have to reset each fan. (luckily 3 of the 4 fans have inline switches making reset easy but WHY should I have to) And this time round No they didn’t keep their names or link to the DH had to go into the backend and tell them Whose your daddy and this is what you do. (sorry just seen a 10 things about Kindergarten Cop on youtube)

Well Theres your problem. …I just bought 3 of the Official Home Depot Universal Smart 4-Speed Ceiling Fan remotes and one of the 3 didn’t work … I opened it and do you see the problem. Oddly enough I opened the once ceiling fan that was intermittent (older KOF one) and sure enough it was disconnected too. So take the 2 screws out and check the antenna Folks… But on the new one That didn’t fix my issue. Now to find out why they drop off the network during a power outage (brown out) or Lightning storm… Like I said earlier Im getting a small cheap UPS just for the main hub.

Just FYI I did not disconnect that antenna it came apart like that.