[Create Test] Creating IDM_3_2 python3 test module (#41066)

* [Create Test] Creating IDM_3_2 python3 test module
- Creating test module for Task #[322](https://github.com/project-chip/matter-test-scripts/issues/322)
- Created updated test plan to remove test step 1 here: [5539](https://github.com/CHIP-Specifications/chip-test-plans/pull/5539)

* Update src/python_testing/TC_IDM_3_2.py

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Update src/python_testing/TC_IDM_3_2.py

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Restyled by autopep8

* Removing unneeded imports

* Resolving linting errors

* Restyled by autopep8

* Resolving linting errors part 2

* Updating docstrings to be more logical and understandable

* Updating docstrings further for clarity

* Adding plumbing for TIMED_REQUEST_MISMATCH validation, changed to node label if check for test steps 5 and 6, and added commissioning test step 0:
- Added plumbing for TIMED_REQUEST_MISMATCH validation in test step 7: Following similar logic as noticed in TestOnlySendCommandTimedRequestFlagWithNoTimedInvoke function
- Added commissioning test step 0
- Added if check for exist of node label attribute to see if we should run test step 5 and 6, else we currently skip these test steps (Until follow-up is implemented)

* Restyled by whitespace

* Restyled by clang-format

* Restyled by autopep8

* Update TC_IDM_3_2.py

Adding todo follow-up task: https://github.com/project-chip/matter-test-scripts/issues/693 for test steps 5 and 6 logic

* Resolving linting errors and added some additional comments to test step 7

* Resolving code dups in ChipDeviceCtrl.py, Attribute.py, and attribute.cpp

* Restyled by whitespace

* Restyled by clang-format

* Restyled by autopep8

* Refactored timed request logic and improve attribute discovery
- Updated WriteClient.cpp/h to use mForceTimedRequestFlag instead of mTimedWriteTimeoutMs.HasValue() for timed request control
- Created new find_timed_write_attribute function which uses ClusterAttributeDescriptor.must_use_timed_write to find timed write attributes dynamically for use in test step 7

* Restyled by autopep8

* Implement SuppressResponse functionality and fix WriteHandler bug per Cecille's request

- Add suppressResponse parameter to Python WriteAttribute APIs in ChipDeviceCtrl.py
- Update Python bindings in Attribute.py to pass suppressResponse flag to C++
- Modify WriteClient to properly set SuppressResponse in WriteRequest messages
- Fix critical bug in WriteHandler.cpp: HandleWriteRequestMessage() was not
  checking SuppressResponse flag before sending WriteResponse messages
- Update TC_IDM_3_2.py step 4 to test SuppressResponse with proper exception handling:
  * Use assert_raises(ChipStackError) pattern instead of broad exception catching
  * Expect CHIP Error 0x00000032 (Timeout) when suppressResponse=True works correctly
  * Verify write operation succeeds despite timeout by reading attribute back
- Consolidate NodeLabel attribute guard for steps 4-6 to reduce duplication
- Add ChipStackError import from matter.exceptions

* Restyled by whitespace

* Restyled by clang-format

* Restyled by autopep8

* Restyled by isort

* Update WriteHandler.cpp

Removing check for SuppressResponse flag in HandleWriteRequestMessage()

* Update TC_IDM_3_2.py

Adding skip test step 4 until SuppressResponse implementation can be implemented on the SDK server side.
Once implemented the code in test step 4 should work and the commented out block of code can then be uncommented.

* Update TC_IDM_3_2.py

Moved the self.skip_test(4) to above the commented out code block for test step 4 for easier reading and understanding of why it is currently being skipped.

* Update TC_IDM_3_2.py

Removed unnecessary comment for why test step 4 is being skipped

* Applying autopep8

* Recovering lost variable

* Restyled by autopep8

* resolving lint error

* Restyled by autopep8

* Update src/controller/python/matter/ChipDeviceCtrl.py

Co-authored-by: C Freeman <cecille@google.com>

* Address PR feedback from Cecille: improve type safety and simplify attribute detection

- Change suppressResponse from Optional[bool] to bool in WriteAttribute methods
- Add type hints to find_timed_write_attribute method
- Access must_use_timed_write as class property directly
- Use wildcard read data instead of attribute_guard for better performance

* Restyled by autopep8

* Resolving linting error and removing some unneeded comments

* Apply suggestions from code review by Cecille

Applying suggested code changes from Cecille

Co-authored-by: C Freeman <cecille@google.com>

* Improve TC_IDM_3_2 and add type hint to Attribute.py's _prepare_write_attributes_data function:

TC_IDM_3_2.py changes:
- Exclude test cluster (kTest) from timed write attribute search
- Log warning instead of failing when no unsupported attributes found
- Enable step 4 suppressResponse test (accepts response or no response)
- Add note referencing Issue #41227 for future spec enforcement
- Remove unneeded return if not unsupported_cluster_ids

Attribute.py changes:
- Add return type hint to _prepare_write_attributes_data()

* Restyled by autopep8

* Improve timed write documentation and add missing edge case test scenario:
- Adds detailed docs explaining Timed Request ACTION vs TimedRequest FLAG relationship
- Documents why timed writes and chunking are incompatible in StartNewMessage()
- Adds test-only constructor for "action present, flag false" scenario (3rd edge case)
- Adds Python bindings and controller method for new test scenario
- Adds test case in TC_IDM_3_2.py step 7 for TIMED_REQUEST_MISMATCH validation
- Fixes find_timed_write_attribute() to properly handle kStandard and kTest cluster types
- Registers new binding function in Attribute.py Init()

* Restyled by whitespace

* Restyled by clang-format

* Restyled by autopep8

* Apply suggestions for timed request field value name change from Boris

Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>

* Rename mForceTimedRequestFlag to mTimedRequestFieldValue and improve clarity:

- Rename mForceTimedRequestFlag to mTimedRequestFieldValue for clarity
- Update all documentation to use 'field' instead of 'flag' consistently
- Rename TestOnlyOverrideTimedRequestFlagTag to TestOnlyOverrideTimedRequestFieldTag
- Simplify member variable documentation to avoid redundant details
- Update parameter names in test constructors for consistency

* Removed SuppressResponse enablement from current python framework changes and fixed minor timed request issue caused during renaming

* Correcting test step 4 comment to provide issue link and more context

* Restyled by whitespace

* Restyled by clang-format

* Restyled by autopep8

* Remove leftover SuppressResponse reference and revert unintended file mode changes back to 644

* Consolidate redundant test-only Timed Request code per Boris's feedback:
- Remove redundant WriteClient constructor taking only bool parameter
- Merge pychip_WriteClient_TestOnlyWriteAttributesTimedRequestNoTimedAction
  and pychip_WriteClient_TestOnlyWriteAttributesTimedActionNoTimedRequestFlag
  into single pychip_WriteClient_TestOnlyWriteAttributesWithMismatchedTimedRequestField
- Update Python bindings and tests to use unified API

The single test function now takes both timedRequestTimeoutMs and timedRequestFieldValue parameters,
allowing callers to specify exactly what combination they need for each test scenario.

* Restyled by clang-format

* Restyled by autopep8

* Refactor attribute write helpers per code review from Cecille:

- Add parameter names to AttributeWriteRequest calls in ChipDeviceCtrl.py for clarity
- Update type hints to show union of 2-tuple and 3-tuple formats
- Refactor ProcessWriteAttributesData in attribute.cpp to accept forceLegacyListEncoding parameter, eliminating code duplication between legacy and normal encoding paths

* Resolving minor noticed change aftter merging master

* Restyled by clang-format

* Restyled by autopep8

* Resolving linting errors

* Restyled by autopep8

* Resolving mypy issues

* Restyled by autopep8

* Resolving further mypy issues in ChipDeviceCtrl python3 module

* attribute.cpp merge fix

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: C Freeman <cecille@google.com>
Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>
8 files changed
tree: f6820474334d86ea4af01b711f75b45cf191fb1e
  1. .devcontainer/
  2. .gemini/
  3. .githooks/
  4. .github/
  5. .vscode/
  6. build/
  7. build_overrides/
  8. config/
  9. credentials/
  10. data_model/
  11. docs/
  12. examples/
  13. integrations/
  14. scripts/
  15. src/
  16. third_party/
  17. zzz_generated/
  18. .actrc
  19. .clang-format
  20. .clang-tidy
  21. .default-version.min
  22. .dir-locals.el
  23. .editorconfig
  24. .gitattributes
  25. .gitignore
  26. .gitmodules
  27. .gn
  28. .matterlint
  29. .mergify.yml
  30. .pre-commit-config.yaml
  31. .prettierrc.json
  32. .pullapprove.yml
  33. .restyled.yaml
  34. .shellcheck_tree
  35. .spellcheck.yml
  36. BUILD.gn
  37. CODE_OF_CONDUCT.md
  38. CODEOWNERS
  39. CONTRIBUTING.md
  40. gn_build.sh
  41. iwyu.imp
  42. kotlin-detect-config.yaml
  43. lgtm.yml
  44. LICENSE
  45. NOTICE
  46. pigweed.json
  47. pyproject.toml
  48. README.md
  49. REVIEWERS.md
  50. SECURITY.md
  51. SPECIFICATION_VERSION
README.md

Documentation links

Matter

Builds

Builds

Android Ameba ASR BouffaloLab Darwin TI CC26X2X7 TI CC32XX EFR32 ESP32 Infineon i.MX Linux K32W with SE051 Linux ARM Linux Standalone nRF Connect SDK QPG STM32 Telink Tizen

Tests

Tests Unit / Integration Tests Cirque QEMU

Tools

ZAP Templates

Documentation

Documentation Build

About

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.

What is Matter?

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.

Project Overview

Development Goals

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.

Architecture Overview

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: Matter Architecture Overview

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:

Matter Stack Architecture

  1. Application: High-order business logic of a device. For example, an application that is focused on lighting might contain logic to handle turning on/off the bulb as well as its color characteristics.
  1. Data Model: The data layer corresponds to the data and verb elements that help support the functionality of the application. The Application operates on these data structures when there is an intent to interact with the device.
  1. Interaction Model: The Interaction Model layer defines a set of interactions that can be performed between a client and server device. For example, reading or writing attributes on a server device would correspond to application behavior on the device. These interactions operate on the elements defined at the data model layer.
  1. Action Framing: Once an action is constructed using the Interaction Model, it is serialized into a prescribed packed binary format to encode for network transmission.
  1. 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.

  2. 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.

  1. IP Framing & Transport Management: After the final payload has been constructed, it is sent to the underlying transport protocol for IP management of the data.

Current Status of Matter

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.

How to Contribute

We welcome your contributions to Matter. Read our contribution guidelines here.

Building and Developing in Matter

Instructions about how to build Matter can be found here .

Directory Structure

The Matter repository is structured as follows:

File/FolderContent
buildBuild system support content and built output directories
build_overridesBuild system parameter customization for different platforms
configProject configurations
credentialsDevelopment and test credentials
docsDocumentation, including guides. Visit the Matter SDK documentation page to read it.
examplesExample firmware applications that demonstrate use of Matter
integrations3rd party integrations
scriptsScripts needed to work with the Matter repository
srcImplementation of Matter
third_party3rd party code used by Matter
zzz_generatedZAP generated template code - Revolving around cluster information
BUILD.gnBuild file for the GN build system
CODE_OF_CONDUCT.mdCode of conduct for Matter and contribution to it
CONTRIBUTING.mdGuidelines for contributing to Matter
LICENSEMatter license file
REVIEWERS.mdPR reviewers
gn_build.shBuild script for specific projects such as Android, EFR32, etc.
README.mdThis file

License

Matter is released under the Apache 2.0 license.