Zigbee add-on v0.1.0 documentation

Zigbee add-on v0.1.0 documentation

about.html

@@ -208,7 +208,7 @@
 </ul>
 <p>See <a class="reference external" href="https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/software_maturity.html">Software maturity levels</a> in the nRF Connect SDK documentation for what experimental support means.
 Experimental support also means that the feature is either not certified or no sample is provided for the given feature (or both).</p>
-<p>See the <a class="reference internal" href="zboss/index.html#zigbee-zboss"><span class="std std-ref">ZBOSS Zigbee stack</span></a> page and the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/zigbee_devguide.html">external ZBOSS development guide and API documentation</a> for more information about the ZBOSS library.</p>
+<p>See the <a class="reference internal" href="zboss/index.html#zigbee-zboss"><span class="std std-ref">ZBOSS Zigbee stack</span></a> page and the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/zigbee_devguide.html">external ZBOSS development guide and API documentation</a> for more information about the ZBOSS library.</p>
 <p>For more information about Zigbee, download the <a class="reference external" href="https://csa-iot.org/developer-resource/specifications-download-request/">Zigbee Specification</a> from Connectivity Standards Alliance.</p>
 <div class="section" id="zigbee-topologies">
 <span id="id1"></span><h2>Zigbee topologies<a class="headerlink" href="#zigbee-topologies" title="Permalink to this headline">¶</a></h2>
@@ -251,7 +251,7 @@ <h2>Additional information<a class="headerlink" href="#additional-information" t
 <p>If you want to learn more about the Zigbee topics and terminology mentioned in this guide, read the following pages:</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="architectures.html#ug-zigbee-architectures"><span class="std std-ref">Architectures</span></a> page to learn more about the Zigbee architecture.</p></li>
-<li><p><a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/using_zigbee__z_c_l.html#ZCL_definitions">Common ZCL terms and definitions</a> section in the ZBOSS user guide.</p></li>
+<li><p><a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/using_zigbee__z_c_l.html#ZCL_definitions">Common ZCL terms and definitions</a> section in the ZBOSS user guide.</p></li>
 <li><p>Zigbee topologies in section 1.1.4 of the <a class="reference external" href="https://csa-iot.org/developer-resource/specifications-download-request/">Zigbee Specification</a>.</p></li>
 <li><p><a class="reference internal" href="configuring.html#zigbee-ug-sed"><span class="std std-ref">Sleepy End Device behavior</span></a> section on the <a class="reference internal" href="configuring.html#ug-zigbee-configuring"><span class="std std-ref">Configuring Zigbee add-on</span></a> page.</p></li>
 </ul>

commissioning.html

@@ -224,7 +224,7 @@
 The device is configured into the network, so that it can start communicating with other network nodes.
 If there is no network to join, the commissioning procedure ensures that a new network is created.</p>
 <p>You can configure Zigbee commissioning by setting parameters before the start of the <a class="reference internal" href="zboss/index.html#zigbee-zboss"><span class="std std-ref">ZBOSS Zigbee stack</span></a>.
-For more information, see the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/using_zigbee__z_c_l.html#zcl_zigbee_commissioning">Support for Zigbee commissioning</a> section in the ZBOSS stack documentation.</p>
+For more information, see the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/using_zigbee__z_c_l.html#zcl_zigbee_commissioning">Support for Zigbee commissioning</a> section in the ZBOSS stack documentation.</p>
 <div class="section" id="start-of-commissioning">
 <span id="zigbee-commissioning-start"></span><h2><a class="toc-backref" href="#id6">Start of commissioning</a><a class="headerlink" href="#start-of-commissioning" title="Permalink to this headline">¶</a></h2>
 <p>There are several ways the commissioning process can be started, according to the <a class="reference external" href="https://csa-iot.org/developer-resource/specifications-download-request/">Zigbee Specification</a>:</p>
@@ -235,10 +235,10 @@
 </ul>
 <p>In the ZBOSS stack, the commissioning can be started using one of the following options:</p>
 <ul class="simple">
