/ttlockio

Python wrapper for TTLock API

Primary LanguagePythonMIT LicenseMIT

ttlock.io

Python wrapper for TTLock API

  1. Register a developer account
https://open.ttlock.com/reg
  1. Log in
https://open.ttlock.com/login
  1. Create application:
https://open.ttlock.com/manager/apps/create
  • The application needs to be reviewed. After it is reviewed, all the APIs are available.
  1. Create a user for this application and get the access token:
$ pip install ttlockio
$ create_user_and_access_token YOUR_APP_CLIENT_ID YOUR_APP_CLIENTSECRET NEW_NAME_FOR_YOUR_USER NEW_PASS_FOR_YOUR_USER https://yoursitedomain.com/

  • ATTENTION: you need pass the NEW_PASS_FOR_YOUR_USER with max 32 chars, low case

  • Return:

[
  {
    "ttlockclientapp": "YOUR_APP_CLIENT_ID",
    "ttlocktoken": "YOUR_ACCESS_TOKEN",
    "username": "YOUR_APP_NAME_CONCAT_NEW_NAME_FOR_YOUR_USER",
    "refreshtoken": "YOUR_REFRESH_TOKEN"
  }
]
  1. Test your USER:
  • Download TTLock App at your cellphones app store. Log in with your YOUR_APP_NAME_CONCAT_NEW_NAME_FOR_YOUR_USER and NEW_PASS_FOR_YOUR_USER created on step four.
  • Add your TTLock gateways and locks.
  1. Install and Use
$ pip install ttlockio 
$ python3
>>import ttlockwrapper
>>gateways = list(ttlockwrapper.TTLock(clientId='YOUR_APP_CLIENT_ID',accessToken='YOUR_ACCESS_TOKEN').get_gateway_generator())
>>print('Gateway ID and Gateway Lock quantity: {}, {}'.format(gateways[0].get('gatewayId'),gateways[0].get('lockNum')))
  1. Examples
  • See example dir at this repo.