Big Ass Fans (V2) Quick Install Guide

Version: 20220706
Date: Wednesday, July 06, 2022
Authors: Andrew Luecke

Overview
The Chowmain Bigg Ass Fans Driver for Control4 allows integration of the IP controllable Big Ass Fans and Big Ass Lights into Control4 allowing full 2 way multispeed fan and multi level lighting control over your home.
Integration into Control4 allows control from a single point using Control4's touchscreens, mobile applications, keypads, handheld remote controls and cloud based 4sight remote monitoring and control service. On top of that it exposes control over the Haiku products in the Control4 ecosystem to provide interaction from other devices in the home.
From turning off your fans and lights when you arm your security system to automatically turning them on when it detects you are at home and if the temperature is at an uncomfortable level integration provides you with so many different solutions to make your lifestyle that much easier.
The Big Ass Fans V2 Driver requires Control4 OS 3.3.0 and above.
Features
•	Automatically find Lights and Fans on your network 
•	Instantaneous Feedback 
•	Wide range of variables for feedback 
Light Features
•	Automatic Naming of Lights 
•	Auto mapped light levels (Control4 has 0-100 where Haiku has 0-16) 
•	Support for Advanced Lighting Scenes 
•	Two way feedback – Level, Device Name, Device MAC Address, Device IP Address 
•	Programming Commands 
Fan Features
•	Automatic naming of Fans 
•	Assign Preset Speed (On speed when toggled) 
•	Assignable Speeds (Control4 have speeds Off to 4 where Haiku have Off to 7) 
•	Two way feedback – Speed, Device Name, Device MAC Address, Device IP Address 
•	Programming Commands - Whoosh Mode, Fan Auto, Fan Direction 
Setup (V2)
Please note, OS 3.3 or later, and the latest Big Ass Fans firmware is required for BAF V2 driver. 
Quick Start
 1.	Ensure Controller is running OS 3.3.0 or later. Lighting will not operate correctly in OS 3.2 or earlier 
 2.	Upgrade Fans to latest firmware (V3.0 or later). The Legacy SenseMe firmware is no longer supported 
 3.	It is strongly recommended to remove all V1 devices from the project before installing the V2 drivers. Once the firmware upgrade has been performed, the original V1 drivers will cease to operate. 
 4.	Use Add Or Update Driver or Agent to upload drivers to Controller. Do not simply copy the c4z files to your Control4 Drivers directory or Auto-Setup will not operate correctly 
 5.	Using the Big Ass Fans Mobile App, configure and setup all TPLink Kasa devices. Test devices for correct operation. It is recommended to set static IP's of devices or allocate static IP's using DHCP. Ensure the latest firmware has been installed 
 6.	(Optional) In Agents, add the Big Ass Fans V2 Agent. As devices are discovered, the device and driver properties will update.
 1.	Set the Default AutoSetup Room where devices should be added. 
 2.	Select the Auto Setup action to automatically add and setup devices.
 7.	Alternatively, add the fan/light driver for each enter BAF device and enter the port and IP Address manually. 
