| commit | 781292bb79f319b46b00d3b389b7874821912a48 | [log] [tgz] |
|---|---|---|
| author | jamesharrow <93921463+jamesharrow@users.noreply.github.com> | Fri Apr 25 13:28:33 2025 +0100 |
| committer | GitHub <noreply@github.com> | Fri Apr 25 12:28:33 2025 +0000 |
| tree | 0a093f0b14a835e69242f2822cd3d78d0a16e969 | |
| parent | 5f59521dc5bcdf6f99901cccf25daa62d2b4b61e [diff] |
Energy gateway app (Part 2) - Add CommodityPrice Delegate and Test Event Trigger support (#38255) * 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 * Added basic test steps for TC_SEPR_2.1/2/3.py * 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 * Initial stab at CommodityPriceDelegate.cpp/.h * moved files * Basic delegate added with ability and setting of Descriptor tags for this endpoint * Added CommodityPriceTestEventTriggerHandler.h * Added hooks to enable/disable chip_enable_commodity_price_trigger to Linux build * Used TestEvent Trigger to set a Price into CurrentPrice. Needs more work but is basically working. * Per review comment - changed copyright to only 2025 * Updated more copyright to 2025 * Update copyright commodity-price-server.cpp * Merged Hasty's PR 38226 into TC_SEPR_2_1.py * Currently returns a valid empty list for PriceForecast. * Updated test case to not complain if list is empty and to check that the description and components must not be included. * New proposed ElectricalGridConditions (EGC) * Fixed issue in spec which caused 2nd event not to generate correctly * Manually added new cluster to tests.yaml, rules.matterlint, zcl.json since Alchemy didn't work for some reason * Ran zap_regen_all * Updated XML based on Rene's PR review comments. * Initial attempt to add a Forecast with list and sub-list and memory management * Updated CommodityPrice XML based on Spec PR to add PriceLevel and make Events have nullable fields to match attributes. * ZAP Regen all * Restyled by whitespace * Restyled by clang-format * Restyled by gn * Restyled by isort * Fix build issue caused by new spec update to make price optional * Updated test script to allow for optional price or price level in both CommodityPrice and CommodityPriceComponent structs * Updated test steps after spec update and test plan update. * Moved common code into TC_SEPRTestBase. Some additional checks added to 2.2 test * Update test scripts so that they use TestBase * ruff fixes in python tests * Restyled by autopep8 * Restyled by isort * regen_all update * Refactor - made cluster server handle 'set' operations so that it sends out a Matter Reporting callback for each attribute if it is changed. Started making commands work but needs more work * Refactoring to allow cluster server to retrieve a copy of the Forecast based on bitmap * Slightly buggy version but sort of works if there is enough memory * An update to get per entry component values. Currently had to reduce the forecast to 4 entries to get it to fit * Clean up and fix some issues in the data and SetCurrentPrice. Removed unnecessary files now that delegate isn't really holding the data. * More clean-up * More clean up * Updated zcl.json with AttributeInterface handling. * Zap regen all once zcl.json was updated * Had accidentally turned off FeatureMap in CommodityPrice. Now back on. * Update commodity-price-cluster.xml based on spec PR 11569 * zap regen all * Marked TC_SEPRTestBase as shared code (not a script) * Update EntryToText.cpp - restore newline at EOF * Update EntryToText.h - restore newline at EOF * Update EntryToText.cpp - restore newline at EOF * Update EntryToText.h - restore newline at EOF * Align structures to corrected Price as Money type. * Fixed IncorrectState when running commands caused by AddStatus after AddResponse * Made the ReadAttribute and GetDetailedForecastCommand dynamically size the response to avoid packet overflow. * Deleted unused java files so CI passes * Completed and fixed test case TC_SEPR_2_2. * Fixed bug introduced in last commit. TC_SEPR_2_1 now passes again * Updated SDK to send PriceForecast events. Note that events have an overhead so not as many entries can be sent. * Implemented TC_SEPR_2_3 and fixed other issues with test scripts. * Restyled by isort * Fix Lint error * Made local copy of EnergyTimeUtils.h * Updated linux to use local copy of EnergyTimeUtils.cpp * Removed Python Tests so that they don't trigger build check failure. * Revert test_metadata.yaml since we're backing out Python scripts from this PR. * Restyled by clang-format * Changed GetDetailedForecastRequest to take a ScopedMemoryBuffer * Improved Memory management for GetDetailedPriceRequest() * Apply suggestions from code review Co-authored-by: Boris Zbarsky <bzbarsky@apple.com> * Remove Forecast Changed Event * Addressing most of code review comments * More review comment changes * removing chip:: and moving to CharSpan::fromCharString() * Refactored SetCurrentPrice to save a local copy into the cluster server. * Fixed issue with wrong variable in SetCurrentPrice - removed unused variable now - seen when sending multiple triggers. * Apply suggestions from code review Co-authored-by: Boris Zbarsky <bzbarsky@apple.com> * Further review comments fixed in SetCurrentPrice() * Further refinement on SetCurrentPrice deep copy * Fixed issues with wrong buffer and a bug in the .component.Value() called without checking .HasValue() first * Removed byte counting nonsense now we have Large Message support * Renamed function * Avoid error when it is ok not to have allocated sub-elements * Missing .matter file after regen_all after merge causing CI issues. * Update src/app/clusters/commodity-price-server/commodity-price-server.h Co-authored-by: Boris Zbarsky <bzbarsky@apple.com> * Merge from Master * Revert "Merge from Master" This reverts commit bf42fdaba520883bd4f84c3e0433f519c0ea1b38. * Tidy up AppMain.cpp after merge * Fixed another merge error * Removed VerifyOrDie when checking that memory should already be free'd. Free it if allocated. * Fixed GetEpochTS (again) - merge issue? --------- 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> Co-authored-by: Boris Zbarsky <bzbarsky@apple.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.