Feedback

Exercise 3 – Extending clusters with custom functionality

In some cases, creating a new cluster to address missing functionality in the Matter specification is the best option. However, as a user, you may find yourself in a situation where there is a cluster that you could use, but it’s missing just a small portion of the necessary functionality. In such a case, it may not be worth creating a new cluster, but rather extending the existing one with the missing functionality.

The way you handle cluster extensions depends on whether the cluster you want to extend uses the Code-Driven approach or ZAP-generated code (legacy).

In this exercise, our goal will be to create an OnOff cluster extension using the approach based on ZAP-generated code. The cluster extension will be added to the OnOff Plug sample that was created in Exercise 1 and Exercise 2 of this lesson.

Note

Adding a cluster extension using the Code-Driven approach requires a more complex implementation that is not within the scope of this course. If you are interested in learning about it, see the dedicated documentation: Technical Documentation: Creating manufacturer-specific clusters in Matter application.

Exercise steps

0. Get the base code for this exercise.

In Visual Studio Code, in the WELCOME panel, select Open an existing application, navigate to the GitHub repository for the course, and open the l3/l3_e3 directory. The application should appear under the APPLICATIONS panel.

The base code for this exercise is the solution from the previous exercise, with added instructions for where to input the code snippets from this exercise.

1. Launch the Matter Cluster Editor
In nRF Connect for Desktop, open the Matter Cluster Editor application.

2. Create an extension to the OnOff cluster

2.1 Click on Load from file and select the <install_path>/modules/lib/matter/src/app/zap-templates/zcl/data-model/chip/onoff-cluster.xmlfile to load the base file of the OnOff cluster.

2.2 Navigate to the ATTRIBUTES tab and click on the Add Attribute button.

Fill in the fields with the following information to create a CustomOnOffAttribute attribute:

Name: CustomOnOffAttribute
Side: server
Code: 0xfff10000
Define: CUSTOM_ONOFF_ATTRIBUTE
Type: boolean
Writable: Enabled

The Code is 32-bit value, where the most significant 16 bits are the manufacturer code and least significant 16 bits are the attribute id. As in case of the cluster, in this exercise the code from test codes range was used – 0xFFF1. The command id should be a value within 0x0000-0x4FFF range, so as an example the value 0x0000 was used in this exercise.

The Side of the attribute should be set to server, as nRF device runs a server role and keeps the attribute state.

The Type was selected to boolean as an example, and it depends on what the attribute is going to be used for.

The Writable option was enabled, what will allow us to modify the attribute’s value using a client device.

Click the Save button. The attribute will appear in the ATTRIBUTES view.

2.3 Navigate to the COMMANDS tab and click on the Add Command button.

Fill the fields with the following information to create a CustomOnOffCommand command:

Name: CustomOnOffCommand
Code: 0xfff10000
Source: client
Description: Custom command for the OnOff cluster

Code is a 32-bit value, with the most significant 16 bits representing the manufacturer code and the least significant 16 bits representing the command ID. For the cluster in this exercise, use an ID reserved for testing: 0xFFF1. The command ID should be a value between 0x0000 and 0x00FF, so you can select a random 0x0000 value in this exercise.

The Source of the command should be set to client, as our Nordic DK runs the On/Off server role, and it is the external client device (the Matter controller in particular) that is going to send this command.

Click the Save button, and the command will appear in the COMMANDS view.

2.4 Click the Save extension to file button and select the following file location src/default_zap/onoff-cluster_extension.xml that is relative to our sample’s directory, in our case C:/ncs/matt-fund/l3/l3_e3.

3. Enable extended functionalities using the ZAP Tool

3.1 In Visual Studio Code, in the APPLICATIONS panel, right click on the application and select “Start New Terminal”, select the nRF Connect SDK version and corresponding toolchain version. This will open a terminal in your sample directory.

Run the ZAP Tool using the following command that includes the .xmlfile with the extension (and the RandomNumberGenerator.xml file used in Exercise 2):

west zap-gui -j src/default_zap/zcl.json --clusters ./src/default_zap/RandomNumberGenerator.xml ./src/default_zap/onoff-cluster_extension.xml

Copy

west zap-gui -j src/default_zap/zcl.json --clusters ./src/default_zap/RandomNumberGenerator.xml ./src/default_zap/onoff-cluster_extension.xml

Terminal command

3.2 Find the On/Off cluster on Endpoint 1 and navigate to the configuration view by clicking the gear icon.

3.3 In the On/Off cluster configuration, enable the CustomOnOffAttribute attribute as presented in the picture below:

