| commit | 9abe68c491dde996a91e91c5a66820bdf0034f42 | [log] [tgz] |
|---|---|---|
| author | Jake Ororke <jororke@csa-iot.org> | Wed Dec 03 16:16:51 2025 -0800 |
| committer | GitHub <noreply@github.com> | Thu Dec 04 00:16:51 2025 +0000 |
| tree | 05ed0907beab45f5107f6da2f3d686926f6d0bfe | |
| parent | f6fe07c56e800db76b9b9e6f1c38dc07dfd2fe86 [diff] |
[Debug] Add automatic device attribute dump on composition test failures (#41020) * Add automatic device attribute dump on composition test failures: - Move log_structured_data to module level in basic_composition support module for reusability - Add on_fail override in BasicCompositionTests to automatically dump device data - Ensures all composition tests automatically log device attributes on failure - Improves debugging by providing IDM-12.1 equivalent data without manual intervention - Add missing logging import to TC_DeviceConformance.py * Restyled by autopep8 * Remove duplicate on_fail() and unused import from TC_DeviceConformance - Remove on_fail() override as it's now inherited from BasicCompositionTests - Remove unused log_structured_data import * Removing unused logging import * Change inheritance order to enable automatic device attribute dump on composition test failures - Change TC_DeviceConformance from (MatterBaseTest, DeviceConformanceTests) to (DeviceConformanceTests, MatterBaseTest) - Change TC_DeviceBasicComposition from (MatterBaseTest, BasicCompositionTests) to (BasicCompositionTests, MatterBaseTest) - This ensures BasicCompositionTests.teardown_class() takes precedence in Method Resolution Order - Enables automatic device attribute dumps when composition tests detect problems - Improves debugging efficiency by providing IDM-12.1 equivalent data without manual intervention The inheritance order change allows the teardown_class override in BasicCompositionTests to execute before MatterBaseTest.teardown_class, ensuring device data is dumped before the standard problem logging occurs. * Restyled by autopep8 * resolving linting errors and making sure that on test failures we emit the failure msg correctly * Restyled by autopep8 * Update basic_composition.py Restoring fail_current_test() as per Cecille's suggestion, thank you! * Update basic_composition.py Updated to using module-level logger instance instead of using logging directly * Restyled by autopep8 * Move device attribute dumping from BasicCompositionTests to MatterBaseTest for universal test debugging * Restyled by autopep8 * Fix Python 3.11 compatibility and improve test failure User Experience: - Fix f-strings in TC_DeviceBasicComposition.py for Python < 3.12 - Move device dump before problem logging for better failure visibility - Remove noisy log messages from device dump on failure - Use specific exceptions instead of catching all exceptions so that it isnt blanketed. * removed duplicate log_structured_data function from basic_composition module, now inheriting it directly from matter_testing in test_TC_IDM_12_1 test * removed duplicate log_structured_data function from basic_composition module, now inheriting it directly from matter_testing in test_TC_IDM_12_1 test in TC_DeviceBasicCompositon test module * Restyled by autopep8 * Resolving linting error * Apply suggestions from code review from Cecille Co-authored-by: C Freeman <cecille@google.com> * Adding --debug flag to do attribute dump during conformance and composition tests only when added in script-args, also added super().teardown_class() to device conformance and composition test modules * Restyled by autopep8 * Resolve mypy issue * Adding CI test runs with debug flag * Removed teardown_class override as inheritance from MatterBaseTest appears to be working fine now --------- Co-authored-by: Restyled.io <commits@restyled.io> Co-authored-by: C Freeman <cecille@google.com>
Builds
Tests
Tools
Documentation
Matter (formerly Project CHIP) creates more connections between more objects, simplifying development for manufacturers and increasing compatibility for consumers, guided by the Connectivity Standards Alliance.
Matter is a unified, open-source application-layer connectivity standard built to enable developers and device manufacturers to connect and build reliable, and secure ecosystems and increase compatibility among connected home devices. It is built with market-proven technologies using Internet Protocol (IP) and is compatible with Thread and Wi-Fi network transports. Matter was developed by a Working Group within the Connectivity Standards Alliance (Alliance). This Working Group develops and promotes the adoption of the Matter standard, a royalty-free connectivity standard to increase compatibility among smart home products, with security as a fundamental design tenet. The vision that led major industry players to come together to build Matter is that smart connectivity should be simple, reliable, and interoperable.
Matter simplifies development for manufacturers and increases compatibility for consumers.
The standard was built around a shared belief that smart home devices should be secure, reliable, and seamless to use. By building upon Internet Protocol (IP), Matter enables communication across smart home devices, mobile apps, and cloud services and defines a specific set of IP-based networking technologies for device certification.
The Matter specification details everything necessary to implement a Matter application and transport layer stack. It is intended to be used by implementers as a complete specification.
The Alliance officially opened the Matter Working Group on January 17, 2020, and the specification is available for adoption now.
Visit buildwithmatter.com to learn more and read the latest news and updates about the project.
Matter is developed with the following goals and principles in mind:
Unifying: Matter is built with and on top of market-tested, existing technologies.
Interoperable: The specification permits communication between any Matter-certified device, subject to users’ permission.
Secure: The specification leverages modern security practices and protocols.
User Control: The end user controls authorization for interaction with devices.
Federated: No single entity serves as a throttle or a single point of failure for root of trust.
Robust: The set of protocols specifies a complete lifecycle of a device — starting with the seamless out-of-box experience, through operational protocols, to device and system management specifications required for proper function in the presence of change.
Low Overhead: The protocols are practically implementable on low compute-resource devices, such as MCUs.
Pervasive: The protocols are broadly deployable and accessible, by leveraging IP and being implementable on low-capability devices.
Ecosystem-Flexible: The protocol is flexible enough to accommodate deployment in ecosystems with differing policies.
Easy to Use: The protocol provides smooth, cohesive, integrated provisioning and out-of-box experience.
Open: The Project’s design and technical processes are open and transparent to the general public, including non-members wherever possible.
Matter aims to build a universal IPv6-based communication protocol for smart home devices. The protocol defines the application layer that will be deployed on devices and the different link layers to help maintain interoperability. The following diagram illustrates the normal operational mode of the stack: 
The architecture is divided into layers to help separate the different responsibilities and introduce a good level of encapsulation among the various pieces of the protocol stack. The vast majority of interactions flow through the stack captured in the following Figure:
Security: An encoded action frame is then sent down to the Security Layer to encrypt and sign the payload to ensure that data is secured and authenticated by both sender and receiver of a packet.
Message Framing & Routing: With an interaction encrypted and signed, the Message Layer constructs the payload format with required and optional header fields; which specify the message's properties and some routing information.
Matter’s design and technical processes are intended to be open and transparent to the general public, including to Working Group non-members wherever possible. The availability of this GitHub repository and its source code under an Apache v2 license is an important and demonstrable step to achieving this commitment. Matter endeavors to bring together the best aspects of market-tested technologies and redeploy them as a unified and cohesive whole-system solution. The overall goal of this approach is to bring the benefits of Matter to consumers and manufacturers as quickly as possible. As a result, what you observe in this repository is an implementation-first approach to the technical specification, vetting integrations in practice. The Matter repository is growing and evolving to implement the overall architecture. The repository currently contains the security foundations, message framing and dispatch, and an implementation of the interaction model and data model. The code examples show simple interactions, and are supported on multiple transports -- Wi-Fi and Thread -- starting with resource-constrained (i.e., memory, processing) silicon platforms to help ensure Matter’s scalability.
We welcome your contributions to Matter. Read our contribution guidelines here.
Instructions about how to build Matter can be found here .
The Matter repository is structured as follows:
| File/Folder | Content |
|---|---|
| build | Build system support content and built output directories |
| build_overrides | Build system parameter customization for different platforms |
| config | Project configurations |
| credentials | Development and test credentials |
| docs | Documentation, including guides. Visit the Matter SDK documentation page to read it. |
| examples | Example firmware applications that demonstrate use of Matter |
| integrations | 3rd party integrations |
| scripts | Scripts needed to work with the Matter repository |
| src | Implementation of Matter |
| third_party | 3rd party code used by Matter |
| zzz_generated | ZAP generated template code - Revolving around cluster information |
| BUILD.gn | Build file for the GN build system |
| CODE_OF_CONDUCT.md | Code of conduct for Matter and contribution to it |
| CONTRIBUTING.md | Guidelines for contributing to Matter |
| LICENSE | Matter license file |
| REVIEWERS.md | PR reviewers |
| gn_build.sh | Build script for specific projects such as Android, EFR32, etc. |
| README.md | This file |
Matter is released under the Apache 2.0 license.
