KeyButler

User Manual

English | 繁體 | 简体
Key Butler is an Android App. It is required for your NFC smartphone to interact with the compatible locks.
Key Butler requires NFC function. Suggest to enable the NFC function of your smartphone all the time for Key Butler to work properly. NFC consumes very little power and it typically won't cause any significant impact of your battery life.
NFC is a short distance (Typically < 1 inch) wireless communication. There are NFC antenna on both your NFC smartphone and the lock. Different phones has different NFC antenna positions. Before using Key Butler, try to find out the best NFC antenna position of your phone. Always use your phone to tap the lock with both antenna overlapped properly.
Please note that Key Butler will use NFC only when the phone is in screen unlock state; always unlock your phone screen before tap your phone to the lock.
Please do not use metal back-case on your smartphone. It will impact the NFC wireless signal.
Sometimes NFC communication is not good if NFC antenna of the phone and the lock are not aligned properly, or the phone is removed away too quickly before communication is finished. Try again by holding the phone a little bit longer at the right position.
Please note that reset the phone to factory default, or un-install Key Butler, or clear data of Key Butler, will cause the loss of access rights. Even re-install Key Butler, the phone will not be seen as the same User from the locks' perspective after these “destructive” operations.
For security reason, Key Butler data cannot be moved to another phone. Therefore backup function is not available now.
A NFC smartphone with Key Butler installed, or a contactless card, is called a User. For a User to unlock a lock, it must become a Valid User of the lock. Only Valid Users can unlock the lock.
There are two kinds of Valid Users. The first one is Administrator. A lock has only one Administrator at a time. Besides unlock, the Administrator also responsible for manage the lock and all the Clients.

