| commit | 6fda73ab5a7ef1ec792e9873f116dc44a46ffbc1 | [log] [tgz] |
|---|---|---|
| author | Andy Salisbury <harimau@google.com> | Mon Nov 25 12:12:08 2024 -0500 |
| committer | GitHub <noreply@github.com> | Mon Nov 25 17:12:08 2024 +0000 |
| tree | 6df29bb40c664dc2e9f1218da4ecc782e8b3a717 | |
| parent | 2e34aa5a45912ccd40dbe7f75c3895b6c4d55ec1 [diff] |
BDX transfer support for Python tests (#34821) * Add the python-C++ translation. * Add a BDX transfer server to handle unsolicited BDX init messages. * Add the manager to implement the transfer pool. * Add the initial implementation of a BDX transfer. * Use BdxTransfer in the other classes. * Update constructors to set the delegates etc. correctly. * Implement the C++ side of the barrier. Move the data callback into the transfer delegate. * Add a way to map the transfer to the python contexts. * Fix some of the minor TODOs. * Add init/shutdown to the transfer server. * Start on the implementation of the Python side. Also add the transfer obtained context to the C++ methods relating to expecting transfers. * Listen for all BDX protocol messages rather than just the init messages. * Fix minor issues in the transfer server. * Implement a good chunk of the python side. * Fix compile errors. * Fix a number of issues preventing the BDX python code from running at all. * Return the results of the python-C methods. * Fix the async-ness of the methods that prepare the system to receive a BDX transfer. Also run the python BDX initialisation. * Initialise the BDX transfer server. Also ignore the BDX transfer server implementation that only handles diagnostic logs. * Fixes necessary to await on the future from PrepareToReceive/SendBdxData. * Call Responder::PrepareForTransfer from BdxTransfer. * Correctly schedule satisfying the future on the event loop. * Use the real property to determine if a PyChipError was a success. * Fix sending the accept message. * Acknowledge received blocks so the BDX transfer continues. Also don't ignore all messages after the init. * Fix the parameters of the python callback methods. * Add another async transaction class to handle the transfer completed callback. * Add comments to the C++ code. * Add a test for the BDX transfer that uses the diagnostic logs cluster. * Move the calls to release a transfer out of the manager so it works the way one would expect. * Delay releasing the C++ BDX transfer object until after it's no longer in use. * Verify the diagnostic logs response is a success. * Restyled by whitespace * Restyled by clang-format * Restyled by gn * Restyled by autopep8 * Restyled by isort * Improve BdxTransferManager's comments. * Use a vector for the data to send over a BDX transfer rather than a raw pointer. * Minor renames. * Improve the error message when the BDX transfer pool is exhausted. * Minor fixes. * remove a check that was inadvertently kept. * print a log message when something that shouldn't happen inevitably does. * use user_params to get the end user support log test parameter. * Pass the status report's status code up the stack. * Merge the BDX transfer server into the manager. * Rename BdxTransferManager to TestBdxTransferServer. * Minor cleanup. * Rename TransferData to TransferInfo. * Change `!=` to `is not` in python. * Add missing type annotation. * Improve the documentation of the ownership in the C++ side. * Restyled by clang-format * Restyled by autopep8 * Update the new test to work with the new formatting. Also remove an unnecessary conversion to bytearray. * Lint fixes. * Fix clang-tidy errors. * Several fixes suggested by Andrei. * Fix a name in a comment. * Fix issues preventing test from working. Also: * Split the accept function into one for sending data and one for receiving data. * Return bytes instead of a bytearray when receiving data. * Add typing to the data callback. * Rename the methods that accept transfers so it's clear which way the data is flowing. * Add doc comments to the Python classes and methods. * Fix issues found by mypy. * Restyled by clang-format * Restyled by autopep8 * Fix python lint error. * Explicitly truncate the status code when generating the error. * Generate the diagnostic log to transfer in the test. --------- Co-authored-by: Restyled.io <commits@restyled.io>
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.