3.4 Switch to the Commands tab, and enable the CustomOnOffCommand command as presented in the picture below:

3.5 Save the configuration by clicking File->Save on the top bar and exit the application.

3.6 Generate the code based on the .zap file by invoking the following command in the terminal:

west zap-generate --full

Copy

west zap-generate --full

Terminal command

The cluster extension has now been added to your application.

4. Handle the OnOff cluster extension in the application code

All the modified code is going to apply to the app_task.cpp file.

4.1 Define the implementation of a callback that will be automatically called by the data model, once the CustomOnOffCommand command from the OnOff cluster is received.

The function should print information about the receiving command in the device logs and adds the status to the default response to inform the client device about the result.

Add the following code snippet

bool emberAfOnOffClusterCustomOnOffCommandCallback(CommandHandler *commandObj, const ConcreteCommandPath &commandPath, const OnOff::Commands::CustomOnOffCommand::DecodableType &commandData)
{
	LOG_INF("CustomOnOffCommand received");

	commandObj->AddStatus(commandPath, Protocols::InteractionModel::Status::Success);

	return true;
}

Copy

bool emberAfOnOffClusterCustomOnOffCommandCallback(CommandHandler *commandObj, const ConcreteCommandPath &commandPath, const OnOff::Commands::CustomOnOffCommand::DecodableType &commandData)
{
	LOG_INF("CustomOnOffCommand received");

	commandObj->AddStatus(commandPath, Protocols::InteractionModel::Status::Success);

	return true;
}

C++

4.2 Modify the MatterPostAttributeChangeCallback method that was used in Exercise 1 and Exercise 2.

Change the if condition that verifies whether clusterId and attributeId are set to OnOff cluster and OnOff attribute. Split it into separate checks for clusterId and attributeId, and add an else if check for CustomOnOffAttribute. The implementation should look like this:

	if (clusterId == OnOff::Id){
		if (attributeId == OnOff::Attributes::OnOff::Id) {
			LOG_INF("Cluster OnOff: attribute OnOff set to %" PRIu8 "", *value);
	
			Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Set(*value);
		} else if (attributeId == OnOff::Attributes::CustomOnOffAttribute::Id) {
			LOG_INF("Cluster OnOff: attribute CustomOnOffAttribute set to %" PRIu8 "", *value);
		}
	}

Copy

	if (clusterId == OnOff::Id){
		if (attributeId == OnOff::Attributes::OnOff::Id) {
			LOG_INF("Cluster OnOff: attribute OnOff set to %" PRIu8 "", *value);
	
			Nrf::GetBoard().GetLED(Nrf::DeviceLeds::LED2).Set(*value);
		} else if (attributeId == OnOff::Attributes::CustomOnOffAttribute::Id) {
			LOG_INF("Cluster OnOff: attribute CustomOnOffAttribute set to %" PRIu8 "", *value);
		}
	}

C++

5. Build and flash the application to the DK.

Build and flash the application to the DK.

6. Commission the Matter device using CHIP Tool.

Commission the Matter device using CHIP Tool, similarly to previous exercises.

Matter over Thread
Matter over Wi-FI

5.1 Ensure the Thread Border Router is still running. If not:

5.1.1 Open a new command-line terminal and run the following command to run the OpenThread Border Router:

Replace the /dev/ttyACM0 with the serial port number that is used by your Thread Coprocessor.

sudo docker run -it --rm --privileged --name otbr --network otbr -p 8080:80 \
--sysctl "net.ipv6.conf.all.disable_ipv6=0 net.ipv4.conf.all.forwarding=1 net.ipv6.conf.all.forwarding=1" \
--volume /dev/ttyACM0:/dev/radio nrfconnect/otbr:fbde28a --radio-url spinel+hdlc+uart:///dev/radio?uart-baudrate=1000000

Copy

sudo docker run -it --rm --privileged --name otbr --network otbr -p 8080:80 \
--sysctl "net.ipv6.conf.all.disable_ipv6=0 net.ipv4.conf.all.forwarding=1 net.ipv6.conf.all.forwarding=1" \
--volume /dev/ttyACM0:/dev/radio nrfconnect/otbr:fbde28a --radio-url spinel+hdlc+uart:///dev/radio?uart-baudrate=1000000

Terminal command

Important

If you get an error like “The container name “/otbr” is already in use by container…, run the following commands

- sudo docker kill otbr

- sudo ip -6 route del "fd11:22::/64" dev otbr0 via "fd11:db8:1::2"