A smartphone could be Administrators of some locks, and also be Clients of other locks at the same time.
The second kind of Valid Users is Client. A lock can has multiple Clients. A Client can unlock the lock.
Administrator is generated by the Pairing process. Please see the Pairing section.
Clients are added/deleted by the Administrator. Please see the Add Client section and Delete Client section.
A User can engage with multiple locks at the same time. For each lock, the User can be either the Administrator or a Client only.
Both the lock and the Administrator have a database inside their memory. Use the Administrator to tap the lock will synchronize their databases. So if the Administrator make any changes related to a lock, tap that lock for these modifications to take effect. If there is any changes occurs on a lock, use Administrator to tap that lock to get those information.
Please download and install Key Butler from Google Play.
On first Key Butler execution, set your User name that will be seen by other Users. Also set the email address to register an account (one email address can only be used on one smartphone.) Make sure you are connected to Internet. Then click “>” to proceed.
Key Butler server will send an email to your email address (Depends on Internet situation it may be immediately or take a while.) There is a Validation Code contains in the email. Fill the Validation Code into Key Butler, then click “>” to proceed.
After server validation, your account registration is completed.
If you don't want to register now, uncheck “Enable Cloud Functionality”. You will not be able to use Cloud function of Key Butler but you can still interact with your locks locally.
And you can register later from the Setup page.
Pairing is the process of becoming the Administrator of a lock.
1.
Open Key Butler, and select “Add Lock”
2.
DIN is a special phrase of the lock. Correct DIN must be entered for start the Pairing process. Get the DIN from the lock package.
3.
Set a name for the lock. Then click the “>” button.
4.
Key Butler will show an instruction page for the Pairing process. Make your phone stay in this page while doing Pairing.
5.
To initial Pairing, click the Setup button on the inner side of the lock. Some modes of locks might have a slightly different method of entering the setup mode; please refer to the lock user manual for the correct procedure.
6.
Before time-out, keep the phone at the instruction page to tap the lock.
7.
Upon successful NFC communication, the phone becomes the Administrator of the lock.
Note: if DIN is incorrect, the Pairing process will not start. Enter the correct DIN and try again.
Note: if the Setup button is not clicked or time-out, the Pairing process will not start. Click the Setup button and tap again.
Note: When a new Admin is generated, the old Admin is deleted.
Note: Besides the old Admin, all other Clients are unchanged. The new Admin can download the Clients from the lock.
Note: Log before pairing of the new Admin can be retrieved from a file of the old Admin. (Please check the Log section for the path of the file)
Administrator can unlock the lock, once Clients are added, Clients can unlock the lock by the same method.
1.
Unlock the phone screen
2.
To perform unlock, there is no need to open Key Butler app or set Key Butler to any specific page, just use the phone to tap the lock.
3.
A pop-up message will show up to indicate unlock successfully. The message will disappear automatically a few seconds later.
For Users who is not the Administrator nor a Client of the lock, a pop-up message will show up to indicate unlock fail.
1.
Open Key Butler, and select “Add Client (Local)”
2.
Step1: Use Administrator's phone to tap the lock.
3.
Step2: Use the target phone to tap the lock. After this step, the phone become a new Client of the lock and can be used to unlock thereafter.
4.
Step3 (Optional): Use Administrator's phone to tap the lock again to synchro- nize. This step is optional, and is performed automatically every time the Administrator's phone tap the lock thereafter. A pop-up message will show when there is new Client(s) be added.
Note: Only one new Client could be added at a time. To add multiple Clients, repeat this whole procedure.
This method is used when the lock is not nearby. NFC Beam and Bluetooth is used to provide access right from Admin to the new Client directly.
Before the operation, make sure the Android Beam function (if it is available on that smartphone) is not turned-off on the Admin phone.
And both phones need to enable Bluetooth before this operation.
1.
Select the Add Client (Beam) function.
2.
Select the lock you want to provide access right to the new Client.
3.
Have the Admin phone keep in the animation page, and the new Client phone turn on Key Butler.
4.
Put two phones in NFC Beam positions (their NFC antennas must be aligned).
5.
When Admin phone detects NFC, and screen shrinks, touch the screen of Admin phone to Beam (as the screen instructed).
6.
Once a Beam is performed, you can separate the phones. You will see a communication on-going message on both phones.
7.
After a while, it’s done.
Note: Certain models of locks might not support this feature, and you won’t see
Note: This function requires some synchronization between the Admin phone and the lock. If the Admin has not synchronized with the lock for a while or after pairing, this function is not available temporarily until Admin finishing the synchronization again.
If you have an account registered, you can add Client through Cloud (Internet). You and Lock and the new Client can be in different places. Make sure your Internet connection is on.
1.
Select the Add Client (Cloud) function.
2.
Fill in the email address of the new Client (the new Client must have registered by the email address). Proceed to next step.
3.
Select the Lock you would like to add this Client to.
4.
Modify the Access Right if you want to grant limited access only. Proceed to next step.
5.
You can add a few words to send to the new Client. Then proceed to next step.
6.
Review the information again. If anything is correct, proceed to next step.
7.
Key Butler will issue a Key to the new Client. If the Client is connected to Internet, a notification will be received.
8.
Click on the notification, the new Client can decide to accept or reject the new Key. If select Accept, the new Client can access the lock from now on.
Some models of locks provide restricted access right function.
1.
During Add Client (Beam or Local) animation page, click the "Access Right" area; or during Add Client (Cloud) after selecting a lock:
2.
The default pattern is "All Time", which means access right without restriction will be provided to the Client. Click the "Pattern" area to change setting.
3.
On the pop-up window, select the type of access right.
4.
If select "One time", the new Client only has a one-time access right.
5.
If select "By Period", the access right could be restricted to only a period of time with repeat capabilities.
6.
Confirm the selection to return to the Add Client procedures.
7.
Continue the Add Client procedures. The new Client will have the access right you selected.
Note: Admin can modify the access right of Clients later, by clicking on the access right area under the Personal Information page inside Edit Lock or Edit User. Remember to tap the lock again for any modification to take effect. 7. Continue the Add Client procedures. The new Client will have the access right you selected.
1.
Open Key Butler, and select “Edit Lock”
2.
Depends on your situation, there might be two groups of locks: “As an Admin” and “As a Client”
3.
Select a lock from the lock list of “As an Admin”, you will see all the Clients belonging to this lock.
4.
Select a lock from the lock list of “As a Client”, you will see who the Administrator is.
Note that this Edit Client(Card & Phone) won't be usable if there is no Client for you to manage
1.
Open Key Butler, and select “Edit Client(Card & Phone)”
2.
You will see a client list of Cards and Phones (if there are other kinds of Clients such as Password or Fingerprint, please go to Edit Lock for viewing); click any client.
3.
You will see all the locks the client is able to access.
1.
Open Key Butler, and select “Edit Lock”.
2.
Select a lock from the lock list of “As an Admin”.
3.
All the Clients of the lock is list below. Long press on any Client will appear check-box and a trash symbol.
4.
Select those Clients you want to delete, and click on the trash symbol on the top-right corner of screen.
5.
A Warning message will appear.
6.
After close the message, a red dot will appear before the Client you want to delete.
7.
For Cloud Client, it is possible you can delete through Cloud if the Client has Internet connection. Both Admin and Client will received a notification to inform this delete action.
Once a Client is deleted by Cloud, that phone won't be able to access the Lock immediately, even before the Admin tap the lock to inform this action.
8.
Tap the lock to commit the deletion to the lock.
1.
Open Key Butler, and select “Log”
2.
Select a lock from the lock list.”
3.
"Log File Path" is where the Log file located. The log shows when, who, and what event. Scroll the viewer up and down the view the full log list.
1.
Open Key Butler, and select “Edit Lock”
2.
On the right side of the lock list, there is a battery status icon. Those icons represent the battery status of locks when the Administrator tap the lock last time. If the administrator hasn't tapped the lock for more than 3 months (TBD), the battery level will become a question mark.
Note: Every time remove the battery and power-on again, please use Admin phone tap the lock again to synchronize the time. Otherwise new log events will have incorrect time.
Currently battery status is only available for those locks that you are their Adminis- trator.
1.
Admin receives Notifications of Client Unlock Events.

