Skip to content

Custom Component to integrate ttlock api on Home Assistant

License

Notifications You must be signed in to change notification settings

tonyldo/lock.ttlock

Repository files navigation

TTLock

License hacs Project Stage

This component will set up the following platforms.

Platform Description
sensor Show info from ttlock API.
lock Control ttlock lock devices.

Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called blueprint.
  4. Download all the files from the custom_components/ttlock/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. Add ttlock: to your HA configuration.

Using your HA configuration directory (folder) as a starting point you should now also have this:

custom_components/ttlock/.translations/en.json
custom_components/ttlock/.translations/nb.json
custom_components/ttlock/.translations/sensor.nb.json
custom_components/ttlock/__init__.py
custom_components/ttlock/binary_sensor.py
custom_components/ttlock/config_flow.py
custom_components/ttlock/const.py
custom_components/ttlock/manifest.json
custom_components/ttlock/sensor.py
custom_components/ttlock/switch.py

Example configuration.yaml

ttlock:
  client_id: ""
  client_secret: ""
  access_token: ""
  refresh_token: ""

Configuration options

Key Type Required Description
client_id string True The app_id which is assigned by system when you create an application.
client_secret string True The app_secret which is assigned by system when you create an application.
access_token string True Access token.
refresh_token string True Refresh token.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines


About

Custom Component to integrate ttlock api on Home Assistant

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published