-<li><p><a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/group__zb__general__start.html#ga31b4d46033aaf6a400409d03bd40d392">zboss_start()</a> that initializes the stack and starts the BDB commissioning procedure with the default modes (Network Steering, Network Formation, Finding and Binding).</p></li>
-<li><p><a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#ga0b54e93a19cadc5fc02df8eab18ecd45">bdb_start_top_level_commissioning()</a> that should be started after the stack initialization (for example, from the ZBOSS signal handler) and requires providing the commissioning mode’s <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#ga9c44bbce9f6f6b19b623837914959c02">zb_bdb_commissioning_mode_mask_e</a> mask.</p></li>
+<li><p><a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/group__zb__general__start.html#ga31b4d46033aaf6a400409d03bd40d392">zboss_start()</a> that initializes the stack and starts the BDB commissioning procedure with the default modes (Network Steering, Network Formation, Finding and Binding).</p></li>
+<li><p><a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#ga0b54e93a19cadc5fc02df8eab18ecd45">bdb_start_top_level_commissioning()</a> that should be started after the stack initialization (for example, from the ZBOSS signal handler) and requires providing the commissioning mode’s <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#ga9c44bbce9f6f6b19b623837914959c02">zb_bdb_commissioning_mode_mask_e</a> mask.</p></li>
 </ul>
-<p>For more information, see the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/using_zigbee__z_c_l.html#stack_start_initiation">Stack commissioning start sequence</a> section in the ZBOSS stack documentation.</p>
+<p>For more information, see the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/using_zigbee__z_c_l.html#stack_start_initiation">Stack commissioning start sequence</a> section in the ZBOSS stack documentation.</p>
 <p>With the Zigbee add-on, the application can use <a class="reference internal" href="lib/zigbee_app_utils.html#lib-zigbee-signal-handler"><span class="std std-ref">Zigbee default signal handler</span></a> to handle the ZBOSS signals and start the commissioning.</p>
 </div>
 <div class="section" id="commissioning-modes">
@@ -295,7 +295,7 @@
 For this purpose, it needs credentials, which usually take form of a network key.
 For <a class="reference internal" href="#centralized-security-network">Centralized security network</a>, the authentication and authorization also involves establishing a unique Trust Center Link Key (TCLK).</p>
 <dl>
-<dt>Network Steering in the Zigbee add-on for the nRF Connect SDK</dt><dd><p>In the ZBOSS stack, Network Steering is started using the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#gga9c44bbce9f6f6b19b623837914959c02ae31d4a2067eb711a43f7049b08710299">ZB_BDB_NETWORK_STEERING</a> bit mask.</p>
+<dt>Network Steering in the Zigbee add-on for the nRF Connect SDK</dt><dd><p>In the ZBOSS stack, Network Steering is started using the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#gga9c44bbce9f6f6b19b623837914959c02ae31d4a2067eb711a43f7049b08710299">ZB_BDB_NETWORK_STEERING</a> bit mask.</p>
 <p>In the Zigbee add-on, Network Steering for a node on a network can be started using the following additional options:</p>
 <ul class="simple">
 <li><p>When running the <a class="reference internal" href="samples/network_coordinator/README.html#zigbee-network-coordinator-sample"><span class="std std-ref">Zigbee Coordinator sample</span></a>, you can press the associated button.</p></li>
@@ -321,7 +321,7 @@
 <p>If Network Formation is successful, you can add nodes to the new network using <a class="reference internal" href="#network-steering">Network Steering</a>.
 If unsuccessful, the commissioning procedure stops here.</p>
 <dl>
-<dt>Network Formation in the Zigbee add-on for the nRF Connect SDK</dt><dd><p>In the ZBOSS stack, Network Formation is started using the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#gga9c44bbce9f6f6b19b623837914959c02ac723cfd38f78c08a673ec3664539027c">ZB_BDB_NETWORK_FORMATION</a> bit mask.</p>
+<dt>Network Formation in the Zigbee add-on for the nRF Connect SDK</dt><dd><p>In the ZBOSS stack, Network Formation is started using the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#gga9c44bbce9f6f6b19b623837914959c02ac723cfd38f78c08a673ec3664539027c">ZB_BDB_NETWORK_FORMATION</a> bit mask.</p>
 <p>In the Zigbee add-on, when using the <a class="reference internal" href="lib/zigbee_app_utils.html#lib-zigbee-signal-handler"><span class="std std-ref">Zigbee default signal handler</span></a> and the application implements the Zigbee Coordinator role, the Network Formation procedure is started right after the stack initialization.</p>
 </dd>
 </dl>
@@ -370,9 +370,9 @@ <h4>Distributed security network<a class="headerlink" href="#distributed-securit
 </ul>
 <p>Finding and Binding can be terminated if there are no corresponding clusters on the target node.</p>
 <dl>