Note: Only from Clients with registered phones and connecting to Internet
2.
To stop receiving Notifications of a Lock, go to Edit Lock -> Select a Lock -> Configuration, and deselect "Enable for this Lock"
3.
You can also disable Notifications from a particular Client by going to Edit Lock -> Select a Lock -> Select a Client

Note: only Clients using registered phones have this option
1.
Open Key Butler, and select “Edit Lock”
2.
Select a lock from the lock list of “As an Admin”
3.
Click on the Configuration row.
4.
Modify the configuration, and click the tick on the top-right corner.
5.
A Warning message will appear.
6.
A red dot will appear before the item you want to change .
7.
Tap the lock to commit the change to the lock.
Note: Different modes of locks might have different parameters. Please check the lock user manual for details.
Every User can set the name to repre- sent itself. Administrator will see names of Clients, and Clients can see the name of the Administrator. Every user can modify its own name, but cannot modify other's names.
As an Admin, you can set nicknames of other Clients. Client can set nicknames of locks.
Once a nickname is set, all the display regarding that Client on the Adminis- trator’s screen will be shown by the nickname.
Nicknames can be deleted, and the original name of that User will be used.
Update Firmware is the process of updating the lock firmware through NFC. Key Butler will connect to the server automatically and check if any new version available for your locks. It is highly recommended always update your locks to the latest version.
1.
Open Key Butler, and select "Update Firmware"
2.
On the Lock List page, Key Butler will connect to the server and check for any available firmware of your locks

Note: please turn-on Internet connection for the version check.
3.
Click on any lock with status of "New version available"
4.
A downloaded firmware can be reused for all locks of the same model. If the firmware is not downloaded yet, click on the "Download" button here to download the firmware.

Note: please turn-on Internet connection for the downloading.
5.
If the latest firmware is already downloaded, the button will show "Downloaded". Press the next button on the top-right corner.
6.
Please enter setup mode (the method depends on lock models; some models require pushing the Setup button on the lock, and some models require additional PIN; please refer to the lock manuals for details), keep the screen at this page, and tap your phone to the lock. You will see the progress bar moving forward. Key Butler is programming the new firmware into the lock.

Note: make sure both your lock and your phone have sufficient battery power before this step.
Note: If you lost NFC connection during the process, tap again; As long as the disconnection is not too long, the updating procedure could be resumed.
7.
After the progress bar goes to 100%, the updating procedure is completed. Your lock is updated to the latest version now.
8.
After the updating process, please tap the lock again to sync information from the lock, including the firmware version information.