In the event of issues, use Display Diagnostics to assist with identifying problems.
Settings - Agent
Properties
•	Enable Auto-Discovery: Enables or Disables Auto-Detection of devices automatically. 
•	Default AutoSetup Room: Default Room for Devices to be added into during Auto-Setup 
•	Auto-Detection Poll Rate (Seconds): Detection Rate of new devices and self-healing if Enable Auto-Discovery is enabled. 
•	Total Devices: Total auto-discovered devices 
•	Provisioned Devices: Total devices which have at least 1 configured driver in Control4 
•	Unprovisioned Devices: Total devices which do not have a configured driver in Control4 
•	Total Drivers: All Light / Fan Drivers (excluding Agent) added to the Control4 project 
•	Invalid Drivers: Drivers in Control4 which have an undiscovered/invalid UUID Address set in Properties. 
•	Provisioned Drivers: Drivers in Control4 which have a valid UUID Address 
•	Unprovisioned Drivers: Drivers in Control4 which haven't been setup yet 
Actions
•	Auto Setup: Automatically Adds drivers and configures all unprovisioned devices in the Control4 Project 
•	Display Diagnostics: Detects common issues and displays faults to LUA window 
•	Display Known Devices: Displays a directory of all known devices on the network, Drivers, their capabilities and provisioning states. 
•	Get Latest Devices: Attempts Auto-Discovery of Devices on Network 
•	Submit Diagnostics: Submits diagnostics information to Chowmain and provides a ticket ID to the LUA window which can be provided to Chowmain staff when requesting support 
Settings - Fan / Light Driver
Properties
•	Select Device From List: Requires Agent to be installed and have auto-discover turned on. Automatically sets up driver using details discovered using Agent 
•	UUID: Used by TPLink Agent for Self-Healing of IP Addresses 
•	Auto-Rename: Auto-Renames the Drivers in the project 
•	Auto Hide Unsupported Devices: Auto Hides Light / Fan as required in proxy (please note, it will continue to be shown in composer) 
•	Connection Status: Connection status of the device 
•	IP Address: IP Address of the device 
•	Port: TCP Port of the device 
•	Device Name: Detected Name of the device 
•	Device MAC Address: Detected MAC Address of the device 
•	Firmware Version: Detected Firmware Version of the device 
Capabilities Supported
•	Supports Temperature Sensor 
•	Supports Humidity 
•	Supports Occupancy Sensor 
•	Supports Light 
•	Supports Light Sensor 
•	Supports CCT Light 
•	Supports Fan 
•	Supports Speaker 
•	Supports Piezo 
•	Supports LED Indicators 
•	Supports Uplight 
•	Supports UV-C Light 
•	Supports Standby LED 
•	Supports ECO Mode 
Fan
•	Default Fan Power State: Sets whether power on of fan should return to previous state, or preset state when turning on 
•	Eco Mode: Display ECO Mode Status of Fan (if supported) 
•	Fan Speed: Display the speed of the fan 
•	Occupancy Sensor: Display whether occupancy sensor is enabled 
•	Whoosh: Displays Whoosh status of the fan 
Occupancy
•	Fan Occupancy Enabled: Display whether Fan Occupancy Mode is enabled 
•	Light Occupancy Enabled: Display Whether Light Occupancy Mode is enabled 
•	Motion Detected: Display whether motion has currently been detected 
Light 
•	Default Light Power State: Sets whether power on of light should return to previous state, or 100% when turning on 
•	Light Capabilities: Adjusts the supported capabilities of the light 
•	Light Level: Current Light Level of the light 
•	Light Temp (Kelvin): If supported by light, current CCT/white temperature of the light in Kelvin 
Actions
•	Display Diagnostics: Detects common issues and displays faults to lua window 
•	Hide Fan In All Rooms: Automatically hides the Fan in all rooms in navigator 
•	Hide Light In All Rooms: Automatically hides the Light in all rooms in navigator 
•	Submit Diagnostics: Submits diagnostics information to Chowmain and provides a ticket ID to the LUA window which can be provided to Chowmain staff when requesting support 
FAQ
Where is the Fan in Control4's interface?
For some reason Control4 added the Fan proxy to the lights page. You can find it in there.
How come the dimmer level changes slightly when i set a level?
Haiku's only have dim levels of 0-16. As such we have mapped it by multiplying the value by 6.25 and rounding up.
I notice that the driver automatically renames. What if i want to name it myself?
Adjust the Auto Rename Property
How do i use whoosh, fan direction or the automatic settings?
These functions are programmed as one-way commands in the fan / light driver's programming commands. You should tie these into experience buttons, schedules or other event based programming.
What Control4 OS is required for this driver?
OS 3.3.0 or above is required for our Big Ass Fans V2 driver. For Legacy systems, V1 may still be used, but requires older firmware and supports limited hardware
V1 was working fine, but V2 doesn't work
V2 requires updated firmware for operation. V1 does not require updated firmware, but it does not support all of the features of V2.
Do you offer any other cool drivers?
Control4 is a major part of our business. We develop new drivers all the time. You can see all of our drivers on our website (http://www.chowmainsoft.com). Sign up to our newsletter to get notified when new drivers out.
I want to try this driver out before buying it?
All Chowmain drivers for Control4 come with a 90 day trial.
Troubleshooting
The auto discovery process isn't finding my devices, why?
The driver sends a UDP packet out to the subnet that the C4 controller is on, only when you press Auto Setup under the Actions tab.
Reasons for the driver not finding your devices are;
 1.	The devices are on a different subnet 
 2.	There is a network device, like a wireless access point or switch that is dropping UDP packets.
•	In most cases, UDP packets received by an access point from the physical network are not passed on to the wireless network. This is to maintain wireless speeds. Most wireless APs provide an option to allow UDP packets through
Licensing
•	How does the trial period work?
All Chowmain drivers are free to use for a set trial period. When the trial expires the driver will cease to function until you purchase a licence and apply it to the driverCentral project.
•	Where do I buy a Licence from?
This driver is developed by Chowmain software & Apps and is distributed by driverCentral, Inc https://www.drivercentral.io/chowmain-ltd
To purchase a driver:
1) On driverCentral, purchase a license and register it to your project
1) If the driver is not already installed in your project, download it and install it
1) If necessary, use the cloud driver’s Action: “Check Drivers” to force the licence to download into the project
Creating a Project on Driver Central
 1.	Visit http://www.drivercentral.io
 2.	Log into your driver Central dealer account
 3.	Click Portal
 4.	Click New Project
 5.	Enter the project name
 6.	Click Add Project
 7.	Click on the project we just created
 8.	Take note of the Project Token as this will be used later when we install the Cloud Driver
 9.	Click Close
