How to Install Custom Drivers

From Hubitat Documentation
Revision as of 16:31, 31 March 2021 by Doug (talk | contribs)
Jump to: navigation, search
Go to the top of the page

Hubitat Elevation continues to add to its list of included drivers. However, the generous Hubitat community continues to create drivers for devices we haven't integrated yet. When you find one you want for your device, you will need to install it on your system.

Installing custom drivers

  1. The developer of the app will normally post a link to their driver code. Follow their directions to get to the source code. Select and copy the code.
  2. From the sidebar of your hub, select Drivers Code.
  3. Select the +New Driver button in the upper right corner.
    New User Driver code 2.0.png
  4. 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.
    Add user driver code 2.0.png
  5. 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.
User Driver code unsaved 2.0.png

Loading your custom driver

Once your driver has successfully saved, you will need to update your device(s) with the new driver.

  1. From the home page of your hub, select Devices in the side bar.
    Add Virtual Device 2.0.png
  2. Select +Add Virtual Device or select the device for which you want to change the driver type. This opens the Edit Device view. Scroll down to find the Type field. The name of a driver will be listed there.
    Change driver type 2.0.png
  3. Select the drop-down menu and then choose the new device driver that you want to use.
    • NOTE: Custom drivers appear at the bottom of the list under the heading User.
      Select User Devices 2.0.png
  4. Select the Save button to the left of your screen.
    Save Device Driver 2.0.png

Your custom driver is now installed and will used by that device.

  • Don't forget to thank the developer in the community forum for their hard work.