Skip to content

Commit 0b6998b

Browse files
kkasperczyk-norlubos
authored andcommitted
samples: matter: Removed implementation of lock sample
Matter lock implementation was moved to Door Lock reference add-on. Implementation was removed from NCS and documentation aligned to link to the Door Lock add-on. Signed-off-by: Kamil Kasperczyk <kamil.kasperczyk@nordicsemi.no>
1 parent e3a5639 commit 0b6998b

105 files changed

Lines changed: 31 additions & 28899 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

doc/nrf/links.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,8 +209,6 @@
209209
.. _`Matter nRF Connect Kconfig`: https://github.com/nrfconnect/sdk-connectedhomeip/blob/5e2e5a02d6/config/nrfconnect/chip-module/Kconfig
210210
.. _`Matter Clusters Code-Driven support`: https://github.com/nrfconnect/sdk-connectedhomeip/blob/5e2e5a02d6/src/app/common/templates/config-data.yaml
211211

212-
.. _`bt_nus_service.cpp`: https://github.com/nrfconnect/sdk-nrf/blob/main/samples/matter/common/src/bt_nus/bt_nus_service.cpp
213-
.. _`bt_nus_service.h`: https://github.com/nrfconnect/sdk-nrf/blob/main/samples/matter/common/src/bt_nus/bt_nus_service.h
214212
.. _`DCL Quick Start Guide`: https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/master/docs/quickStartGuide.adoc
215213
.. _`nRF Cloud JSON protocol schemas`: https://github.com/nRFCloud/application-protocols
216214
.. _`device_credentials_installer.py`: https://github.com/nRFCloud/utils/blob/main/src/nrfcloud_utils/device_credentials_installer.py

doc/nrf/protocols/matter/getting_started/adding_bt_services.rst

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -72,18 +72,3 @@ To add support for a Bluetooth LE service implemented in the |NCS|, complete the
7272
CHIP_ERROR InsertRequest(Request & request);
7373
7474
This adds the service to the Arbiter queue.
75-
76-
.. _ug_matter_device_adding_bt_services_example:
77-
78-
Example: Bluetooth LE with Nordic UART Service implementation
79-
=============================================================
80-
81-
The :ref:`Matter door lock sample <matter_lock_sample>` provides an optional configuration of :ref:`matter_lock_sample_ble_nus`, which you can use as an example implementation of a Bluetooth LE service.
82-
Once enabled, you can use this configuration to declare NUS commands specific to the door lock sample and use them to control the device remotely through Bluetooth LE.
83-
84-
The following steps correspond to the implementation steps above, with the NUS as example:
85-
86-
1. *Check the documentation:* The NUS characteristics are listed on the :ref:`nus_service_readme` documentation page.
87-
#. *Add the application code that instantiates and fills the struct:* Using the information from the documentation page, `bt_nus_service.cpp`_ and `bt_nus_service.h`_ are created.
88-
The ``Init`` method in the CPP file contains the implementation of the Bluetooth LE Arbiter's ``Request`` structure.
89-
#. *Add the application code that calls the ``InsertRequest`` function:* In the CPP file, the service is started with the call to ``StartServer``, which contains a reference to ``InsertRequest``.

