Difference between revisions of "How to Install Custom Drivers"

From Hubitat Documentation
Jump to: navigation, search
m (Added ™)
(Content 2.0 change)
Line 1: Line 1:
−
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. This is how it is done:
+
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.
  
−
#The developer of the app will normally post a link to their app code. Follow their directions to get to the source code. #Select and copy the source code.
+
'''Installing custom drivers'''
−
#From your Hubitat Web Interface, click on ''Drivers Code'' in the menu bar.
+
 
−
#Click on the ''+New Driver'' button in the upper right corner.
+
#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.
−
#In the blank text field, simply paste the driver code.
+
#From your Hubitat Elevation™ Web Interface, select '''Drivers Code''' in the side bar.
−
#Click on the ''Save'' button in the top right of the page. When the "modified" goes away, your app is saved.
+
#Select the ''+New Driver'' button in the upper right corner.[[File:New User Driver code 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:New_User_Driver_code_2.0.png]]
−
+
#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.[[File:Add user driver code 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Add_user_driver_code_2.0.png]]
 +
#Select the ''Save'' button in the top right of the page. When the "modified" goes away, your driver is saved.[[File:User Driver code unsaved 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:User_Driver_code_unsaved_2.0.png]]
  
 
'''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.
 
'''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'''
−
 
 
−
'''Loading Your User Developed Driver'''
 
−
 
 
−
Once your driver has successfully saved, you will need to update your device(s) with the new driver.
 
−
 
 
−
#From the home page of the Hubitat Web Interface click on the ''Devices'' link.
 
−
#Select the device for which you want to add a new driver.
 
  
−
This opens your Device Settings view. Scroll down to find the ''Type'' field. The name of a driver will be listed there. #Click on the drop down menu and then select your new device driver that you want to install.
+
Once your driver has successfully saved, you will need to update your device(s) with the new driver.
  
−
#Click on the ''Save'' button to the left of your screen.
+
#From the home page of the Hubitat Elevation™ Web Interface, select '''Devices''' in the side bar.[[File:Add Virtual Device 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Add_Virtual_Device_2.0.png]]
 +
#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.[[File:Change driver type 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Change_driver_type_2.0.png]]
 +
#Select the drop-down menu and then choose the new device driver that you want to use. Custom drivers appear at the bottom of the list under the heading ''User''.[[File:Select User Devices 2.0.png|none|thumb|395x395px|link=https://docs.hubitat.com/File:Select_User_Devices_2.0.png]]
 +
#Select the ''Save'' button to the left of your screen.[[File:Save Device Driver 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Save_Device_Driver_2.0.png]]
  
−
Your driver is now installed and being used by that device.
+
Your driver is now installed and will used by that device.

Revision as of 04:31, 14 November 2018

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 your Hubitat Elevation™ Web Interface, select Drivers Code in the side bar.
  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.
    User Driver code unsaved 2.0.png

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.

  1. From the home page of the Hubitat Elevation™ Web Interface, 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. 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 driver is now installed and will used by that device.

Retrieved from "https://docs.hubitat.com/index.php?title=How_to_Install_Custom_Drivers&oldid=1043"