Difference between revisions of "Apps Code"

From Hubitat Documentation
Jump to: navigation, search
(Replaced content with " <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> <big>This document is available at: http://docs2.hubitat.com/en/user-i...")
(Tag: Replaced)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Top}}
 
  
<big>The Hubitat community has developed some great apps to help you automate your devices in new, cool ways.</big>
+
<big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big>
  
===<big>Installing custom apps</big>===
+
<big>This document is available at: http://docs2.hubitat.com/en/user-interface/developer/apps-code</big>
 
 
#<big>The developer of the app will normally post a link to their app code. Follow their directions to get to the source code.</big>
 
#<big>Typically developers will use GitHub to host code. When copying the code, choose the '''RAW''' button so that you are getting the raw form of the code, with no HTML formatting.</big>[[File:GitHub raw button v2.png|none|thumb|600x600px]]
 
#<big>'''Select All''' the raw code, and then '''Copy''' the code.</big>
 
#<big>From the home page of your hub, select '''Apps Code''' in the side bar.</big>
 
#<big>Select the '''+New App''' button in the upper right corner of the Apps Code page.</big>[[File:New User App dialogue 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:New_User_App_dialogue_2.0.png]]
 
#<big>In the blank text field, paste the code. Alternatively, you can select the '''Import''' button and past a URL to the developers code in raw text format.</big>[[File:Import user app code URL 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Import_user_app_code_URL_2.0.png]]
 
#<big>Select the '''Save''' button in the top right. When '''modified''' goes away, your app is saved.</big>[[File:User app code unsaved 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:User_app_code_unsaved_2.0.png]]
 
 
 
<big>You may experience an error in this step. If you do, your app will not save and it will not work. Please contact the developer of the app in the Hubitat Community forum. It is usually best if you take a screen shot of the error to help them diagnose the problem. Once the code is fixed, come back and try again.</big>
 
 
 
'''<big>Enabling OAuth</big>'''
 
 
 
<big>Not all user apps will require OAuth (Open Authorization). Consult the app developers documentation for instruction.</big>
 
 
 
#<big>After saving your user app code, select the '''Enable OAuth''' button and then '''Update''' to automatically generate the keys</big>.[[File:Enable OAuth 2.0.png|none|thumb|500x500px|link=https://docs.hubitat.com/File:Enable_OAuth_2.0.png]][[File:OAuth initial dialogue 2.0.png|none|thumb|500x500px|link=https://docs.hubitat.com/File:OAuth_initial_dialogue_2.0.png]]
 
 
 
*<big>If your client secret key becomes compromised, you may refresh it to protect the OAUTH2 endpoint security.</big>
 
**<big>To refresh the client secret, open your user app code, select OAuth and check to box for '''Refresh Client Secret''', the select '''Update'''</big>[[File:OAuth refresh client secret 2.0.png|none|thumb|400x400px|link=https://docs.hubitat.com/File:OAuth_refresh_client_secret_2.0.png]]
 
 
 
'''<big>Loading Your User Developed App</big>'''
 
 
 
<big>Once your app has successfully saved, you will need to load it to your hub before you can use it.</big>
 
 
 
#<big>Select '''Apps''' from the sidebar.</big>
 
#<big>Select the '''+Add User App''' button.</big>[[File:Install Saved User App 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/File:Install_Saved_User_App_2.0.png]]
 
#<big>Find your ''User App'' in the list and select it to instantly add it.</big>[[File:Install user app list 2.0.png|none|thumb|500x500px|link=https://docs.hubitat.com/File:Install_user_app_list_2.0.png]]
 
 
 
<big>That's it! You're all set to create glorious home automations with your new app.</big>
 
 
 
* <big>Don't forget to thank the developer in the community forum for their hard work.</big>
 

Latest revision as of 03:49, 25 September 2022

We're moving! Please visit http://docs2.hubitat.com for the latest documentation.

This document is available at: http://docs2.hubitat.com/en/user-interface/developer/apps-code