v0.2.0 documentation

Updates documentation for the v0.2.0 release.

Signed-off-by: Wille Backman <[email protected]>

_sources/architectures.rst.txt

@@ -14,8 +14,6 @@ This page describes the platform designs that are possible with the Zigbee stack
 
 The designs are described from the least to the most complex, that is from simple applications that consist of a single chip running single or multiple protocols to scenarios in which the nRF SoC acts as a network co-processor when the application is running on a much more powerful host processor.
 
-.. include:: /includes/coprocessor_note.txt
-
 .. _ug_zigbee_platform_design_soc:
 
 System-on-Chip designs
@@ -95,8 +93,6 @@ This platform design is suitable for the following development kit:
 Co-processor designs
 ********************
 
-.. include:: /includes/coprocessor_note.txt
-
 In co-processor designs, the application runs on one processor (the host processor) and communicates with another processor that provides the radio interface.
 In these designs, the more powerful processor (host) interacts with the Zigbee network through a connectivity device, for example a Nordic Semiconductor's device with the Zigbee interface.
 

_sources/lib/index.rst.txt

@@ -84,6 +84,7 @@ The following table lists libraries enabled by default for each available Zigbee
       - :ref:`Light bulb <zigbee_light_bulb_sample>`
       - :ref:`Light switch <zigbee_light_switch_sample>`
       - :ref:`Network coordinator <zigbee_network_coordinator_sample>`
+      - :ref:`NCP <zigbee_ncp_sample>`
       - :ref:`Shell (sample) <zigbee_shell_sample>`
       - :ref:`Template <zigbee_template_sample>`
     * - ZBOSS OSIF
@@ -92,28 +93,33 @@ The following table lists libraries enabled by default for each available Zigbee
       - ✔
       - ✔
       - ✔
+      - ✔
     * - Shell (library)
       -
       -
       -
+      -
       - ✔
       -
     * - Application utilities (default signal handler)
       - ✔
       - ✔
       - ✔
+      -
       - ✔
       - ✔
     * - Error handler
       - ✔
       - ✔
       - ✔
+      -
       - ✔
       - ✔
     * - Endpoint logger
       -
       -
       -
+      -
       - ✔
       -
     * - Scene helper
@@ -122,6 +128,7 @@ The following table lists libraries enabled by default for each available Zigbee
       -
       -
       -
+      -
 
 Read the table symbols in the following manner:
 

_sources/lib/osif.rst.txt

@@ -70,23 +70,23 @@ The ZBOSS OSIF serial implements sets of backend functions that are used by the
 
 These backend functions serve logging ZBOSS traces that are useful for debugging and are provided in binary format.
 
-..
-  These backend functions serve one or both of the following purposes:
 
-  * Logging ZBOSS traces - Used for handling stack logs that are useful for debugging and are provided in binary format.
-  * Handling NCP communication with the host device - Used only for the :ref:`NCP architecture <ug_zigbee_platform_design_ncp>`.
+These backend functions serve one or both of the following purposes:
+
+* Logging ZBOSS traces - Used for handling stack logs that are useful for debugging and are provided in binary format.
+* Handling NCP communication with the host device - Used only for the :ref:`NCP architecture <ug_zigbee_platform_design_ncp>`.
 
-  The following table shows which sets of functions serve which purpose.
+The following table shows which sets of functions serve which purpose.
 
-  .. _osif_table:
+.. _osif_table:
 
-  +----------------------------+---------------+---------------+----------+
-  |                            | Async serial  | Serial logger | Logger   |
-  +============================+===============+===============+==========+
-  | Logging ZBOSS traces       | -             | -             | -        |
-  +----------------------------+---------------+---------------+----------+
-  | Handling NCP communication | -             |               |          |
-  +----------------------------+---------------+---------------+----------+
++----------------------------+---------------+---------------+----------+
+|                            | Async serial  | Serial logger | Logger   |
++============================+===============+===============+==========+
+| Logging ZBOSS traces       | -             | -             | -        |
++----------------------------+---------------+---------------+----------+
+| Handling NCP communication | -             |               |          |
++----------------------------+---------------+---------------+----------+
 
 For more information about configuring ZBOSS stack logs, see :ref:`zigbee_ug_logging_stack_logs`.
 
@@ -116,16 +116,14 @@ To configure this set of functions, use the following Kconfig options:
 * ``CONFIG_ZIGBEE_HAVE_ASYNC_SERIAL`` - This option enables Zigbee async serial.
 * ``CONFIG_ZIGBEE_UART_SUPPORTS_FLOW_CONTROL`` - This option should be set if serial device supports flow control.
 * ``CONFIG_ZIGBEE_UART_RX_BUF_LEN`` - This option enables and configures the size of internal RX and TX buffer.
