Mode base sdk implementation (#27504) * Added first draft of the ModeBase SDK implementation. * Fixed build files and mode base source files from mode select references. * Fixed final errors. * Removed global accessor functions in place instance attributes. * Renamed internal members to mX. Replaced the use the zap Feature map with and internally managed variable. * Added Command Types and DecodableTypes to the SDK implementation to bypass the limitations of the the current zap generation. * Added ModeBase attributes to the list of attributeAccessInterfaceAttributes to ensure that not RAM memory is allocated for these attibutes. * Merged the mode base delegate into the mode base instance due to attribute accessability following management of attributes by the mode base instance. * Added documentation and readme for the ModeBase alias. * Added the dishwasher mode cluster to the all-clusters-app example. * Added the laundry washer mode cluster to the all-clusters-app example. * Added the refrigerator and temperature controlled cabinet mode cluster to the all-clusters-app example. * Renamed the mode base alias all-clusters-app examples to the correct naming. * Implemented interaction between the ModeBase and OnOff servers. Added ModeBase attribute type infos. Updated documentation. * Restyled by whitespace * Restyled by clang-format * Restyled by gn * Restyled by prettier-markdown * Fixed copy paste issues in the mode base cluster objects. * Moved the ModeBaseAliasesInstanceMap into the ModeBase namespace and added a getter for it. * Moved OnOff server common behavior in a top-level anonymous namespace method. * Apply suggestions from code review Accepted readme suggestions. Co-authored-by: Tennessee Carmel-Veilleux <tennessee.carmelveilleux@gmail.com> * Renamed the readme * Added doc to ModeBase instance init. Removed the use of using in made-base-server.h * Added validity checking when updating attributes. * Made ModeBase functions that are required to be implemented by the user pure virtural. * Renamed constants according to the convention. * Made persistant attributes persistant. Experimented with helper accessor functions for persistent attributes. * Fixed code after merge * Regenerats all-clusters-app.matter after merge * Restyled by clang-format * Restyled by prettier-markdown * Simplified IsSupportedMode to make it more readable. * Removed the use of using from header files. * Removed the use of using from mode-base-server.h. * Enabled UpdateModeBaseCurrentModeToOnMode only when the ModeBase plugin is enabled. * Restyled by clang-format * In the OnOff server, include mode-base only when the ModeBase plugin is enabled. * Fixed AliasedCluster's type * Changed to calling of Update sttribute functions when loading persistent attributes on init. * Moved the ChangeToModeResponse command from the accepted commands to the generated commands list. * Renamed isAliasedCluster to isDerivedCluster. * Refactored the supported modes encoding to make the Read switch statement more readable. * Fixed typos in the ModeBase readme. Co-authored-by: Boris Zbarsky <bzbarsky@apple.com> * Simplified the encoding function and some comments. * Fixed var naming and GetModeLabelByIndex return. * Fixed incorrect version number in some ModeBase derived clusters. * Made mode base derived cluster code more readble with using * Removed unneccissary namespace paths. * Removed unneccissary size checking. * Refactored GetModeTagsByIndex to make it more readable. * Added new StatusCode. * Used chip::CharSpan::fromCharString to avoid setting the length. * Added missing function nampspace. * Made the mode-base-cluster-objects.h more readable by removing unneccessery namespace specifications. * Made the mode-base-cluster-objects.h more readable by simplifying the DecodableArgType definition. * Removed redundant processing in the Read function. * Added cluster constants to make the code more readabel. * Changed attribute write errors. * Added attribute getters and setters documentaton. * Added FeatureMap to the list of attributeAccessInterfaceAttributes. * Used std::set instead of std::map to hold the ModeBase Instances. * Removed the BuildModeOptionStruct helper function to avoid giving incorroct expectations to the SDK consumers. * Changed the Delegate's API to remove the need for the GetNumberOfModes method. * Changed checks for essetion setup in the ModeBase init to VerifyOrDie. * Moved the setting of the CurrentMode based on the StartUpMode, OnMode and OnOff cluster values to the ModeBase init function. Added some TODOs from the reviews. * Added documentation about the required lifetime of the ModeBase Instance object. * Refoctored ModeBase to separate out the Delegate functionality into a separate class. * Added generated code after merge * Restyled by clang-format * Restyled by gn * Restyled by prettier-markdown * Added ModeBase to the spellcheck. Allowed the use of set in mode-base-server.h * Removed the ModeBase constraint that the cluster ID given should be of an actual ModeBase derived cluster. * Changed the ModeBase derived cluster's instatiation in the all-clusters-app to make it easier to include for all platforms. * Defined EMBER_AF_PLUGIN_MODE_BASE for the linux all-clustres-app to enable OfOff cluster related code. * Restyled by whitespace * Restyled by clang-format * Restyled by prettier-markdown * Fixed the lock app gni argument chip_project_config_include_dirs as it was pointing to the all-clusters-app's include dir. * Fixed ModeBase derived clusters version numbers in zap. * Apply suggestions from code review Co-authored-by: Boris Zbarsky <bzbarsky@apple.com> * Updated the Mode Base readme afther review. * Removed ModeBase from the .github/.wordlist.txt Co-authored-by: Boris Zbarsky <bzbarsky@apple.com> * Unregister the AttributeAccessOverride when deconstructing a Mode Base instance. * Added // nogncheck to the Mode Base includes in the OnOff server code. * Updated Mode Base function documentatio. * Added read case for the Feature Map. * Restyled by clang-format * Restyled by prettier-markdown * used the feature map's enum instead of a literal number in the Mode Bease examples. * Restyled by clang-format * Fixed return bug in the Mode Base RVC examples. * Update .github/workflows/build.yaml Co-authored-by: Boris Zbarsky <bzbarsky@apple.com> * Fixed attribute get issue in the Mode Base RVC example. Co-authored-by: Petru Lauric <81822411+plauric@users.noreply.github.com> * Checkedout out-of-sync third-party repos to match what is on master. * Restyled by clang-format --------- Co-authored-by: Restyled.io <commits@restyled.io> Co-authored-by: Tennessee Carmel-Veilleux <tennessee.carmelveilleux@gmail.com> Co-authored-by: Boris Zbarsky <bzbarsky@apple.com> Co-authored-by: Petru Lauric <81822411+plauric@users.noreply.github.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.