Skip to content

Commit 1758d0b

Browse files
peknisrlubos
authored andcommitted
doc: Matter weather station app restructure
Restructured the doc to align it with the application template. ref: NCSDK-19501 Signed-off-by: Pekka Niskanen <[email protected]>
1 parent 0098708 commit 1758d0b

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

applications/matter_weather_station/README.rst

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,54 @@ You can use this application as a reference for creating your own application.
1616
The `Matter weather station application from the v2.1.1`_ |NCS| release participated in Matter Specification Validation Event (SVE) and successfully passed all required test cases to be considered as a device compliant with Matter 1.0.
1717
You can use the |NCS| v2.1.1 release to see the application configuration and the files that were originally used in Matter 1.0 certification.
1818

19+
Application overview
20+
********************
21+
22+
The application uses a single button for controlling the device state.
23+
The weather station device is periodically performing temperature, air pressure, and relative humidity measurements.
24+
The measurement results are stored in the device memory and can be read using the Matter controller.
25+
The controller communicates with the weather station device over the Matter protocol and exchanges data using the Matter Data Model.
26+
The data model describes data measurements within the proper clusters that correspond to the measurement type.
27+
28+
The application supports over-the-air (OTA) :term:`Device Firmware Update (DFU)` using one of the two following protocols:
29+
30+
* Matter OTA software update protocol that uses the Matter operational network for querying and downloading a new firmware image.
31+
* Simple Management Protocol (SMP) over Bluetooth® LE.
32+
In this case, the DFU can be done either using a smartphone application or a PC command line tool.
33+
Note that this protocol is not part of the Matter specification.
34+
35+
In both cases, the MCUboot secure bootloader is used to apply the new firmware image.
36+
For information about how to upgrade the device firmware using a PC or a mobile, see the :ref:`matter_weather_station_app_dfu` section.
37+
38+
.. _matter_weather_station_network_mode:
39+
40+
Remote testing in a network
41+
===========================
42+
43+
By default, the Matter accessory device has no IPv6 network configured.
44+
You must pair it with the Matter controller over Bluetooth LE to get the configuration from the controller to use the device within a Thread or Wi-Fi® network.
45+
46+
The Bluetooth LE advertising starts automatically upon the device startup, but only for a predefined period of time (1 hour by default).
47+
If the Bluetooth LE advertising times out, you can re-enable it manually using **Button (SW3)**.
48+
49+
Additionally, the controller must get the `Onboarding information`_ from the Matter accessory device and provision the device into the network.
50+
For details, see the `Testing`_ section.
51+
1952
Requirements
2053
************
2154

2255
The application supports the following development kits:
2356

2457
.. table-from-sample-yaml::
2558

26-
To commission the weather station device and control it remotely through a Thread or Wi-Fi® network, you also need a Matter controller device :ref:`configured on PC or smartphone <ug_matter_configuring>`.
59+
To commission the weather station device and control it remotely through a Thread or Wi-Fi network, you also need a Matter controller device :ref:`configured on PC or smartphone <ug_matter_configuring>`.
2760
This requires additional hardware depending on your setup.
2861
The recommended way of getting measurement values is using the mobile Matter controller application that comes with a graphical interface, performs measurements automatically and visualizes the data.
2962

3063
To program a Thingy:53 device where the preprogrammed MCUboot bootloader has been erased, you need the external J-Link programmer.
3164
If you have an nRF5340 DK that has an onboard J-Link programmer, you can also use it for this purpose.
3265

33-
If the Thingy:53 is programmed with Thingy:53-compatible sample or application, you can also update the firmware using MCUboot's serial recovery or DFU over Bluetooth® Low Energy (LE).
66+
If the Thingy:53 is programmed with Thingy:53-compatible sample or application, you can also update the firmware using MCUboot's serial recovery or DFU over Bluetooth Low Energy (LE).
3467

3568
.. note::
3669
If you build Matter Weather Station firmware with factory data support it will not be compatible with other Thingy:53 samples and applications.
@@ -50,39 +83,6 @@ The development kits for this sample offer the following IPv6 network support fo
5083
* Matter over Wi-Fi is supported for ``thingy53/nrf5340/cpuapp`` with the ``nrf7002`` expansion board attached, for the :ref:`release configuration <matter_weather_station_custom_configs>` only.
5184
See `Building for the nRF7002 Wi-Fi expansion board`_ for more information.
5285

53-
Overview
54-
********
55-
56-
The application uses a single button for controlling the device state.
57-
The weather station device is periodically performing temperature, air pressure, and relative humidity measurements.
58-
The measurement results are stored in the device memory and can be read using the Matter controller.
59-
The controller communicates with the weather station device over the Matter protocol using Zigbee Cluster Library (ZCL).
60-
The library describes data measurements within the proper clusters that correspond to the measurement type.
61-
62-
The application supports over-the-air (OTA) device firmware upgrade (DFU) using one of the two following protocols:
63-
64-
* Matter OTA update protocol that uses the Matter operational network for querying and downloading a new firmware image.
65-
* Simple Management Protocol (SMP) over Bluetooth LE.
66-
In this case, the DFU can be done either using a smartphone application or a PC command line tool.
67-
Note that this protocol is not part of the Matter specification.
68-
69-
In both cases, MCUboot secure bootloader is used to apply the new firmware image.
70-
For information about how to upgrade the device firmware using a PC or a mobile, see the :ref:`matter_weather_station_app_dfu` section.
71-
72-
.. _matter_weather_station_network_mode:
73-
74-
Remote testing in a network
75-
===========================
76-
77-
By default, the Matter accessory device has no IPv6 network configured.
78-
You must pair it with the Matter controller over Bluetooth LE to get the configuration from the controller to use the device within a Thread or Wi-Fi network.
79-
80-
The Bluetooth LE advertising starts automatically upon the device startup, but only for a predefined period of time (15 minutes by default).
81-
If the Bluetooth LE advertising times out, you can re-enable it manually using **Button (SW3)**.
82-
83-
Additionally, the controller must get the `Onboarding information`_ from the Matter accessory device and provision the device into the network.
84-
For details, see the `Testing`_ section.
85-
8686
User interface
8787
**************
8888

0 commit comments

Comments
 (0)