- sudo ip link set dev otbr0 down

- sudo docker network rm otbr

5.1.2 Open the http://localhost:8080/ address in a web browser to get access to the OpenThread Border Router graphical user interface.

5.1.3 Navigate to the Form tab from the side panel and make sure that all the inserted data is the same as in the following picture. Then press the FORM button to request from the OpenThread Border Router to form a Thread network and become a Thread leader.

5.1.4 Open a new command-line terminal and check the status of the Thread node running inside the Docker:

sudo docker exec -it otbr sh -c "sudo ot-ctl state"

Copy

sudo docker exec -it otbr sh -c "sudo ot-ctl state"

Terminal command

The output should be the following:

leader
Done

Terminal

5.2 Ensure CHIP Tool is still running. If not:

5.2.1 Open a new command-line terminal and run the downloaded binary file you obtained in the previous exercise using the following command:

With PC:

./chip-tool_x64 interactive start

With Raspberry Pi:

./chip-tool_arm64 interactive start

5.3 Commission the device to the network.

5.3.1 Make sure that Matter advertising over Bluetooth LE is running.

The following logs should be visible in the device serial port:

I: 730208 [DL]CHIPoBLE advertising started
I: 730212 [DL]NFC Tag emulation started

Terminal

Note that the Matter advertising over Bluetooth LE is automatically started for the Matter Template sample, but it timeouts after 1 hour. If the advertising timed out, press BUTTON0 on the Matter device to start it again.

5.3.2 Return to the terminal window running the CHIP Tool application.

Start the commissioning process by running the following command and fill the <thread dataset> argument with your Thread dataset that was obtained in Lesson 2 Exercise 1 and stored on your computer. Replace <your_selected_node_id> with a random node ID that has not been used in other exercises, e.g 4. This same number will be used when sending commands to the device via CHIP Tool.

pairing ble-thread <your_selected_node_id> hex:<thread dataset> 20202021 3840

Copy

pairing ble-thread <your_selected_node_id> hex:<thread dataset> 20202021 3840

Terminal command

As a result, the Matter device and the CHIP Tool application will start printing many verbose messages in the logs that present the commissioning flow. These are especially useful in case of issues with pairing and allow for troubleshooting the problem.

5.1 Ensure CHIP Tool is still running. If not:

5.1.1 Open a new command line terminal and run the downloaded binary file obtained in the previous exercise using the following command:

With PC:

./chip-tool_x64 interactive start

With Raspberry Pi:

./chip-tool_arm64 interactive start

5.2 Commission the device to the network.

5.2.1 Press BUTTON0 on the Matter device to start Matter advertising over Bluetooth LE.

The following logs should be visible in the device serial port:

I: 730208 [DL]CHIPoBLE advertising started
I: 730212 [DL]NFC Tag emulation started

Terminal

5.2.2 Return to the terminal window running the CHIP Tool application.

Run the following command and fill the <wifi_ssid> and <wifi_password> arguments with your Wi-Fi network data.

Replace <your_selected_node_id> with a random node ID that has not been used in other exercises, e.g 4. This same number will be used when sending commands to the device via CHIP Tool.

pairing ble-wifi <your_selected_node_id> <wifi_ssid> <wifi_password> 20202021 3840

Copy

pairing ble-wifi <your_selected_node_id> <wifi_ssid> <wifi_password> 20202021 3840

Terminal command

7. Test the OnOff extended functionality.

7.1 Get the value of the CustomOnOffAttribute attribute from the OnOff cluster. Similarly to Exercise 2, the CHIP Tool does not support controlling custom clusters and attributes by its name. However, it can be done using the code assigned during cluster creation. For example, for the OnOff cluster, the code is 0x6, and for the CustomOnOffAttribute attribute, the code is 0xFFF10000. To read the attribute’s value, use the following command in the CHIP Tool terminal:

Replace <your_selected_node_id> with the number selected during commissioning in this exercise.

any read-by-id 0x6 0xFFF10000 <your_selected_node_id> 1

Copy

any read-by-id 0x6 0xFFF10000 <your_selected_node_id> 1

Terminal command

You will see a similar output in the CHIP Tool terminal:

