| commit | 2146aba7b84858054282440b7da36f410c29821c | [log] [tgz] |
|---|---|---|
| author | Mahesh <92411857+pimpalemahesh@users.noreply.github.com> | Wed Apr 16 20:37:35 2025 +0530 |
| committer | GitHub <noreply@github.com> | Wed Apr 16 15:07:35 2025 +0000 |
| tree | bbbe97f00bd03d6645449b08fcfd2a73cc68f7a1 | |
| parent | e42d6b1acee2cfd8aa8516b5de5ee3754981ffb8 [diff] |
[ESP32] Platform diagnostics framework (#36532) * esp32 diagnostic trace - Working backend with metric, trace and counter diagnostics - Diagnostic interface implementation with ring buffer storage - Added option ENABLE_ESP_DIAGNOSTICS_TRACE in chip KConfig - Added required options for enabling matter diagnostic trace in project Kconfig * example/temperature-measurement-app - Resolve buffer issues - Use single buffer for store and retrieve of diagnostics - Resolve data loss issue * backend: Add description for diagnosticstorage interface, remove unncessary comments, format files, namespace changes * temperature_measurement_app: Review changes * esp32_diagnostic_trace: Review changes - backend: Replace linkedlist with map for counter diagnostics - backend: Pass diagnostic storage as a parameter to backend - esp32_diagnostic_trace: Return actual data size * temperature_measurement_app: Review changes * backend: map for counter diagnostics related changes - esp32_diagnostic_trace: improve storage class design - add extra tlv closing bytes check before copying diagnostic - unify diagnostic entries into a single type * example: Remove redundant code * diagnostic-buffer: clear buffer after successful bdx log transfer - Add related logic in temperature-measurement-app * diagnostic-storage: Remove singltone design for storage instance - Add private CircularTLVReader and CircularTLVWriter - Remove redundant outer container for tlv's from Retrieve method - Maintain TAG's for diagnostic entry elements - Make diagnostic entry as a constant param to store method - Move Murmurhash to utils namespace * temperature-measurement-app: use seperate buffer for retrieval of diagnostics - move diagnostic storage buffer to main * temperature-measurement-app: pass diagnostic storage Instance as pointer to LogProvider - add kconfig option for retrieval buffer size * backend: update methods to propagate error to level up - pass diagnostic storage instance as a pointer to backend - replace ESPLog statement with ChipLog for logging diagnostic-storage: update IsEmptyBuffer method to IsBufferEmpty - change diagnostic TAG enum class * temperature-measurement-app: review changes * esp32_diagnostic_trace: review changes * esp32_diagnostic_trace: Add clearBuffer() method, update api documentation * fixed trace instant filter * esp_diagnostic_trace: add clearbuffer method to diagnostic interface * diagnostics: add decode method * readme update * Review changes * Modified chip log statements, make string values mutable * Restyled changes * backend: copyright header change, retrieve api return value changed * diagnosticEntry: add invalid valuetype * Review comments * review comments -DiagnosticEntry structure change -Encode, Decode, Retrieve diagnostic method changes * fix read entryes type in log prints * esp29_diagnostic_trace: Add tests for Encode, Decode, Store and Retrieve methods of the diagnostic storage * review comments - moved diagnostic storage specific tests to the esp32_diagnostic_trace folder - removed dependency of tracing and esp32 specific code form tests * replace size_t with uint32_t for diagnostic storage * diangostic test: converted int value to uint to address implicit convertsion error
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.