Skip to content

Commit f3ef4ce

Browse files
Przemyslaw Bidajfischer-no
Przemyslaw Bida
authored andcommitted
doc: openthread: Adding documentation about TCAT.
This commit add TCAT documentation section in NCS Thread related docs. Signed-off-by: Przemyslaw Bida <przemyslaw.bida@nordicsemi.no>
1 parent 34e116e commit f3ef4ce

File tree

5 files changed

+29
-0
lines changed

5 files changed

+29
-0
lines changed

CODEOWNERS

+2
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ Kconfig* @tejlmand
7474
/doc/nrf/security/ @greg-fer
7575
/doc/nrf/test_and_optimize/ @greg-fer
7676
/doc/nrf/*.rst @greg-fer
77+
# Protocols related docs
78+
/doc/nrf/protocols/thread/*.rst @wiba-nordic
7779
# All subfolders
7880
/drivers/ @anangl
7981
/drivers/serial/ @nordic-krch @anangl

doc/nrf/links.txt

+1
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@
9797
.. _`OpenThread CLI Reference - pollperiod command`: https://github.com/openthread/openthread/blob/main/src/cli/README.md#pollperiod
9898
.. _`Commissioner CLI commands`: https://github.com/openthread/openthread/blob/main/src/cli/README_COMMISSIONER.md
9999
.. _`Joiner CLI commands`: https://github.com/openthread/openthread/blob/main/src/cli/README_JOINER.md
100+
.. _`BBTC Client`: https://github.com/nrfconnect/sdk-openthread/tree/main/tools/tcat_ble_client
100101

101102
.. _`Breathe issue #437`: https://github.com/michaeljones/breathe/issues/437
102103
.. _`Breathe issue #438`: https://github.com/michaeljones/breathe/issues/438

doc/nrf/protocols/thread/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ You can find more information about Thread on the `Thread Group`_ pages.
3333
certification
3434
device_types
3535
sed_ssed
36+
tcat

doc/nrf/protocols/thread/tcat.rst

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _thread_tcat:
2+
3+
Thread Commissioning Over Authenticated TLS
4+
###########################################
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
Thread Commissioning Over Authenticated TLS (TCAT) was developed to address the needs of professional installation and commercial building scenarios.
11+
It makes it easy to wirelessly onboard Thread devices that are pre-installed in difficult-to-reach places, such as inside a ceiling or embedded in a wall.
12+
Instead of scanning physical install codes once the pre-installed devices are powered, Thread commissioning can be implemented over authenticated TLS (Transport Layer Security) by exchanging security certificates.
13+
TCAT can be performed using a mobile device (such as a phone, tablet) while in close proximity to the pre-installed device over a wireless connection such as Bluetooth® Low Energy.
14+
The |NCS| currently provides experimental support for TCAT.
15+
To test this feature, build the :ref:`ot_cli_sample` sample with the :ref:`TCAT snippet <ot_cli_sample_activating_variants>` enabled.
16+
17+
After flashing the sample to the device, use the following command to enable TCAT:
18+
19+
.. code-block:: console
20+
21+
uart:~$ ot tcat start
22+
23+
Currently, `BBTC Client`_ is the only available TCAT commissioner tool, and can be found in the OpenThread repository.
24+
Refer to the tool's documentation for more information.

samples/openthread/cli/README.rst

+1
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ The following snippets are available:
103103
Not compatible with the ``tcat`` snippet.
104104
* ``tcat`` - Enables support for Thread commissioning over authenticated TLS.
105105
Not compatible with the ``multiprotocol`` snippet.
106+
For using TCAT, refer to the :ref:`thread_tcat` page.
106107
* ``tcp`` - Enables experimental TCP support in this sample.
107108
* ``low_power`` - Enables low power consumption mode in this sample.
108109

0 commit comments

Comments
 (0)