[1770792256.334] [17610:17612] [DMG] 				Data = false, 
[1770792256.334] [17610:17612] [DMG] 			},
[1770792256.334] [17610:17612] [DMG] 			
[1770792256.334] [17610:17612] [DMG] 		},
[1770792256.334] [17610:17612] [DMG] 		
[1770792256.334] [17610:17612] [DMG] 	],
[1770792256.334] [17610:17612] [DMG] 	
[1770792256.334] [17610:17612] [DMG] 	SuppressResponse = true, 
[1770792256.334] [17610:17612] [DMG] 	InteractionModelRevision = 12
[1770792256.334] [17610:17612] [DMG] }
[1770792256.334] [17610:17612] [TOO] Endpoint: 1 Cluster: 0x0000_0006 Attribute 0xFFF1_0000 DataVersion: 3475485165
[1770792256.334] [17610:17612] [TOO]   Don't know how to log attribute value

Terminal

The Data = false attribute presents the attribute’s value, which is set to false by default.

7.2 Set the value of CustomOnOffAttribute to true using the following command:

any write-by-id 0x6 0xFFF10000 'true' <your_selected_node_id> 1

Copy

any write-by-id 0x6 0xFFF10000 'true' <your_selected_node_id> 1

Terminal command

You will see a similar output in logs from the Matter device:

D: 196031 [IM]Received Write request
I: Cluster OnOff: attribute CustomOnOffAttribute set to 1

Terminal

D: 196031 [IM]Received Write request I: Cluster OnOff: attribute CustomOnOffAttribute set to 1

7.3 Get the value of the CustomOnOffAttribute attribute again to make sure it was changed, by using the following command:

any read-by-id 0x6 0xFFF10000 <your_selected_node_id> 1

Copy

any read-by-id 0x6 0xFFF10000 <your_selected_node_id> 1

Terminal command

You will see a similar output in CHIP Tool terminal:

[1770792461.916] [17610:17612] [DMG] 				Data = true, 
[1770792461.916] [17610:17612] [DMG] 			},
[1770792461.916] [17610:17612] [DMG] 			
[1770792461.916] [17610:17612] [DMG] 		},
[1770792461.916] [17610:17612] [DMG] 		
[1770792461.916] [17610:17612] [DMG] 	],
[1770792461.916] [17610:17612] [DMG] 	
[1770792461.916] [17610:17612] [DMG] 	SuppressResponse = true, 
[1770792461.916] [17610:17612] [DMG] 	InteractionModelRevision = 12
[1770792461.916] [17610:17612] [DMG] }
[1770792461.916] [17610:17612] [TOO] Endpoint: 1 Cluster: 0x0000_0006 Attribute 0xFFF1_0000 DataVersion: 3475485166
[1770792461.916] [17610:17612] [TOO]   Don't know how to log attribute value

Terminal

The Data = true presents the attribute’s value, which was modified and is consistent with the value visible in the Matter device’s logs.

7.4 Request sending CustomOnOffCommand using the following command:

any command-by-id 0x6 0xFFF10000 '{}' <your_selected_node_id> 1

Copy

any command-by-id 0x6 0xFFF10000 '{}' <your_selected_node_id> 1

Terminal command

You will see a similar output in logs from the Matter device that proves reception of the custom command:

I: CustomOnOffCommand received

Terminal

Nordic Developer Academy Terms of Service

1. Introduction

‍These terms and conditions (“Terms of Use”) apply to the use of the Nordic Developer Academy, provided by Nordic Semiconductor ASA, org. nr. 966 011 726, a public limited liability company registered in Norway (“Nordic Semiconductor”). ‍

Nordic Developer Academy allows the user to take technical courses related to Nordic Semiconductor products, software and services, and obtain a certificate certifying completion of these courses. By completing the registration process for the Nordic Developer Academy, you are agreeing to be bound by these Terms of Use.

These Terms of Use are applicable as long as you have a user account giving you access to Nordic Developer Academy.‍

‍2. Access to and use of Nordic Developer Academy

‍‍Upon acceptance of these Terms of Use you are granted a non-exclusive right of access to, and use of Nordic Developer Academy, as it is provided to you at any time. Nordic Semiconductor provides Nordic Developer Academy to you free of charge, subject to the provisions of these Terms of Use and the Nordic Developer Academy Privacy Policy.

To access select features of Nordic Developer Academy, you need to create a user account. You are solely responsible for the security associated with your user account, including always keeping your login details safe.

You will able to receive an electronic certificate from Nordic Developer Academy upon completion of courses. By issuing you such a certificate, Nordic Semiconductor certifies that you have completed the applicable course, but does not provide any further warrants or endorsements for any particular skills or professional qualifications.

Nordic Semiconductor will continuously develop Nordic Developer Academy with new features and functionality, but reserves the right to remove or alter any existing functions without notice.

‍3. Acceptable use

