|
|
| Line 1: |
Line 1: |
| − | {{Top}}
| |
| | | | |
| − | <big>The Hubitat Lock Code Manager app allows you to add and manage users on supported locks, set access limits or completely block access privileges. Keypads are also supported.</big> | + | <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> |
| | | | |
| − | ===<big>Installing Hubitat Lock Code Manager</big>===
| + | <big> |
| − | | + | This document is available at: http://docs2.hubitat.com/en/apps/lock-code-manager |
| − | #<big>From the sidebar of your hub, select '''Apps''' and press the '''Add Built-In App''' button.</big>[[File:Install Built-In App 2.0.png|none|thumb|800x800px|link=https://docs.hubitat.com/images/7/77/Install_Built-In_App_2.0.png ]]
| + | </big> |
| − | #<big>Choose '''Lock Code Manager''' from the list of Hubitat Elevation built-In apps.</big>[[File:Install LCM 2.0.png|none|thumb|700x700px|link=https://docs.hubitat.com/images/d/df/Install_LCM_2.0.png |alt=Screenshot: Lock Code Manager in built-in apps list]]
| |
| − | #<big>Select '''Done''' to complete the installation.</big>[[File:LCM post install step 2.0.png|none|thumb|900x900px|link=https://docs.hubitat.com/images/0/05/LCM_post_install_step_2.0.png |alt=Screenshot: LCM after install with "Done" button]]
| |
| − | | |
| − | ===<big>Renaming users</big>===
| |
| − | | |
| − | #<big>On first run, Lock Code Manager attempts to automatically import existing codes from your locks and keypads. If no existing codes have been imported, an option to manually retrieve codes will appear.</big>
| |
| − | #*<big>'''NOTE''': Please remember that while locks may support up to 8 digits, stand-alone '''keypads only support 4 digit codes'''.</big>[[File:LCM Retrieve codes 2.0.png|none|thumb|900x900px|link=https://docs.hubitat.com/images/7/74/LCM_Retrieve_codes_2.0.png |alt=Screenshot: "Request Lock Codes from Existing Devices?" link in LCM]]
| |
| − | #<big>Imported codes will not have names associated unless programmed via the driver in advance. Lock Code Manager allows you to easily assign and change names.</big>
| |
| − | #*<big>'''NOTE''': Schlage locks do not allow the export of any existing codes. To use Lock Code Manager with Schlage locks, it is recommended to delete the existing codes on the lock and instead enter them via Lock Code Manager or the lock driver so they will be readable by Lock Code Manager.</big>[[File:LCM initial code capture 2.0.png|none|thumb|900x900px|link=https://docs.hubitat.com/images/5/5f/LCM_initial_code_capture_2.0.png |alt=Screenshot: LCM with retrieved lock codes displayed after fetching]]
| |
| − | #<big>Select the slot you would like to change, then tap or click the empty space at the bottom to refresh the page and move to the next step.</big>[[File:LCM Rename the user step 1.png|none|thumb|900x900px|link=https://docs.hubitat.com/images/9/99/LCM_Rename_the_user_step_1.png |alt=Screenshot: Renaming user in LCM (or move to the next step)]]
| |
| − | #<big>Select the '''Rename this user''' button to complete the process and rename the user. '''DO NOT''' select the '''Done''' button unless you want to cancel the process.</big>[[File:LCM rename the user 2.0.png|none|thumb|950x950px|link=https://docs.hubitat.com/images/7/7c/LCM_rename_the_user_2.0.png |alt=Screenshot: Renaming user in LCM (do NOT select "Done" until after "Rename this user"!)]][[File:LCM User name change confirmed 2.0.png|none|thumb|650x650px|link=https://docs.hubitat.com/images/4/40/LCM_User_name_change_confirmed_2.0.png |alt=Screenshot: "All names changed from Code #1 to Marc" as an example of post-rename screen in LCM]][[File:LCM User successfully renamed 2.0.png|none|thumb|950x950px|link=https://docs.hubitat.com/images/2/2f/LCM_User_successfully_renamed_2.0.png |alt=Screenshot: LCM with new code name displayed in list]]
| |
| − | | |
| − | ===<big>Lock code encryption</big>===
| |
| − | <big>You have the option to '''Enable lockCode encryption''' in the lock driver. This is allows codes to be hidden from view in the logs, but Lock Code Manager will still be able to read and make changes to the lock codes.</big>
| |
| − | | |
| − | *<big>'''NOTE:''' If you are migrating to a new hub, please turn off '''Enable lockCode encryption''' in your lock driver prior to saving the backup for migration to the new hub. The encryption key cannot be transferred to another hub, thus Lock Code Manager will no longer be able to read encrypted lock codes. You can turn on '''Enable lockCode encryption''' on the new hub once the migration has completed.</big>
| |
| − | | |
| − | [[File:Enable lockCode encryption.png|none|thumb|362x362px|link=https://docs.hubitat.com/images/a/ac/Enable_lockCode_encryption.png
| |
| − | |alt=Screenshot: "Enable lockCode encryption" option on device detail page]]
| |
| − | | |
| − | ===<big>Assigning and changing user access privileges</big>===
| |
| − | | |
| − | #<big>To change a user's access privileges, select the user name from the list of existing users.</big>[[File:LCM Modify a user slot 2.0.png|none|thumb|950x950px|link=https://docs.hubitat.com/images/8/8e/LCM_Modify_a_user_slot_2.0.png |alt=Screenshot: Select user in LCM to make changes]]
| |
| − | #<big>Select '''User''' '''Option''' to modify privileges.</big>[[File:LCM change user access option 2.0.png|none|thumb|950x950px|link=https://docs.hubitat.com/images/0/0a/LCM_change_user_access_option_2.0.png |alt=Screenshot: "User Option" link for user in LCM]]
| |
| − | #<big>Once an option is selected, a button with the option name will appear below it.</big>[[File:LCM Choose access option 2.0.png|none|thumb|970x970px|link=https://docs.hubitat.com/images/8/85/LCM_Choose_access_option_2.0.png |alt=Screenshot: options for code in LCM (e.g., "Always Enabled")]]
| |
| − | #<big>Select the button to enter the settings for the user's access privileges where applicable.</big>[[File:LCM modify access options 2.0.png|none|thumb|970x970px|link=https://docs.hubitat.com/images/a/aa/LCM_modify_access_options_2.0.png |alt=Screenshot: "Disable Date" option in LCM]]
| |
| − | #<big>Set the parameters for access. For example, this user's access shown below will expire on January 1, 2019 at 8pm. Select the '''Done''' button to continue.</big>[[File:LCM Disable by date example 2.0.png|none|thumb|970x970px|link=https://docs.hubitat.com/images/1/15/LCM_Disable_by_date_example_2.0.png|alt=Screenshot: "Done" button in LCM]]
| |
| − | #<big>Select the '''Update user code options''' button to make the change to a user's access privileges.</big>
| |