-<dt>Finding and Binding in the Zigbee add-on for the nRF Connect SDK</dt><dd><p>In the ZBOSS stack, Finding and Binding is started using the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#gga9c44bbce9f6f6b19b623837914959c02ad9bcb56a6668b6ba6f37edc73a796b58">ZB_BDB_FINDING_N_BINDING</a> bit mask.</p>
-<p>Apart from the BDB top-level procedure API, you can use the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/group__zboss__bdb__comm__fb.html#gae6fd60a050559ef0aa3c3e5ec32bc515">zb_bdb_finding_binding_initiator()</a> function to manually control which binding table entries are to be created.
-For more information, see the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/group__zboss__bdb__api.html">BDB Commissioning API</a> section in the ZBOSS stack documentation.</p>
+<dt>Finding and Binding in the Zigbee add-on for the nRF Connect SDK</dt><dd><p>In the ZBOSS stack, Finding and Binding is started using the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/group__zboss__bdb__comm__start.html#gga9c44bbce9f6f6b19b623837914959c02ad9bcb56a6668b6ba6f37edc73a796b58">ZB_BDB_FINDING_N_BINDING</a> bit mask.</p>
+<p>Apart from the BDB top-level procedure API, you can use the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/group__zboss__bdb__comm__fb.html#gae6fd60a050559ef0aa3c3e5ec32bc515">zb_bdb_finding_binding_initiator()</a> function to manually control which binding table entries are to be created.
+For more information, see the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/group__zboss__bdb__api.html">BDB Commissioning API</a> section in the ZBOSS stack documentation.</p>
 </dd>
 </dl>
 </div>

configuring.html

@@ -241,7 +241,7 @@
 <ul class="simple">
 <li><p><a class="reference internal" href="zboss/index.html#zigbee-zboss"><span class="std std-ref">ZBOSS Zigbee stack</span></a>, with the <a class="reference internal" href="lib/osif.html#lib-zigbee-osif"><span class="std std-ref">Zigbee ZBOSS OSIF</span></a> subsystem acting as the linking layer between the ZBOSS stack and the nRF Connect SDK.
 The ZBOSS library is enabled by the <code class="docutils literal notranslate"><span class="pre">CONFIG_ZIGBEE_ADD_ON</span></code> Kconfig option.
-For more information about the ZBOSS stack, see also the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/zigbee_devguide.html">external ZBOSS development guide and API documentation</a>.</p></li>
+For more information about the ZBOSS stack, see also the <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/zigbee_devguide.html">external ZBOSS development guide and API documentation</a>.</p></li>
 <li><p><a class="reference external" href="https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/connectivity/networking/api/ieee802154.html">IEEE 802.15.4</a> radio driver - This library is automatically enabled when working with Zigbee on Nordic Semiconductor’s development kits.</p></li>
 </ul>
 </div>
@@ -358,7 +358,7 @@ <h3><a class="toc-backref" href="#id8">ZBOSS stack start options</a><a class="he
 <p>Zigbee is initialized after Zephyr’s kernel start.
 The ZBOSS stack can be started using one of the following options:</p>
 <ul class="simple">
-<li><p>Started and executed from the main thread, as <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/using_zigbee__z_c_l.html#stack_start_initiation">described in the ZBOSS development guide</a>.</p></li>
+<li><p>Started and executed from the main thread, as <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/using_zigbee__z_c_l.html#stack_start_initiation">described in the ZBOSS development guide</a>.</p></li>
 <li><p>Started from a dedicated Zephyr thread, which in turn can be created and started by calling <code class="xref c c-func docutils literal notranslate"><span class="pre">zigbee_enable()</span></code>.</p></li>
 </ul>
 <p>The dedicated thread can be configured using the following Kconfig options:</p>

configuring/other_ecosystems.html

@@ -263,7 +263,7 @@ <h3><a class="toc-backref" href="#id5">Checking connection status</a><a class="h
 <li><p>Make sure that the device is scanning through all channels to find the Zigbee network.
 For example, verify that the <code class="docutils literal notranslate"><span class="pre">CONFIG_ZIGBEE_CHANNEL_SELECTION_MODE_MULTI</span></code> Kconfig option is correctly set.</p></li>
 <li><p>Check if the device is compatible with Zigbee 3.0.
-If it is <em>not</em> compatible, enable the legacy mode by including a call to <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/docs/zboss/4.1.4.2/group__zboss__bdb__comm__params.html#ga8bf3b3beef192c00bcdca17ad1240921">zb_bdb_set_legacy_device_support</a>.</p></li>
+If it is <em>not</em> compatible, enable the legacy mode by including a call to <a class="reference external" href="https://nrfconnect.github.io/ncs-zigbee/zboss/4.1.4.2/group__zboss__bdb__comm__params.html#ga8bf3b3beef192c00bcdca17ad1240921">zb_bdb_set_legacy_device_support</a>.</p></li>
 </ol>
 </div>
 </div>