Purchasing a Driver Licence
 1.	Visit https://www.drivercentral.io/chowmain-ltd/ and find the product/driver you want to purchase a licence for
 2.	Click on Add to Cart
 3.	Now click the shopping cart icon (top right) and click View cart
 4.	Confirm that your order is correct and click on Proceed to checkout
 5.	Choose your payment option, provide the relevent details and click Place order
 6.	You will now be at a page where you can see your purchased licence
 7.	From here assign the licence to the project we created or if you did not follow that step create a new project
Install the driverCentral cloud driver
 1.	Visit http://www.drivercentral.io
 2.	Log into your driver Central dealer account
 3.	Click Portal
 4.	Click Cloud Driver
 5.	Copy the C4Z driver to My Documents\Control4\Drivers directory
 6.	Add the driver to your project
 7.	Click on the driver to view it’s properties
 8.	Type in the project token we took note of earlier
 9.	Click Actions tab
 10.	Click Check Drivers
Install Chowmain driver
 1.	Install the Chowmain driver
 2.	You will notice that the Activation Status reflects a Licence Activated state
 3.	Any driver that does not have a purchased licence will have a trial licence activated via the marketplace
Note that there is no way to reactivate the trial so please use wisely
 4.	If you do not then press the Check Drivers action in the driverCentral Cloud driver again
Adding the driver to your project
IMPORTANT – Before undertaking the installation of the driver please follow the licensing steps outlined at the end of this document.
 1.	Launch the Composer Pro application and connect to your project
 2.	In the ‘System Design’ page select the ‘Search’ tab on the right hand side.
 3.	Type in ‘Big Ass Fans Driver’ in the search field
 4.	If you have multiple units, repeat this process for each unit
 5.	Highlight the ‘Big Ass Fans Driver’ driver on the left hand side. 
Developer Information
Copyright © 2022 Chowmain Ltd. http://www.chowmainsoft.com
All information contained herein is, and remains the property of Chowmain Ltd and its suppliers, if any. The intellectual and technical concepts contained herein are proprietary to Chowmain Ltd and its suppliers and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Chowmain Ltd.
Information stated in this document is current as of July 2020 and may change. For latest information please visit http://www.chowmainsoft.com
Support
•	Phone Support
Want to talk to us? We have 3 dial in numbers and two support desks that span multiple timezones.
Support Center	Hours of Operation	Phone Number	
Australian Support Desk	8:30AM – 5:00PM Australian Eastern Time	+61 3 9028 6999	
New Zealand Support Desk	10:30AM – 7:00PM New Zealand Time	+64 9 889 4000	
•	Online Chat
Prefer to chat to us online? We also offer live chat at our American support desk.
Support Centre	Hours of Operation	URL	
American Support Desk	8:30AM – 4:30PM Mountain Time	https://help.drivercentral.io/	
•	Support Ticket Submission
Submit a ticket and get a response within the hour from our support desk during the hours of operation or next day if out of hours
Support Centre	Hours of Operation	URL	
American Support Desk	8:30AM – 4:30PM Mountain Time	https://help.drivercentral.io/	

Change Log
20220706 - 06-JUL-2022
This is a Major update which of the Big Ass Fans Driver, which introduces our new V2 driver suite which supports Big Ass Fans new 3.0 firmware and Big Ass Fans app. All Big Ass Devices must be upgraded to the new 3.0 firmware to operate using the mobile app (V2 does not support the legacy SenseMe firmware). Our new driver suite requires OS 3.3 for lighting to operate correctly. 
Please note, this is a major rewrite. After upgrading device firmware to V3.0, you must delete the old drivers and replace them with the rewritten V2 drivers. 
Some benefits of the new drivers include:
•	Driver is no longer limited only to Haiku, but a much wider range of Big Ass Fans devices 
•	OS 3.3 CCT / White Temperature Light ColorWheel Control 
•	Occupancy Sensor Support 
•	Huge range of variables for feedback. And various read-write variables for advanced users 
•	Compatibility with the new V3.X firmware 
Thanks to all our beta testers for their feedback and feedback including: 
•	Cameron Etezadi 
•	David Estabrook 
Version 20210119 - 19-JAN-2021
•	Updated to new Driver Central licensing 
Version 20200716 – 16-JUL-2020
•	Fixed issues with programming commands not firing 
•	Added smart mode programming (off, heating, cooling) 
Version 20200714 – 14-JUL-2020
•	Implemented Whoosh, Direction and Auto commands into the programming tab. 
Version 20200618 – 18-JUN-2020
•	Fixed issue with OS 3.1.3 
•	OS 3 supports additional speeds now. Fixed the driver to the 7 speeds Haiku supports. 
Version 20170710 – 10-JUL-2017
•	Migrated to driverCentral. 
Version 20160720 - 20-JUL-2016
•	Fixed issue with speed 4 
Version 20160714 - 14-JUL-2016
•	Initial Version