Difference between revisions of "Lock Code Manager"

From Hubitat Documentation
Jump to: navigation, search
Line 5: Line 5:
 
===<big>Installing Hubitat Lock Code Manager</big>===
 
===<big>Installing Hubitat Lock Code Manager</big>===
  
#<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|600x600px]]
+
#<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|600x600px|link=https://docs.hubitat.com/images/7/77/Install_Built-In_App_2.0.png
#<big>Choose '''Lock Code Manager''' from the list of Hubitat Elevation built-In apps.</big>[[File:Install LCM 2.0.png|none|thumb|600x600px]]
+
]]
#<big>Select '''Done''' to complete the installation.</big>[[File:LCM post install step 2.0.png|none|thumb|600x600px]]
+
#<big>Choose '''Lock Code Manager''' from the list of Hubitat Elevation built-In apps.</big>[[File:Install LCM 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/d/df/Install_LCM_2.0.png
 +
]]
 +
#<big>Select '''Done''' to complete the installation.</big>[[File:LCM post install step 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/0/05/LCM_post_install_step_2.0.png
 +
]]
  
 
===<big>Renaming users</big>===
 
===<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>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|600x600px]]
+
#*<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|600x600px|link=https://docs.hubitat.com/images/7/74/LCM_Retrieve_codes_2.0.png
 +
]]
 
#<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>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|600x600px]]
+
#*<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|600x600px|link=https://docs.hubitat.com/images/5/5f/LCM_initial_code_capture_2.0.png
#<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|600x600px]]
+
]]
#<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|600x600px]][[File:LCM User name change confirmed 2.0.png|none|thumb|600x600px]][[File:LCM User successfully renamed 2.0.png|none|thumb|600x600px]]
+
#<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|600x600px|link=https://docs.hubitat.com/images/9/99/LCM_Rename_the_user_step_1.png
 +
]]
 +
#<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|600x600px|link=https://docs.hubitat.com/images/7/7c/LCM_rename_the_user_2.0.png
 +
]][[File:LCM User name change confirmed 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/4/40/LCM_User_name_change_confirmed_2.0.png
 +
]][[File:LCM User successfully renamed 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/2/2f/LCM_User_successfully_renamed_2.0.png
 +
]]
  
 
===<big>Lock code encryption</big>===
 
===<big>Lock code encryption</big>===
Line 23: Line 32:
 
*<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>
 
*<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]]
+
[[File:Enable lockCode encryption.png|none|thumb|362x362px|link=https://docs.hubitat.com/images/a/ac/Enable_lockCode_encryption.png
 +
]]
  
 
===<big>Assigning and changing user access privileges</big>===
 
===<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|600x600px]]
+
#<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|600x600px|link=https://docs.hubitat.com/images/8/8e/LCM_Modify_a_user_slot_2.0.png
#<big>Select '''User''' '''Option''' to modify privileges.</big>[[File:LCM change user access option 2.0.png|none|thumb|600x600px]]
+
]]
#<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|600x600px]]
+
#<big>Select '''User''' '''Option''' to modify privileges.</big>[[File:LCM change user access option 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/0/0a/LCM_change_user_access_option_2.0.png
#<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|600x600px]]
+
]]
#<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|600x600px]]
+
#<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|600x600px|link=https://docs.hubitat.com/images/8/85/LCM_Choose_access_option_2.0.png
 +
]]
 +
#<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|600x600px|link=https://docs.hubitat.com/images/a/aa/LCM_modify_access_options_2.0.png
 +
]]
 +
#<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|600x600px|link=https://docs.hubitat.com/images/1/15/LCM_Disable_by_date_example_2.0.png]]
 
#<big>Select the '''Update user code options''' button to make the change to a user's access privileges.</big>
 
#<big>Select the '''Update user code options''' button to make the change to a user's access privileges.</big>

Revision as of 21:45, 29 March 2021

Go to the top of the page

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.

Installing Hubitat Lock Code Manager

  1. From the sidebar of your hub, select Apps and press the Add Built-In App button.
    Install Built-In App 2.0.png
  2. Choose Lock Code Manager from the list of Hubitat Elevation built-In apps.
    Install LCM 2.0.png
  3. Select Done to complete the installation.
    LCM post install step 2.0.png

Renaming users

  1. 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.
    • NOTE: Please remember that while locks may support up to 8 digits, stand-alone keypads only support 4 digit codes.
      LCM Retrieve codes 2.0.png
  2. 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.
    • 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.
      LCM initial code capture 2.0.png
  3. 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.
    LCM Rename the user step 1.png
  4. 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.
    LCM rename the user 2.0.png
    LCM User name change confirmed 2.0.png
    LCM User successfully renamed 2.0.png

Lock code encryption

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.

  • 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.
Enable lockCode encryption.png

Assigning and changing user access privileges

  1. To change a user's access privileges, select the user name from the list of existing users.
    LCM Modify a user slot 2.0.png
  2. Select User Option to modify privileges.
    LCM change user access option 2.0.png
  3. Once an option is selected, a button with the option name will appear below it.
    LCM Choose access option 2.0.png
  4. Select the button to enter the settings for the user's access privileges where applicable.
    LCM modify access options 2.0.png
  5. 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.
    LCM Disable by date example 2.0.png
  6. Select the Update user code options button to make the change to a user's access privileges.