-
-..
-  * ``CONFIG_ZBOSS_TRACE_BINARY_NCP_TRANSPORT_LOGGING`` - This option enables logging ZBOSS traces in binary format with Zigbee async serial.
+* ``CONFIG_ZBOSS_TRACE_BINARY_NCP_TRANSPORT_LOGGING`` - This option enables logging ZBOSS traces in binary format with Zigbee async serial.
 
 The Zigbee ZBOSS OSIF layer serial device needs to be provided in devicetree as follows:
 
 .. code-block:: devicetree
 
    chosen {
-       ncs,zigbee-uart = &uart0;
+       ncs,zigbee-uart = &uart20;
    };
 
 Zigbee serial logger
@@ -149,7 +147,7 @@ The ZBOSS tracing serial device needs to be provided in Devicetree like this:
 .. code-block:: devicetree
 
    chosen {
-       ncs,zboss-trace-uart = &uart1;
+       ncs,zboss-trace-uart = &uart21;
    };
 
 Zigbee logger

_sources/memory.rst.txt

@@ -17,11 +17,6 @@ Values are provided for :ref:`ZBOSS libraries <zigbee_zboss>`.
 Samples were built using the available :ref:`zigbee_zboss`.
 Unless stated otherwise, the default :file:`prj.conf` was used.
 
-.. _zigbee_memory_52840:
-.. _zigbee_memory_52833:
-.. _zigbee_memory_5340:
-.. _zigbee_memory_21540:
-
 RAM and flash memory requirements
 *********************************
 
@@ -49,6 +44,8 @@ Values are provided in kilobytes (KB).
       +------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
       | :ref:`Light switch <zigbee_light_switch_sample>` with :ref:`zigbee_light_switch_sample_nus`                            | 446                      | 0                         | 32                               | 4                           | 482         | 72                       | 72          |
       +------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
+      | :ref:`NCP <zigbee_ncp_sample>`                                                                                         | 0                        | 0                         | 32                               | 4                           | 0           | 0                        | 0           |
+      +------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
       | :ref:`Zigbee application template <zigbee_template_sample>`                                                            | 392                      | 0                         | 32                               | 4                           | 428         | 100                      | 100         |
       +------------------------------------------------------------------------------------------------------------------------+--------------------------+---------------------------+----------------------------------+-----------------------------+-------------+--------------------------+-------------+
       | :ref:`Zigbee shell <zigbee_shell_sample>`                                                                              | 472                      | 0                         | 32                               | 4                           | 508         | 117                      | 117         |

_sources/quick-start.rst.txt

@@ -123,11 +123,10 @@ After you complete this quick start guide, we recommend that you get familiar wi
 
 * If you want to test a multiprotocol solution, see the :ref:`zigbee_light_switch_sample_nus` section of the light switch sample.
 
-..
-  * If you want to start developing for co-processor designs:
+* If you want to start developing for co-processor designs:
 
-    * :ref:`ug_zigbee_platform_design_ncp`
-    * `NCP Host documentation`_
+  * :ref:`ug_zigbee_platform_design_ncp`
+  * `NCP Host documentation`_
 
 * If you want to learn more about ZBOSS:
 

_sources/release-notes.rst.txt

@@ -21,11 +21,25 @@ For a full list of |addon|, related |NCS| and ZBOSS stack and NCP host package v
    +-------------------+------------------+-----------------------+---------------------+
    | |addon| version   | |NCS| version    | ZBOSS stack version   | NCP host version    |
    +===================+==================+=======================+=====================+
-   | 0.1.0             | 2.8.0            | 4.1.4.2               | N/A                 | 
+   | 0.2.0             | 2.8.0            | 4.1.4.2               | 3.0.0               | 
+   +-------------------+                  +                       +---------------------+
+   | 0.1.0             |                  |                       | N/A                 | 
    +-------------------+------------------+-----------------------+---------------------+
 
 .. _zigbee_release:
 
+|addon| v0.2.0 - 28/11/2024
+***************************
+
+This is an experimental release.
+
+* Added:
+
+  * The :ref:`NCP <zigbee_ncp_sample>` sample.
+  * The `ZBOSS NCP Host`_ package v\ |zigbee_ncp_package_version|.
+
+* Updated the documentation with small improvements.
+
 |addon| v0.1.0 - 15/11/2024
 ***************************
 

_sources/samples/index.rst.txt

@@ -76,30 +76,35 @@ The following table lists variants and extensions available for each Zigbee samp
       - Light bulb
       - Light switch
       - Network coordinator
+      - NCP
       - Shell
       - Template
     * - Sleepy End Device behavior
       - :ref:`*** <zigbee_ug_sed>`
       - ✔
       -
+      -
       - :ref:`** <zigbee_ug_sed>`
       - :ref:`** <zigbee_ug_sed>`
     * - Multiprotocol Bluetooth LE
       - `*** <Multiprotocol support_>`_
       - ✔
       - `*** <Multiprotocol support_>`_
