.. Tedee-docs documentation master file, created by
   sphinx-quickstart on Mon Mar 23 10:22:37 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Tedee Lock BLE API documentation
================================

.. toctree::
   :maxdepth: 1
   :caption: Overview
   :hidden:

   getting-started
   logo-guidance
   release-notes

.. toctree::
   :maxdepth: 1
   :caption: How to ...
   :hidden:

   Begin integration <howtos/begin-integration>
   Find Tedee Lock <howtos/find-tedee-lock>
   Establish PTLS session <howtos/establish-ptls-session>
   Lock operations <howtos/lock-operations>
   Lock calibration <howtos/lock-calibration>
   Get Lock state <howtos/get-state>
   Get Activity Logs <howtos/activity-logs>

.. toctree::
   :maxdepth: 1
   :includehidden:
   :caption: BLE
   :hidden:

   Basics <ble/basics>
   Advertisement <ble/advertisement>
   Services <ble/services>
   Characteristics <ble/characteristics>
   Message format <ble/message_frame>

.. toctree::
   :maxdepth: 1
   :includehidden:
   :caption: PTLS session
   :hidden:

   Basics <ptls/basics>
   Hash calculation <ptls/hash_calculation>
   Hello messages <ptls/hello_handshake>
   Server verification <ptls/server_verification>
   Client verification <ptls/client_verification>
   Secured communication <ptls/secured_communication>

.. toctree::
   :maxdepth: 1
   :includehidden:
   :caption: Commands
   :hidden:

   commands/security/index
   commands/operations/index
   commands/battery/index
   commands/calibration/index
   commands/pullcalibration/index
   commands/state/index
   commands/activity-logs/index

.. toctree::
   :maxdepth: 1
   :caption: Notifications
   :hidden:

   notifications/security/index
   notifications/operations/index
   notifications/battery/index
   notifications/calibration/index
   notifications/activity-logs/index

This site contains documentation for Tedee Lock BLE API.
It aims to help users to integrate custom solutions with Tedee Lock BLE API.

.. note::
   By using this API, you agree to our `Terms of Use <https://tedee.com/terms-of-use-tedee-apis-and-sdks/>`_.

About Tedee
-----------

**Tedee** is a smart home system that allows you to control access to your home directly from your phone. Please visit our site for more details https://tedee.com.

Useful links
------------

- `Forum <https://tedee.freshdesk.com/en/support/discussions>`_
- `Tedee API <https://api.tedee.com/>`_
- `Tedee API doc <https://tedee-tedee-api-doc.readthedocs-hosted.com/en/latest/>`_
- `Documentation repository <https://github.com/tedee-com/tedee-lock-ble-api-doc>`_


Need help?
----------

We encourage you to join a discussion or start a new one under `Community forum <https://tedee.freshdesk.com/en/support/discussions>`_ or ask on `Twiter (@tedee_smartlock) <https://twitter.com/tedee_smartlock>`_.