doc/nrf/protocols/matter/getting_started/hw_requirements.rst

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,6 @@ Values are provided in kilobytes (KB).
8181
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
8282
| :ref:`Light Switch <matter_light_switch_sample>` (Release) | 28 | 596 | 4 | 32 | 660 | 158 |
8383
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
84-
| :ref:`Lock <matter_lock_sample>` (Debug) | 28 | 767 | 4 | 32 | 831 | 161 |
85-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
86-
| :ref:`Lock <matter_lock_sample>` (Release) | 28 | 597 | 4 | 32 | 661 | 158 |
87-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
8884
| :ref:`Smoke CO Alarm <matter_smoke_co_alarm_sample>` (Debug) | 28 | 744 | 4 | 32 | 808 | 162 |
8985
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
9086
| :ref:`Smoke CO Alarm <matter_smoke_co_alarm_sample>` (Release) | 28 | 589 | 4 | 32 | 653 | 160 |
@@ -138,10 +134,6 @@ Values are provided in kilobytes (KB).
138134
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
139135
| :ref:`Light Switch <matter_light_switch_sample>` (Release) | 32 | 529 | 4 | 32 | 597 | 169 |
140136
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
141-
| :ref:`Lock <matter_lock_sample>` (Debug) | 32 | 700 | 4 | 32 | 768 | 173 |
142-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
143-
| :ref:`Lock <matter_lock_sample>` (Release) | 32 | 529 | 4 | 32 | 597 | 169 |
144-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
145137
| :ref:`Smoke CO Alarm <matter_smoke_co_alarm_sample>` (Debug) | 32 | 678 | 4 | 32 | 746 | 174 |
146138
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
147139
| :ref:`Smoke CO Alarm <matter_smoke_co_alarm_sample>` (Release) | 32 | 522 | 4 | 32 | 590 | 171 |
@@ -203,10 +195,6 @@ Values are provided in kilobytes (KB).
203195
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
204196
| :ref:`Light Switch <matter_light_switch_sample>` (Release) | 52 | 588 | 4 | 40 | 684 | 163 |
205197
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
206-
| :ref:`Lock <matter_lock_sample>` (Debug) | 52 | 762 | 4 | 40 | 858 | 167 |
207-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
208-
| :ref:`Lock <matter_lock_sample>` (Release) | 52 | 588 | 4 | 40 | 684 | 163 |
209-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
210198
| :ref:`Smoke CO Alarm <matter_smoke_co_alarm_sample>` (Debug) | 52 | 740 | 4 | 40 | 836 | 169 |
211199
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
212200
| :ref:`Smoke CO Alarm <matter_smoke_co_alarm_sample>` (Release) | 52 | 581 | 4 | 40 | 677 | 165 |
@@ -246,8 +234,6 @@ Values are provided in kilobytes (KB).
246234
+----------------------------------------------------------------------------+---------------+------------+-------------------+----------------+------------+----------------+-------------+---------------------------------+
247235
| :ref:`Light Switch <matter_light_switch_sample>` (Debug) | 52 | 126 | 705 | 4 | 40 | 32 | 959 | 213 |
248236
+----------------------------------------------------------------------------+---------------+------------+-------------------+----------------+------------+----------------+-------------+---------------------------------+
249-
| :ref:`Lock <matter_lock_sample>` (Debug) | 52 | 126 | 716 | 4 | 40 | 32 | 970 | 212 |
250-
+----------------------------------------------------------------------------+---------------+------------+-------------------+----------------+------------+----------------+-------------+---------------------------------+
251237
| :ref:`Template <matter_template_sample>` (Debug) | 52 | 126 | 656 | 4 | 40 | 32 | 910 | 210 |
252238
+----------------------------------------------------------------------------+---------------+------------+-------------------+----------------+------------+----------------+-------------+---------------------------------+
253239
| :ref:`Template <matter_template_sample>` (Release) | 52 | 126 | 515 | 4 | 40 | 32 | 769 | 206 |
@@ -314,10 +300,6 @@ Values are provided in kilobytes (KB).
314300
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
315301
| :ref:`Light Switch <matter_light_switch_sample>` (Release) | 52 | 589 | 4 | 48 | 693 | 163 |
316302
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
317-
| :ref:`Lock <matter_lock_sample>` (Debug) | 52 | 764 | 4 | 48 | 868 | 167 |
318-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
319-
| :ref:`Lock <matter_lock_sample>` (Release) | 52 | 589 | 4 | 48 | 693 | 163 |
320-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
321303
| :ref:`Smoke CO Alarm <matter_smoke_co_alarm_sample>` (Debug) | 52 | 742 | 4 | 48 | 846 | 169 |
322304
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
323305
| :ref:`Smoke CO Alarm <matter_smoke_co_alarm_sample>` (Release) | 52 | 582 | 4 | 48 | 686 | 165 |
@@ -366,10 +348,6 @@ Values are provided in kilobytes (KB).
366348
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
367349
| :ref:`Light Switch <matter_light_switch_sample>` (Release) | 52 | 819 | 4 | 48 | 923 | 317 |
368350
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
369-
| :ref:`Lock <matter_lock_sample>` (Debug) | 52 | 1008 | 4 | 48 | 1112 | 323 |
370-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
371-
| :ref:`Lock <matter_lock_sample>` (Release) | 52 | 820 | 4 | 48 | 924 | 318 |
372-
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
373351
| :ref:`Template <matter_template_sample>` (Debug) | 52 | 949 | 4 | 48 | 1053 | 320 |
374352
+----------------------------------------------------------------------------+---------------+-------------------+----------------+------------+-------------+---------------------------------+
375353
| :ref:`Template <matter_template_sample>` (Release) | 52 | 788 | 4 | 48 | 892 | 314 |

