Difference between revisions of "TTLock"

From Beds24 Wiki
Jump to navigation Jump to search
(45 intermediate revisions by 4 users not shown)
Line 4: Line 4:
 
[[Category:Automation]]
 
[[Category:Automation]]
 
<div class="heading">TTLock</div>
 
<div class="heading">TTLock</div>
−
   This page is about the menu {{#fas:cog}} (SETTINGS) APPS & INTEGRATIONS > TTLOCK Contact us if you want to use this integration.
+
   This page is about the menu {{#fas:cog}} (SETTINGS) APPS & INTEGRATIONS > TTLOCK  
  
 
For Beds24 the normal channel manger fees apply.
 
For Beds24 the normal channel manger fees apply.
  
 
= Capabilities =
 
= Capabilities =
−
*Beds24 can send booking data to TTLock locks.
+
*Beds24 can send booking data to TTLock locks as either an online or offline passcode.
−
*Auto-Check-in: when a lock is first opened by the guest the info code "CHECKIN" will be added to the booking.
 
  
−
= Limitations =
+
== Online passcodes ==
−
*The lock does not have to be connected to the internet to receive bookings, however it must be connected to the internet to delete or receive updates for bookings.
+
Online passcodes are sent if the "PIN Strategy" is set to anything other than "Offline".
−
*The start and end times of passcodes must be on the hour, for example a start time of 9:20 will actually start at 9:00.
+
 
−
*Passcodes must be used at least once within 24 hours of their start times, otherwise they will become invalid.
+
'''Advantages'''
−
*Passcodes cannot be updated if they have not been used.
+
*Can be customised to be between 4-9 digits.
−
*Multiple passcodes in the same lock cannot share the same start and end time, this includes deleted passcodes.
+
*Can be automatically set to handy numbers such as the last 4 digits of the guest's phone number.
 +
*Can be updated or deleted.
 +
 
 +
'''Limitations'''
 +
*Requires the lock to be connected to the internet.
 +
*Passcodes must be unique in each lock. For example, you cannot have two bookings with the passcode "1234" in the same lock.
 +
 
 +
== Offline passcode ==
 +
Offline passcodes are sent if the "PIN Strategy" is set to "Offline".
 +
 
 +
'''Advantages'''
 +
*The lock does not need to be connected to the internet.
 +
 
 +
'''Limitations'''
 +
*Cannot be updated or deleted.
 +
*The passcode will between 6-9 digits and cannot be customised.
 +
*Passcodes must be unique in each lock. For example, you cannot have two bookings with the passcode "1234" in the same lock.
 +
*The start and end times must be on the hour, for example a start time of 9:20 will actually start at 9:00.
 +
*Must be used at least once within 24 hours of their start times, otherwise they will become invalid.
 +
*Multiple offline passcodes in the same lock cannot share the same start and end time, this includes deleted passcodes.
 
*A deleted passcode cannot be created again with the same start and end time.
 
*A deleted passcode cannot be created again with the same start and end time.
  
Line 23: Line 41:
 
To use this service you will need:  
 
To use this service you will need:  
 
* A TTLock lock
 
* A TTLock lock
−
* A TTLock account
+
* The TTLock account that added the lock
 +
 
 
= Set Up =
 
= Set Up =
 
'''Step 1:  Connect your TTLock Account'''  
 
'''Step 1:  Connect your TTLock Account'''  
 
* On the setup page enter your TTLock username (usually a phone number or email address) and password
 
* On the setup page enter your TTLock username (usually a phone number or email address) and password
 +
  Note: your username must be what you originally signed up for TTLock with. For example, if you initially signed up with an email address, then later added a phone number, you must provide your email address.
 +
  Note: the account you connect must be the top administrator account for the lock, this most likely means the account that initially setup the lock.
 +
 +
'''Step 2: Set your 'PIN Strategy' '''
 +
 +
If you have offline locks you need to use the PIN Strategy "Offline". In this case TTLock will auto generate a PIN which is not customizable.
 +
 +
If your locks are Wifi connected you can choose a "PIN Strategy"  then press SAVE.
 +
 +
If your locks do not support 0, 7, 8 or 9 in the PIN, use one of the random (1 - 6) options, these will create random numbers using only the digits 1,2,3,4,5 and 6.
 +
 +
'''Step 3: Connect Common Lock (optional)'''
  
−
[[Image:ttlock.png|500px|link=]]
+
A common lock is a lock that all bookings in the property will be able to access.
−
[[Media:ttlock.png|view large]]
 
  
−
'''Step 2: Set when bookings should send to locks'''  
+
Connecting a common lock is only possible for Wifi connected locks. After you have selected your PIN Strategy and saved click on "Get Codes" to define your common lock.
 +
 
 +
Bookings will be sent to the lock mapped to the room assigned to the booking, if there is no lock mapped for the room the booking will be sent to the common lock (if one is mapped). If both a room lock and a common lock are mapped, the booking will be sent to both. The room lock and the common lock will use the same PIN. Multiple common locks can be specified with a space between each of the lock mapping codes.
 +
 
 +
'''Step 4: Set when bookings should send to locks'''  
 
*The "Start Time" and "End Time" define the earliest Check-in time and latest Check-out time.
 
*The "Start Time" and "End Time" define the earliest Check-in time and latest Check-out time.
 
*The "Days in Advance" sets the days before check-in that the booking is sent to the lock.
 
*The "Days in Advance" sets the days before check-in that the booking is sent to the lock.
  
−
'''Step 3: Map your locks to your rooms'''  
+
'''Step 5: Map your locks to your rooms'''  
  
 
Bookings will be sent to the lock mapped to the room assigned to the booking.
 
Bookings will be sent to the lock mapped to the room assigned to the booking.
Line 42: Line 76:
 
You will see one identifier and name for each lock.  
 
You will see one identifier and name for each lock.  
 
Select the correct lock and save.
 
Select the correct lock and save.
−
 
−
 
−
[[Image:ttlock_mapping1.png|500px|link=]]
 
−
[[Media:ttolco_mapping1.png|view large]]
 
−
 
  
 
For each room/unit click on the name of the lock that is associated with the room.
 
For each room/unit click on the name of the lock that is associated with the room.
  
−
[[Image:ttlock_mapping.png|500px|link=]]
+
'''Step 6: Set up an Auto Action Email  to send the PIN to guests'''  
−
[[Media:ttlock_mapping.png|view large]]
 
−
 
 
−
'''Step 4: Set up an Auto Action Email  to send the PIN to guests'''  
 
  
 
*Go to  {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS.
 
*Go to  {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS.
 
*Create an Auto Action Email which includes the template variable for the pin which is [BOOKINGINFOCODETEXT:LOCK_PIN].
 
*Create an Auto Action Email which includes the template variable for the pin which is [BOOKINGINFOCODETEXT:LOCK_PIN].
−
 
−
'''Step 5: Activation'''
 
−
*
 
−
*
 
  
 
= How it works =
 
= How it works =
Line 68: Line 90:
 
Entry codes can only be used during the booking period, they will not provide access before or after.
 
Entry codes can only be used during the booking period, they will not provide access before or after.
  
−
*Updates to locks are sent periodically. To instantly send updates, click "Send Bookings to Locks". Updates cannot be sent to locks that are not connected to the internet.
+
*Updates to locks are sent periodically, approximately every 12 hours but at no fixed time of day. To instantly send updates, click "Export to TTLock". Updates cannot be sent to locks that are not connected to the internet (however, new offline bookings can be created for them).
 
*An entry code named Booking {room id}/{booking id} - {guest name} is added to the lock. Click on the "Lock Data" button to check which bookings have already been sent.
 
*An entry code named Booking {room id}/{booking id} - {guest name} is added to the lock. Click on the "Lock Data" button to check which bookings have already been sent.
 
*A booking info code named LOCK_PIN is created on the "Info" tab of the booking, this will show the access code for the booking.
 
*A booking info code named LOCK_PIN is created on the "Info" tab of the booking, this will show the access code for the booking.
Line 76: Line 98:
  
 
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span>  If a TTLock lock is offline codes can be added but not updated or deleted.
 
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span>  If a TTLock lock is offline codes can be added but not updated or deleted.
−
 
−
== App and code entry methods ==
 
−
There are two ways bookings can be sent to locks: app and code. You can select one or both methods.
 
−
 
−
 
−
=== Manually changing codes ===
 
−
# Navigate to  {{#fas:cog}} (SETTINGS) ACCOUNT > PREFERENCES "Bookings" and add "LOCK_PIN" to your Booking Info Code Values.
 
−
# You can now manually add a LOCK_PIN info code to your bookings.
 
−
 
−
 
−
 
−
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span>  If you manually set an invalid LOCK_PIN, it will be overwritten with a randomly generated pin the next time bookings are sent to locks. Each code can only be used once per lock. Before you can reuse a code it has to be removed from the lock.
 
  
 
==Custom Start and End access times ==
 
==Custom Start and End access times ==
Line 112: Line 122:
  
 
= Troubleshooting =
 
= Troubleshooting =
 +
'''Invalid account or invalid password'''
 +
 +
The username and password you provide must be the same username and password you used to create your TTLock account.
 +
 +
This will not necessarily be the same username you use to login to TTLock. For example, if you initially signed up with an email address, then later added a phone number, the correct username will be your email address.
 +
 +
 +
'''Cannot access the lock you want'''
 +
 +
The username you enter must be the top administrator account for the lock - most likely this will be the account that initially set up the lock.
 +
If the account provided is not the top administrator account, then you will not be able to access the lock, even if you can access it in the TTLock app with that account.
 +
 +
== Errors ==
 +
 +
'''Error: "You are using a low version APP. Please update it to the latest version and re-add the lock"'''
 +
 +
This error can be fixed by deleting the lock from the TTLock app and then re-adding it.
 +
 +
 +
'''Error: "failed or means no - 表示失败或否"'''
 +
 +
This error usually means the bluetooth connection between the lock and the gateway is too weak.
 +
 +
 +
'''Error: "The gateway is busy. Please try again later. - 网关正忙，请稍后再试。"
 +
 +
This error means their is a problem with the gateway's connection to the internet.
 +
 +
 +
'''Error: "The Lock is not connected to any Gateway. - 锁附近没有可用的网关。"
  
 +
This error means there is a problem with a lock's connection to the gateway.
  
 +
= FAQ =
 +
== Do you support TTHotel accounts? ==
 +
At this point in time TTHotel is not supported, only TTLock.
  
 
= Disconnect=
 
= Disconnect=
−
Click on "Disconnect" to terminate the connection.
+
Delete your username and password and set Synchronize to "disabled" to disconnect.

Revision as of 10:56, 6 February 2024

TTLock
 This page is about the menu  (SETTINGS) APPS & INTEGRATIONS > TTLOCK

For Beds24 the normal channel manger fees apply.

1 Capabilities

  • Beds24 can send booking data to TTLock locks as either an online or offline passcode.

1.1 Online passcodes

Online passcodes are sent if the "PIN Strategy" is set to anything other than "Offline".

Advantages

  • Can be customised to be between 4-9 digits.
  • Can be automatically set to handy numbers such as the last 4 digits of the guest's phone number.
  • Can be updated or deleted.

Limitations

  • Requires the lock to be connected to the internet.
  • Passcodes must be unique in each lock. For example, you cannot have two bookings with the passcode "1234" in the same lock.

1.2 Offline passcode

Offline passcodes are sent if the "PIN Strategy" is set to "Offline".

Advantages

  • The lock does not need to be connected to the internet.

Limitations

  • Cannot be updated or deleted.
  • The passcode will between 6-9 digits and cannot be customised.
  • Passcodes must be unique in each lock. For example, you cannot have two bookings with the passcode "1234" in the same lock.
  • The start and end times must be on the hour, for example a start time of 9:20 will actually start at 9:00.
  • Must be used at least once within 24 hours of their start times, otherwise they will become invalid.
  • Multiple offline passcodes in the same lock cannot share the same start and end time, this includes deleted passcodes.
  • A deleted passcode cannot be created again with the same start and end time.

2 What you need

To use this service you will need:

  • A TTLock lock
  • The TTLock account that added the lock

3 Set Up

Step 1: Connect your TTLock Account

  • On the setup page enter your TTLock username (usually a phone number or email address) and password
 Note: your username must be what you originally signed up for TTLock with. For example, if you initially signed up with an email address, then later added a phone number, you must provide your email address.
 Note: the account you connect must be the top administrator account for the lock, this most likely means the account that initially setup the lock.

Step 2: Set your 'PIN Strategy'

If you have offline locks you need to use the PIN Strategy "Offline". In this case TTLock will auto generate a PIN which is not customizable.

If your locks are Wifi connected you can choose a "PIN Strategy" then press SAVE.

If your locks do not support 0, 7, 8 or 9 in the PIN, use one of the random (1 - 6) options, these will create random numbers using only the digits 1,2,3,4,5 and 6.

Step 3: Connect Common Lock (optional)

A common lock is a lock that all bookings in the property will be able to access.

Connecting a common lock is only possible for Wifi connected locks. After you have selected your PIN Strategy and saved click on "Get Codes" to define your common lock.

Bookings will be sent to the lock mapped to the room assigned to the booking, if there is no lock mapped for the room the booking will be sent to the common lock (if one is mapped). If both a room lock and a common lock are mapped, the booking will be sent to both. The room lock and the common lock will use the same PIN. Multiple common locks can be specified with a space between each of the lock mapping codes.

Step 4: Set when bookings should send to locks

  • The "Start Time" and "End Time" define the earliest Check-in time and latest Check-out time.
  • The "Days in Advance" sets the days before check-in that the booking is sent to the lock.

Step 5: Map your locks to your rooms

Bookings will be sent to the lock mapped to the room assigned to the booking.

  • Click on "Get Codes"

You will see one identifier and name for each lock. Select the correct lock and save.

For each room/unit click on the name of the lock that is associated with the room.

Step 6: Set up an Auto Action Email to send the PIN to guests

  • Go to (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS.
  • Create an Auto Action Email which includes the template variable for the pin which is [BOOKINGINFOCODETEXT:LOCK_PIN].

4 How it works

4.1 Syncing

Bookings are automatically sent to locks the number of "Days in Advance" prior to check-in which you have selected.

Entry codes can only be used during the booking period, they will not provide access before or after.

  • Updates to locks are sent periodically, approximately every 12 hours but at no fixed time of day. To instantly send updates, click "Export to TTLock". Updates cannot be sent to locks that are not connected to the internet (however, new offline bookings can be created for them).
  • An entry code named Booking {room id}/{booking id} - {guest name} is added to the lock. Click on the "Lock Data" button to check which bookings have already been sent.
  • A booking info code named LOCK_PIN is created on the "Info" tab of the booking, this will show the access code for the booking.
  • If a booking date or room changes, those details will update in online locks.
  • If a booking is cancelled, the associated entry code will be deleted from online locks.
  • The associated entry code of a booking sent from Beds24 will be removed one day after check-out.

If a TTLock lock is offline codes can be added but not updated or deleted.

4.2 Custom Start and End access times

The access start and end times can be customized per booking using booking info codes.

A booking info code ACCESS_STARTTIME with a time of day (23:00 format) as the text will override the default start time.

A booking info code ACCESS_ENDTIME with a time of day (23:00 format) as the text will override the default end time.

Start and end dates can be set relative to the check in and check out date by defining times greater than 24 or negative.


For example :- ACCESS_STARTTIME = -10:00 will create a start time 10 hours before midnight of the check in day, i.e. 14:00 on the day before check in.

  • Booking Info code = ACCESS_STARTTIME
  • Booking Info Text = -10:00

For example :- ACCESS_ENDTIME = 34:00 will create an end time of 10:00 one day after checkout (34 = 24 + 10 hours)

  • Booking Info code = ACCESS_STARTTIME
  • Booking Info Text = 34:00


5 Troubleshooting

Invalid account or invalid password

The username and password you provide must be the same username and password you used to create your TTLock account.

This will not necessarily be the same username you use to login to TTLock. For example, if you initially signed up with an email address, then later added a phone number, the correct username will be your email address.


Cannot access the lock you want

The username you enter must be the top administrator account for the lock - most likely this will be the account that initially set up the lock. If the account provided is not the top administrator account, then you will not be able to access the lock, even if you can access it in the TTLock app with that account.

5.1 Errors

Error: "You are using a low version APP. Please update it to the latest version and re-add the lock"

This error can be fixed by deleting the lock from the TTLock app and then re-adding it.


Error: "failed or means no - 表示失败或否"

This error usually means the bluetooth connection between the lock and the gateway is too weak.


Error: "The gateway is busy. Please try again later. - 网关正忙，请稍后再试。"

This error means their is a problem with the gateway's connection to the internet.


Error: "The Lock is not connected to any Gateway. - 锁附近没有可用的网关。"

This error means there is a problem with a lock's connection to the gateway.

6 FAQ

6.1 Do you support TTHotel accounts?

At this point in time TTHotel is not supported, only TTLock.

7 Disconnect

Delete your username and password and set Synchronize to "disabled" to disconnect.

Retrieved from "https://wiki.beds24.com/index.php?title=TTLock&oldid=24542"