Difference between revisions of "Apps Code"
(Tag: Visual edit) |
(Tag: Visual edit) |
||
| Line 9: | Line 9: | ||
#<big>'''Select All''' the raw code, and then '''Copy''' the code.</big> | #<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>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 | + | #<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]] |
| − | #<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 | + | #<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]] |
| − | #<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 | + | #<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]] |
<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>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> | ||
| Line 19: | Line 19: | ||
<big>Not all user apps will require OAuth (Open Authorization). Consult the app developers documentation for instruction.</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| | + | #<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|600x600px]][[File:OAuth initial dialogue 2.0.png|none|thumb|600x600px]] |
*<big>If your client secret key becomes compromised, you may refresh it to protect the OAUTH2 endpoint security.</big> | *<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| | + | **<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|600x600px]] |
'''<big>Loading Your User Developed App</big>''' | '''<big>Loading Your User Developed App</big>''' | ||
| Line 29: | Line 29: | ||
#<big>Select '''Apps''' from the sidebar.</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 | + | #<big>Select the '''+Add User App''' button.</big>[[File:Install Saved User App 2.0.png|none|thumb|600x600px]] |
| − | #<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| | + | #<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|600x600px]] |
<big>That's it! You're all set to create glorious home automations with your new app.</big> | <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> | + | *<big>Don't forget to thank the developer in the community forum for their hard work.</big> |
Revision as of 01:22, 23 March 2021
The Hubitat community has developed some great apps to help you automate your devices in new, cool ways.
Installing custom apps
- The developer of the app will normally post a link to their app code. Follow their directions to get to the source code.
- 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.
- Select All the raw code, and then Copy the code.
- From the home page of your hub, select Apps Code in the side bar.
- Select the +New App button in the upper right corner of the Apps Code page.
- 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.
- Select the Save button in the top right. When modified goes away, your app is saved.
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.
Enabling OAuth
Not all user apps will require OAuth (Open Authorization). Consult the app developers documentation for instruction.
- After saving your user app code, select the Enable OAuth button and then Update to automatically generate the keys.
- If your client secret key becomes compromised, you may refresh it to protect the OAUTH2 endpoint security.
- To refresh the client secret, open your user app code, select OAuth and check to box for Refresh Client Secret, the select Update
Loading Your User Developed App
Once your app has successfully saved, you will need to load it to your hub before you can use it.
- Select Apps from the sidebar.
- Select the +Add User App button.
- Find your User App in the list and select it to instantly add it.
That's it! You're all set to create glorious home automations with your new app.
- Don't forget to thank the developer in the community forum for their hard work.