+      -
       - `*** <Multiprotocol support_>`_
       - `*** <Multiprotocol support_>`_
     * - Endpoint logger
       - :ref:`** <ug_zigbee_configuring_components_logger_ep>`
       - :ref:`** <ug_zigbee_configuring_components_logger_ep>`
       - :ref:`** <ug_zigbee_configuring_components_logger_ep>`
+      -
       - ✔
       - :ref:`** <ug_zigbee_configuring_components_logger_ep>`
     * - ZCL scene helper
       - ✔
       - :ref:`*** <ug_zigbee_configuring_components_scene_helper>`
       - :ref:`*** <ug_zigbee_configuring_components_scene_helper>`
+      -
       - :ref:`*** <ug_zigbee_configuring_components_scene_helper>`
       - :ref:`*** <ug_zigbee_configuring_components_scene_helper>`
 

_sources/samples/ncp/README.rst.txt

@@ -0,0 +1,7 @@
+.. _zigbee_ncp_sample:
+
+Zigbee: NCP
+###########
+
+.. include:: ../../../samples/ncp/README.rst
+   :start-after: ###########

_sources/tools.rst.txt

@@ -22,20 +22,19 @@ It provides a near real-time display of 802.15.4 packets that are sent back and
 
 See `nRF Sniffer for 802.15.4`_ for documentation.
 
-..
-  .. _ug_zigbee_tools_ncp_host:
+.. _ug_zigbee_tools_ncp_host:
 
-  ZBOSS NCP Host
-  **************
+ZBOSS NCP Host
+**************
 
-  The NCP Host is a ZBOSS-based tool for running the host side of the :ref:`ug_zigbee_platform_design_ncp_details` design.
-  |zigbee_ncp_package|
+The NCP Host is a ZBOSS-based tool for running the host side of the :ref:`ug_zigbee_platform_design_ncp_details` design.
+|zigbee_ncp_package|
 
-  The tool is available for download as a standalone :file:`zip` package using the following link:
+The tool is available for download as a standalone :file:`zip` package using the following link:
 
-  * `ZBOSS NCP Host`_ (|zigbee_ncp_package_version|)
+* `ZBOSS NCP Host`_ (|zigbee_ncp_package_version|)
 
-  |zigbee_ncp_package_more_info|
+|zigbee_ncp_package_more_info|
 
 .. _ug_zigbee_tools_logger_endpoint:
 

_sources/zboss/changelog.rst.txt

@@ -12,6 +12,15 @@ ZBOSS stack changelog
 
 All notable changes to the ZBOSS stack are documented in ZBOSS documentation. 
 
+|addon| v0.2.0
+**************
+
+ZBOSS 4.1.4.2
+  `Documentation <ZBOSS 4.1.4.2 Documentation_>`_ | `Release notes <ZBOSS 4.1.4.2 changelog_>`_
+
+NCP Host 3.0.0
+  `Documentation <NCP Host 3.0.0 Documentation_>`_ | `Release notes <NCP Host 3.0.0 changelog_>`_
+
 |addon| v0.1.0
 **************
 

about.html

@@ -8,11 +8,11 @@
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/nordic.css" type="text/css" />
       <link rel="stylesheet" href="_static/togglebutton.css" type="text/css" />
-
+  
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
-
+  
         <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
         <script src="_static/jquery.js"></script>
         <script src="_static/underscore.js"></script>
@@ -36,14 +36,14 @@
 
 </head>
 
-<body class="wy-body-for-nav">
+<body class="wy-body-for-nav"> 
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-
-
+          
+          
           <a href="index.html" class="icon icon-home">
             Zigbee add-on for nRF Connect SDK
           </a>
@@ -102,7 +102,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-
+             
   <section id="about-zigbee-protocol">
 <span id="zigbee-about"></span><h1>About Zigbee protocol<a class="headerlink" href="#about-zigbee-protocol" title="Permalink to this heading"></a></h1>
 <div class="admonition note">
@@ -167,7 +167,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>
@@ -178,16 +178,16 @@ <h2>Additional information<a class="headerlink" href="#additional-information" t
            </div>
           </div>
           <footer>
-
+  
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
+      
         <a href="setup.html" class="btn btn-neutral float-right" title="Requirements and setup" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
-
-
+      
+      
         <a href="index.html" class="btn btn-neutral" title="Zigbee add-on for the nRF Connect SDK" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
-
+      
     </div>
-
+  
 
   <hr/>
 
@@ -207,7 +207,7 @@ <h2>Additional information<a class="headerlink" href="#additional-information" t
 </tr>
 </table>
   </div>
-  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
 
 </footer>
@@ -219,7 +219,7 @@ <h2>Additional information<a class="headerlink" href="#additional-information" t
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
+  </script> 
 
 </body>
-</html>
+</html>