¶ Drivers Code
Hubitat Elevation continually adds to its list of included drivers. We recommend using these drivers whenever possible. The list of compatible devices includes the recommended driver for known compatible devices.
However, the generous Hubitat community continues to create drivers for devices we haven't integrated yet or to expose features differently (and any user can do the same with Groovy-language programming). When you find one you want to use, you will need to add the driver code to your hub, then assign that driver to a device.
¶ Installing custom drivers
- The developer of the driver will normally post a link to their driver code. Follow their directions to get to the source code.
- Often, developers will use GitHub to host code. When copying the code, select the Raw button so that you are getting the “raw” text of the code, with no HTML formatting.
- Select All the raw code, and then Copy the code.
- From your Hubitat Elevation® Web Interface, select Drivers Code in the side bar. (Expand the Developer tools section if you do not see this.)
- Select the +New Driver button in the upper right corner.
- In the blank text field, simply paste the driver code. Alternatively, you can select the Import button and past a URL to the developers code in raw text format.
- Select the Save button in the top right of the page. When the modified goes away, your driver is saved.
Note: You may experience an error in this step. If you do, your driver will not save and it will not work. Please contact the developer of the driver in the forum. It is usually best if you take a screen shot to help them diagnose the problem. Once the code is fixed, come back and try again.
¶ Loading your custom driver
Once your driver has successfully saved, you will need to update your device(s) with the new driver:
- For Zigbee and Z-Wave devices that have already been added to your hub, normally you will navigate to the device detail page and change the driver.
- For Zigbee and Z-Wave devices that have not yet been added to the hub, the driver should be matched on pairing, with the hub preferring user drivers over built-in drivers if both are available. Otherwise, it can also be switched manually after installation.
- For virtual or LAN devices, you may need to either switch the driver (if the device has already been added) or create a "virtual" device using the driver. Some may also be intended to be used by an app the developer provides rather than created directly. The developer should provide installation and usage instructions.
To do this:
- From the home page of your hub, select Devices in the side bar.
- Select the device for which you want to change the driver type (if the device is already added to the hub) to open the Device Detail page for that device. (If creating a new virtual device instead of changing the driver on an existing device, follow the steps below when creating the device instead.)
- Scroll down to the Type drop-down, which shows the selected driver. Choose the new device driver that you want to use from this list.
- NOTE: Custom drivers, including the one you just added, will appear under the heading User, separate from built-in drivers.
- NOTE: Custom drivers, including the one you just added, will appear under the heading User, separate from built-in drivers.
HINT: Searching by name filters the list and may help you find this (or any) driver faster.
- Select the Save Device button to save your changes
Your driver is now installed and, if selected, will used by the device.