You undertake that you will use Nordic Developer Academy in accordance with applicable law and regulations, and in accordance with these Terms of Use.‍ You must not modify, adapt, or hack Nordic Developer Academy or modify another website so as to falsely imply that it is associated with Nordic Developer Academy, Nordic Semiconductor, or any other Nordic Semiconductor product, software or service.

You agree not to reproduce, duplicate, copy, sell, resell or in any other way exploit any portion of Nordic Developer Academy, use of Nordic Developer Academy, or access to Nordic Developer Academy without the express written permission by Nordic Semiconductor. You must not upload, post, host, or transmit unsolicited email, SMS, or \”spam\” messages.

You are responsible for ensuring that the information you post and the content you share does not;

contain false, misleading or otherwise erroneous information
infringe someone else’s copyrights or other intellectual property rights
contain sensitive personal data or
contain information that might be received as offensive or insulting.
Such information may be removed without prior notice.

‍Nordic Semiconductor reserves the right to at any time determine whether a use of Nordic Developer Academy is in violation of its requirements for acceptable use.

Violation of the at any time applicable requirements for acceptable use may result in termination of your account. We will take reasonable steps to notify you and state the reason for termination in such cases.

‍4. Routines for planned maintenance

‍Certain types of maintenance may imply a stop or reduction in availability of Nordic Developer Academy. Nordic Semiconductor does not warrant any level of service availability but will provide its best effort to limit the impact of any planned maintenance on the availability of Nordic Developer Academy.

5. Intellectual property rights

‍Nordic Semiconductor retains all rights to all elements of Nordic Developer Academy. This includes, but is not limited to, the concept, design, trademarks, know-how, trade secrets, copyrights and all other intellectual property rights.

Nordic Semiconductor receives all rights to all content uploaded or created in Nordic Developer Academy. You do not receive any license or usage rights to Nordic Developer Academy beyond what is explicitly stated in this Agreement.

‍6. Liability and damages

‍Nothing within these Terms of Use is intended to limit your statutory data privacy rights as a data subject, as described in the Nordic Developer Academy Privacy Policy. ‍You acknowledge that errors might occur from time to time and waive any right to claim for compensation as a result of errors in Nordic Developer Academy. When an error occurs, you shall notify Nordic Semiconductor of the error and provide a description of the error situation.

You agree to indemnify Nordic Semiconductor for any loss, including indirect loss, arising out of or in connection with your use of Nordic Developer Academy or violations of these Terms of Use. ‍Nordic Semiconductor shall not be held liable for, and does not warrant that (i) Nordic Developer Academy will meet your specific requirements, (ii) Nordic Developer Academy will be uninterrupted, timely, secure, or error-free, (iii) the results that may be obtained from the use of Nordic Developer Academy will be accurate or reliable, (iv) the quality of any products, services, information, or other material purchased or obtained by you through Nordic Developer Academy will meet your expectations, or that (v) any errors in Nordic Developer Academy will be corrected.

You accept that this is a service provided to you without any payment and hence you accept that Nordic Semiconductor will not be held responsible, or liable, for any breaches of these Terms of Use or any loss connected to your use of Nordic Developer Academy. Unless otherwise follows from mandatory law, Nordic Semiconductor will not accept any such responsibility or liability.

‍7. Change of terms

‍Nordic Semiconductor may update and change the Terms of Use from time to time. Nordic Semiconductor will seek to notify you about significant changes before such changes come into force and give you a possibility to evaluate the effects of proposed changes. Continued use of Nordic Developer Academy after any such changes shall constitute your acceptance of such changes. You can review the current version of the Terms of Use at any time at https://academy.nordicsemi.com/terms-of-service/

‍8. Transfer of rights

‍Nordic Semiconductor is entitled to transfer its rights and obligation pursuant to these Terms of Use to a third party as part of a merger or acquisition process, or as a result of other organizational changes.

‍9. Third Party Services

‍‍To the extent Nordic Developer Academy facilitates access to services provided by a third party, you agree to comply with the terms governing such third party services. Nordic Semiconductor shall not be held liable for any errors, omissions, inaccuracies, etc. related to such third party services.

‍10. Dispute resolution

‍‍The Terms of Use and any other legally binding agreement between yourself and Nordic Semiconductor shall be subject to Norwegian law and Norwegian courts’ exclusive jurisdiction.

Matter Fundamentals

Exercise 3 – Extending clusters with custom functionality

Note

Exercise steps

Important

Switch language?

Change summary

What's new in the latest version

Matter

MCUboot & Partition Manager