1.0.0 • Published 7 months ago

homebridge-ttlock-homekey v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

Homebridge TTLock HomeKey Plug-In

PLEASE READ!!!

HomeKey Support is not integrated yet, but Access Code Features are working in HomeKit.

This is a Homebridge plug-in based for integrating TTLock smart locks with the TTLock Cloud API.

Features

  • Get the status of your TTLock devices.
  • Lock and unlock your TTLock devices.
  • Manage passcodes for your TTLock devices.
  • Integration into HomeKey for NFC Access to your TTLock devices.

Requirements

  1. TTLock Smart Lock
  2. A Gateway (If your lock does not have built-in Wi-Fi, I purchased a TTLock G2 Gateway off Amazon.)
  3. Remote Unlock must be enabled through the TTLock App locally within bluetooth or Wi-Fi rnage of your lock.
  4. You must create a TTLock Open API Account. This is not the username and password that will be used in the setting in the plug-in, this is for creating an OAUTH2.0 App with the TTLock Cloud API for the plug-in to get access to your TTLock Devices.

Setup

  1. Create an account in the TTLock Cloud API.
  2. Create your OAUTH2.0 App, give it a name, icon, select the 'App' option, and a short description. This may take a few days to be approved by their Development Team.
  3. Once approved, you will need the client_id and client_secret from the app.
  4. Setup the TTLock Mobile App, create an account in the Mobile App, setup and install your lock(s). If your Lock is not Wi-Fi Capable, make sure you setup your Gateway as well and have it close enough to your Lock for the Gateway to pick up the Lock in the Mobile App.
  5. Once you have your Mobile App Username and Password, and the client_id and client_secret, you can setup the plug-in in Homebridge.

IMPORTANT

I have only tested this with a G2 Gateway.