Add basic Energy gateway app example and add new XML for Energy management in 1.5 (#37902)

* Basic energy-gateway-app framework for Linux and ESP32 - linking issue due to device type problems bringing in expected clusters.

* Initial attempt to add new clusters based of PR 10815 - ZAP is raising error 'Unable to find cluster extension by component'

* Added missing xml files to zcl.json. Added regen of global-structs.xml and global-enums.xml (NOTE: ApparentPowerThresholds SHOULD be power_mva! but Zap does not recognise this yet.

* Temporary change of "money" to int64s whilst waiting for a ZAP change.

* Added Meter Identification cluster XML

* Updated tests.yaml and rules.matterlint to include new clusters

* .matter file updates caused by new enums

* Updated files after zap_regen_all

* New files after zap_regen_all

* Add support for money and new electrical data types

* Added new attributes for structs to attributeAccessInterfaceAttributes. Removed legacy measurement-and-sensing.xml in favour of new global-structs/global-enums.xml

* Updated .matter files after subsequent regen_all

* code autogen after moving to global structs/enums and updating structs in attributes- regen_all

* Backed out change to support SetVidVerificationStatement etc

* Enabled Commodity Price in data_model/contoller-clusters.zap. Added stub basic-type Currency. Disabled Ember in config-data.yaml. Linux now builds but aborts at start-up.

* Update chip-types.xml with new energy types and money

* Changed to use correct global struct CurrencyStruct

* Revert changes to generated attribute-type.h file

* regen_all after merging in Hasty's new types PR: #37980

* Further zap_regen_all updates after picking up fix from Hasty#s #37980

* Revert reversion of generated attribute-type.h

* Fix build issue due to moving MeasurementAccuracyStruct to global-structs.

* Restyled by whitespace

* Restyled by clang-format

* Restyled by gn

* Update attribute-type.h

* Fix EEM/EPM clusters which use new global MeasurementAccuracyRangeStruct and MeasurementTypeEnum

* Restyled by clang-format

* Generated XML files from Alchemy for new clusters and refreshed older EM clusters with latest Alchemy.

* Added missing zap_cluster_list.json

* Added missing CurrencyStruct

* zap_regen_all

* Fix-up EEM/EPM and apps that use them because the Structs and Enums have moved to Globals:: namespace

* Fix CI issue - Re-did bootstrap to pick up new ZAP, and regen_all. Updated ChipStructs.java which was different in CI

* Reverted back to using existing measurement-and-sensing-.xml to avoid API backwards compatibility change.

* Regen_all to revert all .matter files back to remove global MeasurementType enum

* Another regen_all

* Manually added missing description to the clusters to hopefully fix the IDL parsing errors.

* Regen_all to include description tag from XML.

* Updated ChipStructs.java after previous regen_all

* Revert bad merge

* Reverted removal of measurement and sensing xml

* regen_all

* Moved MatterCommodityPricePluginServerInitCallback() to util.cpp to resolve linker error

* Reverted ElectricalPowermeasurementDelegate use of global struct

* Bump zap to 2025.3.25

* Partial regen-all to update .matter files (zap-regen-all still crashes!)

* Support non-nightly versions

* Another update for logic

* Fix bad update

* Update one more extra extension

* Reverted some of the xml files that were updated by alchemy and not really needed in this pr

* Reverted EEM/EPM xml files

* Zap regen all finally fixed with increased timeout

* Merge of .github/workflows/tests.yaml had screwed up

* Fixed Linux crash on startup by adding an empty cmd handler function for now and calling ChipLinuxAppInit()

* Revert "Merge remote-tracking branch 'andrei/zap_update' into energy-gateway-app"

This reverts commit 0cc1dea2631d433c47d524c41c72104a0f46e603, reversing
changes made to 2fd6786b070e9be09311d3a11689eda905c4eb32.

* Syncd back to Master after reverting Andrei's zap changes

* Per review comment - changed copyright to only 2025

* Updated more copyright to 2025

* Update copyright commodity-price-server.cpp

---------

Co-authored-by: Hasty Granbery <hasty@granbery.org>
Co-authored-by: Hasty Granbery <granbery@google.com>
Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: Andrei Litvin <andreilitvin@google.com>
38 files changed
tree: 764bbc03d787b9ec470d472ee51a8b9de97c8d03
  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. .mergify.yml
  29. .prettierrc.json
  30. .pullapprove.yml
  31. .restyled.yaml
  32. .shellcheck_tree
  33. .spellcheck.yml
  34. BUILD.gn
  35. CODE_OF_CONDUCT.md
  36. CODEOWNERS
  37. CONTRIBUTING.md
  38. gn_build.sh
  39. iwyu.imp
  40. kotlin-detect-config.yaml
  41. lgtm.yml
  42. LICENSE
  43. NOTICE
  44. pigweed.json
  45. pyproject.toml
  46. README.md
  47. REVIEWERS.md
  48. SECURITY.md
  49. SPECIFICATION_VERSION
README.md

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 Linux Standalone Mbed OS MW320 nRF Connect SDK Open IoT SDK QPG STM32 Telink Tizen

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.