[RELEASE] Modern Forms Fan and Light Driver for HomeKit Integration

poet · August 15, 2023, 8:54pm

Modern Forms Fan and Light Driver for HomeKit

A Hubitat driver for Modern Forms fans and lights that works with HomeKit Integration by utilizing child devices. Based on drivers from @bertabcd1234, @bhamiltoncx, @1info, and Hubitat.

Raw URL: raw.githubusercontent.com/staines/modern-forms-for-hubitat-and-homekit/main/modern-forms-for-hubitat-and-homekit.groovy

github.com

staines/modern-forms-for-hubitat-and-homekit/blob/main/modern-forms-for-hubitat-and-homekit.groovy

/*
 *	Modern Forms Fan and Light Driver for HomeKit
 *
 *	Copyright 2023 Chris Staines
 *	Based on code from Robert Morris, Ben Hamilton, 1info, and Hubitat
 * 
 *	Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 *	in compliance with the License. You may obtain a copy of the License at:
 *
 *		http://www.apache.org/licenses/LICENSE-2.0
 *
 *	Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
 *	on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
 *	for the specific language governing permissions and limitations under the License.
 * 
 *	Changelog:
 *		2023-08-15v03 - perfect, shiny, and new
 *		2023-08-15v02 - clean up preferences (/shrug)
 *		2023-08-15v01 - add preference to turn on fan when speed set or light when level set
 *		2023-08-13v11 - clean up, use lastRunningSpeed

This file has been truncated. show original

How-To

Add to Hubitat as a Virtual Device with User Type (bottom of list) of Modern Forms for Hubitat and HomeKit
Set IP Address in main device and other preferences
Add child devices to HomeKit Integration

Notes

To support various scenarios, you can decide to enable or disable the light and fan, which will delete the respective device. You can also choose whether to turn on the device when setting a new level or speed.
The current HomeKit integration sends a lighting level of 100 when turning the light on.
Modern Forms fans retain the last used fan speed, but this makes HomeKit think the fan is still on even if the switch is turned off. To circumvent this, the driver ignores the fan speed from the fan and tells Hubitat the fan speed is off if the switch is off.

brad · August 27, 2023, 11:38pm

@poet - Curious, what features or enhancements does this add that the one by @bhamiltoncx doesn’t?

poet · August 28, 2023, 12:06am

The driver by @bhamiltoncx uses a child device for the light but not the fan, which makes the fan incompatible with HomeKit Integration. I think Generic Component Fan Control was not released until after he made that driver.

I wrote this driver using Generic Component Fan Control to ensure compatibility with HomeKit Integration, and created various user preferences to further support that integration.

brad · October 21, 2023, 6:51pm

@poet - Thanks for putting this together. Trying it out now, and I’m getting the below errors; however, the commands are being successfully sent (fan is changing). Any idea what might be going on? My WAC fan is on Firmware 2.00.0037 / 02.06.0000
EDIT: Looks like it’s because I have the light device turned off. I turned on the light device, and I stopped receiving the error. Seems that in the driver the deviceNetworkId for the light is being queried even though the light does not exist.

scud133 · December 15, 2023, 4:51pm

@poet by any chance do you think the work you did here might be translatable to homebridge? We have a similar plugin to enable Homekit functionality [github]/nickbreaton/homebridge-modern-forms but it hasn't been touched in 3 years and might need an update. Trying to figure out where to start with this.

brad · December 20, 2023, 1:00pm

Wondering what the use case is. I have my 3 WAC ceiling fans in Hubitat using this app and integrated to HomeKit using Homebridge. Works just fine.