doc/nrf/protocols/matter/getting_started/matter_api.rst

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -228,18 +228,13 @@ An example implementation of the :c:func:`MatterPostAttributeChangeCallback` tha
228228
void MatterPostAttributeChangeCallback(const chip::app::ConcreteAttributePath &attributePath, uint8_t type,
229229
uint16_t size, uint8_t *value)
230230
{
231-
if (attributePath.mClusterId == DoorLock::Id &&
232-
attributePath.mAttributeId == DoorLock::Attributes::LockState::Id) {
233-
/* Post events only if current lock state is different than given */
234-
switch (*value) {
235-
case to_underlying(DlLockState::kLocked):
236-
/* Lock the physical door lock. */
237-
break;
238-
case to_underlying(DlLockState::kUnlocked):
239-
/* Unlock the physical door lock. */
240-
break;
241-
default:
242-
break;
231+
if (attributePath.mClusterId == OnOff::Id &&
232+
attributePath.mAttributeId == OnOff::Attributes::OnOff::Id) {
233+
/* Post events only if current light state is different than given */
234+
if (*value) {
235+
/* Turn on the physical light. */
236+
} else {
237+
/* Turn off the physical light. */
243238
}
244239
}
245240
}

doc/nrf/protocols/matter/overview/integration.rst

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -100,16 +100,8 @@ For this design, the Wi-Fi driver on the application core communicates with the
100100
Switchable Matter over Wi-Fi and Matter over Thread
101101
===================================================
102102

103-
.. |Third Button| replace:: **Button 2** on the nRF54LM20 DK
104-
105103
In this design, the Matter stack, the OpenThread stack, the Wi-Fi stack, and the Bluetooth LE stack run on a single SoC.
106-
107-
.. include:: ../../../../../samples/matter/lock/README.rst
108-
:start-after: matter_door_lock_sample_thread_wifi_switch_desc_start
109-
:end-before: matter_door_lock_sample_thread_wifi_switch_desc_end
110-
111-
For an example of how this design works, see the :ref:`matter_lock_sample_wifi_thread_switching` feature in the Matter door lock sample.
112-
104+
For an example of how this design works, see the `nRF Door Lock and Access Control Add-on`_.
113105
This platform design is suitable for the following development kits:
114106

115107
.. table-from-rows:: /includes/sample_board_rows.txt

doc/nrf/releases_and_maturity/releases/release-notes-2.3.0.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ Matter
190190

191191
* Support for switching between Matter over Thread and Matter over Wi-Fi.
192192
This feature is available for the :ref:`matter_lock_sample` sample programmed on ``nrf5340dk_nrf5340_cpuapp`` with the ``nrf7002_ek`` shield attached, using the ``thread_wifi_switched`` build type.
193-
See :ref:`matter_lock_sample_wifi_thread_switching` in the sample documentation for more information.
193+
See the Thread and Wi-Fi switching section in the sample documentation for more information.
194194
* Support for Wi-Fi Network Diagnostic Cluster (which counts the number of packets received and transmitted on the Wi-Fi interface).
195195
* Default support for nRF7002 revision B.
196196
* Specific QR code and onboarding information in the documentation for each :ref:`Matter sample <matter_samples>` and the :ref:`Matter weather station <matter_weather_station_app>`.
@@ -592,7 +592,7 @@ Matter samples
592592
* Added:
593593

594594
* ``thread_wifi_switched`` build type that enables switching between Thread and Wi-Fi network support in the field.
595-
See :ref:`matter_lock_sample_wifi_thread_switching` in the sample documentation for more information.
595+
See the Thread and Wi-Fi switching section in the sample documentation for more information.
596596
* Wi-Fi low power configuration using Wi-Fi's :ref:`Legacy Power Save mode <ug_nrf70_developing_powersave_dtim_unicast>`.
597597

598598
* The sample is now positively verified against "Works with Google" certification tests.

doc/nrf/releases_and_maturity/releases/release-notes-2.6.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -865,7 +865,7 @@ Matter samples
865865
* :ref:`matter_lock_sample` sample:
866866

867867
* Added support for Wi-Fi firmware patch upgrade on external memory, only for the combination of the nRF5340 DK with the nRF7002 EK.
868-
* Updated the design of the :ref:`matter_lock_sample_wifi_thread_switching` feature so that support for both Matter over Thread and Matter over Wi-Fi is included in a single firmware image.
868+
* Updated the design of the Thread and Wi-Fi switching section feature so that support for both Matter over Thread and Matter over Wi-Fi is included in a single firmware image.
869869
* Fixed an issue that prevented nRF Toolbox for iOS in version 5.0.9 from controlling the sample using :ref:`nus_service_readme`.
870870

871871
Networking samples

doc/nrf/releases_and_maturity/releases/release-notes-2.7.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -828,7 +828,7 @@ Matter samples
828828
* Support for emulation of the nRF7001 Wi-Fi companion IC on the nRF7002 DK.
829829
* Door lock access manager module.
830830
The module is used to implement support for refined handling and persistent storage of PIN codes.
831-
* The :ref:`matter_lock_scheduled_timed_access` feature.
831+
* The Scheduled timed access feature.
832832

833833
* :ref:`matter_template_sample` sample:
834834

doc/nrf/releases_and_maturity/releases/release-notes-3.3.0-preview1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ Matter samples
404404

405405
* :ref:`matter_lock_sample`:
406406

407-
* Added support for the :ref:`matter_lock_sample_wifi_thread_switching` in the nRF54LM20 DK with the nRF7002-EB II shield attached.
407+
* Added support for the Thread and Wi-Fi switching section in the nRF54LM20 DK with the nRF7002-EB II shield attached.
408408

409409
* :ref:`matter_light_bulb_sample`:
410410

doc/nrf/releases_and_maturity/releases/release-notes-3.3.0-preview2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -485,7 +485,7 @@ Matter samples
485485

486486
* Added:
487487

488-
* Support for the :ref:`matter_lock_sample_wifi_thread_switching` in the nRF54LM20 DK with the nRF7002-EB II shield attached.
488+
* Support for the Thread and Wi-Fi switching section in the nRF54LM20 DK with the nRF7002-EB II shield attached.
489489
* Lock data storage implementation based on the ARM PSA Protected Storage API, enabled with the :kconfig:option:`CONFIG_LOCK_ACCESS_STORAGE_PROTECTED_STORAGE` Kconfig option.
490490

491491
* :ref:`matter_light_bulb_sample`:

0 commit comments

Comments
 (0)