NXP Matter Documentation
v1.0
Matter MCU
Getting Started
Installation Guide for Matter with MCUX SDK
Install Software Tools
Alternative : MCUXpresso for VS Code
Install MCUX SDK with Matter support
Initializing a new workspace with MCUX SDK supporting Matter
Existing MCUX SDK workspace
Setup Matter Environment
Getting Started with Matter examples on NXP MCU platforms (MCUX SDK/FreeRTOS)
Prerequisites
Build Matter example
List the project information
Build the project
Flashing Matter example
Platform-specific requirements
NBU image (for MCXW71 and MCXW72 platforms)
Additional binaries for OTA and Factory Data
MCUboot bootloader (when OTA is enabled - RT1060, RT1170, and RW61x platforms)
Factory Data (when factory data is enabled)
Important note for MCUXpresso for VSCode Extension users
Testing Matter example
Supported Platforms
FreeRTOS-based platforms with MCUX SDK
Platform Support Matrix
How to Use This Information
Zephyr-based platforms
Platform Support Matrix
How to Use This Information
Development
Overview
Application Architecture
Overview
Application build system architecture
Matter stack and NXP platform port libraries
Application
Overview on application CMakeLists.txt
Application Customization
Overview
Prerequisites
Create freestanding example from an existing Matter example
How to create a freestanding example
How to build a freestanding example
Customization options
Customize
nxp_sdk_reconfig.cmake
Customize the application
prj.conf
Customize SDK middleware configuration
Customize Matter Device Configuration with ZAP
Using ZAP Tool Script
Using ZAP Tool Directly
Generating Code After ZAP Changes
Integrate Matter as a service in an existing non-Matter application
Overview
Prerequisites
Build System Integration
Step 1 : Add Matter in the application CMakeLists.txt
Option A - Monolithic Architecture
Option B - Modular Architecture
Step 2 : Add Matter in the application Kconfig
Step 3 : Configure Matter in the application prj.conf
Locate or Create prj.conf
Configure Matter Settings
Step 4 : Update the example’s
reconfig.cmake
file
Code Integration
Step 5: Copy Matter application files under your project
Step 6: Configure Device Data Model
Step 7: Initialize Matter Stack
Important notes about initialization:
Step 8: Update your application linker file
Locate the correct linker template:
Integration options:
Next Steps
Release Notes & Known Issues
Release Notes
Known Issues
Potential build issues
CMake build failure with multiple MCUX SDK versions
Windows path length limitations causing build failures
Kconfig string values not preserved when passed via “CMake Extra Args” (MCUXpresso for VSCode Extension)
Matter freestanding examples do not support –bf option
MPU / Linux® Hosted Matter
Release Notes
Release Notes
What’s new
User Guide
Quick Start
Introduction
i.MX MPU Matter platform
How to build the Yocto image with integrated OpenThread Border Router
How to build OpenThread Border Router and OpenThread Daemon with Yocto SDK
How to setup OpenThread Border Router and OpenThread Daemon on the target
How to build Matter application
Security configuration for Matter
FAQ
Running Matter demos on i.MX MPU platforms
Hardware requirements
Software requirements
Running Matter demos with OTBR and OpenThread on the i.MX MPU platform
Setup OTBR on i.MX MPU platform
For i.MX93 FRDM / i.MX93 EVK / i.MX95 15x15 EVK + IW612 and i.MX91 EVK / i.MX91 QSB / i.MX91 FRDM + IW610 platform:
For i.MX8M Mini EVK + 88W8987 + K32W platform or i.MX8ULP EVK + IW416 + K32W platform:
For i.MX6ULL EVK + 88W8987 + K32W platform:
Configure OpenThread Network
Factory reset lighting application on K32W DK6
Commission the lighting-app on the i.MX controller
Control the lighting-app on the i.MX controller
Setup ot-daemon on i.MX MPU platform
Running other Matter demos on i.MX MPU platform
Run example applications with ble-wifi commissioning method
Set up BT and connect to a wifi AP on controller device
Load the Wi-Fi/BT firmware and set up BT on the end device
Run the example application on the end device
Finally, commission and control the end devices on the controller device.
Run example applications with onnetwork commissioning method
Running Matter OTA of Wi-Fi/BT firmware and application on the i.MX MPU platform
FAQ
Why chip-tool failed to control cluster after reboot?
Working with the chip-tool-web2
Source files
Building and running the chip-tool-web2
Building the chip-tool-web2
Running the chip-tool-web2
Introduction
Default Setup
Custom Setup
Verification
Accessing the chip-tool-web2
Example of opening on Windows
Using chip-tool-web2 to commission a Matter device
Using Interactive mode
Commissioning a Matter device
Add Thread Device
Add WI-FI Device
Add OnNetwork Device
Add Device by QRCode
List commissioned devices in chip-tool-web2
Interact with lighting device
Open Commissioning Window
Forget Device
Unpair Device
Subscription of Matter device OnOff cluster in chip-tool-web2
Controlling a Matter device mediaplayback cluster
Launch or Stop app
Media Control
Media Status
Report Format
Binding for light and switch Matter device
Write ACL
Write Binding
Opening the commissioning window for the commissioned Matter device
Controlling a Matter device Energy EVSE Cluster
Event Trigger
Charging Enable
EEVSE Write
EEVSE Charging Disable
EEVSE Status
Report Format
OTA updates on chip-tool-web2
Step 1 Upload OTA file
Step 2 Run chip-ota-provider-app
Step 3 Commissioning with chip-ota-provider-app
Step 4 Run chip-ota-requestor-app in the end devices
Step 5 Commissioning with chip-ota-requestor-app
Step 6 Write ACL
Step 7 Send OTA command
Network graph on chip-tool-web2
Additional Notes
Running Matter Commissioning in Home Assistant application on i.MX MPU platforms
Overview
Deploying the Docker containers on the i.MX MPU platform
Running the Home Assistant application on the Phone
Commissioning the i.MX Matter device on Home Assistant application
Known issue
FAQ
What to do if the download fails or the download speed of the Docker image is very slow?
What to do if the commissioning fails?
What to do if the commissioning fails with matter-server logs “CHIP_ERROR [chip.native.DIS] Timeout waiting for mDNS resolution.”?
What should be done when an attempt to add the OpenThread Border Router’s REST API fails with a ‘Failed to connect’ error?
IWxxx Thread & Zigbee Dualpan solution in NXP i.MX Matter
Introduction
IWxxx Dualpan Architecture
IWxxx Zigbee Stack and Examples
Zigbee SDK
Zigbee Examples
Zigbee Application Details
Import an existing Zigbee application into meta-nxp-connectivity
Create a new Zigbee application
Matter to Zigbee Bridge Example
Running Matter MATTER-NCP demos on i.MX MPU platforms
Hardware requirements
Verification about ble-wifi commissioning
Matter chip-tool control chip-all-clusters-app-ncp apps after matter commission successfully
Version
Version Information
Version Mapping Table
NXP Matter Documentation
Index
Index
NXP Matter Documentation
v: v1.0
Document Release Versions
v1.0
latest