Skip to content

Commit 80e5233

Browse files
andy31415adbridge
authored andcommitted
Fix spellcheck after project-chip#23077 (project-chip#23469)
* Fix spellcheck after project-chip#23077 * Restyle * restyle (again)
1 parent 4427957 commit 80e5233

File tree

1 file changed

+121
-73
lines changed

1 file changed

+121
-73
lines changed

README.md

+121-73
Original file line numberDiff line numberDiff line change
@@ -21,98 +21,152 @@
2121
[![ZAP Templates](https://github.com/project-chip/connectedhomeip/workflows/ZAP/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/zap_templates.yaml)
2222

2323
# About
24-
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.
2524

26-
# What is Matter?
27-
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.
28-
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.
29-
30-
Matter simplifies development for manufacturers and increases compatibility for consumers.
31-
32-
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.
33-
34-
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.
25+
Matter (formerly Project CHIP) creates more connections between more objects,
26+
simplifying development for manufacturers and increasing compatibility for
27+
consumers, guided by the Connectivity Standards Alliance.
3528

36-
The Alliance officially opened the Matter Working Group on January 17, 2020, and the specification is [available](https://csa-iot.org/developer-resource/specifications-download-request/) for adoption now.
37-
38-
Visit [buildwithmatter.com](https://buildwithmatter.com) to learn more and read the latest news and updates about the project.
29+
# What is Matter?
3930

31+
Matter is a unified, open-source application-layer connectivity standard built
32+
to enable developers and device manufacturers to connect and build reliable, and
33+
secure ecosystems and increase compatibility among connected home devices. It is
34+
built with market-proven technologies using Internet Protocol (IP) and is
35+
compatible with Thread and Wi-Fi network transports. Matter was developed by a
36+
Working Group within the Connectivity Standards Alliance (Alliance). This
37+
Working Group develops and promotes the adoption of the Matter standard, a
38+
royalty-free connectivity standard to increase compatibility among smart home
39+
products, with security as a fundamental design tenet. The vision that led major
40+
industry players to come together to build Matter is that smart connectivity
41+
should be simple, reliable, and interoperable.
42+
43+
Matter simplifies development for manufacturers and increases compatibility for
44+
consumers.
45+
46+
The standard was built around a shared belief that smart home devices should be
47+
secure, reliable, and seamless to use. By building upon Internet Protocol (IP),
48+
Matter enables communication across smart home devices, mobile apps, and cloud
49+
services and defines a specific set of IP-based networking technologies for
50+
device certification.
51+
52+
The Matter specification details everything necessary to implement a Matter
53+
application and transport layer stack. It is intended to be used by implementers
54+
as a complete specification.
55+
56+
The Alliance officially opened the Matter Working Group on January 17, 2020, and
57+
the specification is
58+
[available](https://csa-iot.org/developer-resource/specifications-download-request/)
59+
for adoption now.
60+
61+
Visit [buildwithmatter.com](https://buildwithmatter.com) to learn more and read
62+
the latest news and updates about the project.
4063

4164
# Project Overview
4265

4366
## Development Goals
4467

4568
Matter is developed with the following goals and principles in mind:
4669

70+
**Unifying:** Matter is built with and on top of market-tested, existing
71+
technologies.
4772

48-
**Unifying:** Matter is built with and on top of market-tested, existing technologies.
49-
50-
51-
**Interoperable:** The specification permits communication between any Matter-certified device, subject to users’ permission.
52-
73+
**Interoperable:** The specification permits communication between any
74+
Matter-certified device, subject to users’ permission.
5375

5476
**Secure:** The specification leverages modern security practices and protocols.
5577

56-
**User Control:** The end user controls authorization for interaction with devices.
57-
58-
59-
**Federated:** No single entity serves as a throttle or a single point of failure for root of trust.
60-
61-
**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.
62-
63-
**Low Overhead:** The protocols are practically implementable on low compute-resource devices, such as MCUs.
78+
**User Control:** The end user controls authorization for interaction with
79+
devices.
6480

81+
**Federated:** No single entity serves as a throttle or a single point of
82+
failure for root of trust.
6583

66-
**Pervasive:** The protocols are broadly deployable and accessible, by leveraging IP and being implementable on low-capability devices.
84+
**Robust:** The set of protocols specifies a complete lifecycle of a device —
85+
starting with the seamless out-of-box experience, through operational protocols,
86+
to device and system management specifications required for proper function in
87+
the presence of change.
6788

89+
**Low Overhead:** The protocols are practically implementable on low
90+
compute-resource devices, such as MCUs.
6891

69-
**Ecosystem-Flexible:** The protocol is flexible enough to accommodate deployment in ecosystems with differing policies.
92+
**Pervasive:** The protocols are broadly deployable and accessible, by
93+
leveraging IP and being implementable on low-capability devices.
7094

95+
**Ecosystem-Flexible:** The protocol is flexible enough to accommodate
96+
deployment in ecosystems with differing policies.
7197

72-
**Easy to Use:** The protocol provides smooth, cohesive, integrated provisioning and out-of-box experience.
98+
**Easy to Use:** The protocol provides smooth, cohesive, integrated provisioning
99+
and out-of-box experience.
73100

74-
75-
**Open:** The Project’s design and technical processes are open and transparent to the general public, including non-members wherever possible.
101+
**Open:** The Project’s design and technical processes are open and transparent
102+
to the general public, including non-members wherever possible.
76103

77104
## Architecture Overview
78-
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:
79-
![Matter Architecture Overview](docs/images/Matter_Arch_Overview.png)
80-
81105

106+
Matter aims to build a universal IPv6-based communication protocol for smart
107+
home devices. The protocol defines the application layer that will be deployed
108+
on devices and the different link layers to help maintain interoperability. The
109+
following diagram illustrates the normal operational mode of the stack:
110+
![Matter Architecture Overview](docs/images/Matter_Arch_Overview.png)
82111

83-
The architecture is divided into layers to help separate the different responsibilities and introduce a good level of encapsulation amongst the various pieces of the protocol stack. The vast majority of interactions flow through the stack captured in the following Figure:
84-
112+
The architecture is divided into layers to help separate the different
113+
responsibilities and introduce a good level of encapsulation among the various
114+
pieces of the protocol stack. The vast majority of interactions flow through the
115+
stack captured in the following Figure:
85116

86117
![Matter Stack Architecture](docs/images/Matter_Layered_Arch.png)
87118

88-
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.
89-
119+
1. **Application:** High-order business logic of a device. For example, an
120+
application that is focused on lighting might contain logic to handle turning
121+
on/off the bulb as well as its color characteristics.
90122

91-
2. **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.
123+
2) **Data Model:** The data layer corresponds to the data and verb elements that
124+
help support the functionality of the application. The Application operates
125+
on these data structures when there is an intent to interact with the device.
92126

127+
3. **Interaction Model:** The Interaction Model layer defines a set of
128+
interactions that can be performed between a client and server device. For
129+
example, reading or writing attributes on a server device would correspond to
130+
application behavior on the device. These interactions operate on the
131+
elements defined at the data model layer.
93132

94-
3. **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.
95-
96-
97-
4. **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. Security: An encoded action frame is then processed by the Security Layer: the message is encrypted and appended with a message authentication code. These actions ensure the data remain confidential and authentic between sender and receiver of the message.
98-
133+
4) **Action Framing:** Once an action is constructed using the Interaction
134+
Model, it is serialized into a prescribed packed binary format to encode for
135+
network transmission. Security: An encoded action frame is then processed by
136+
the Security Layer: the message is encrypted and appended with a message
137+
authentication code. These actions ensure the data remain confidential and
138+
authentic between sender and receiver of the message.
99139

100140
5. **Security:** An encoded action frame is then sent down to the Security Layer
101141
to encrypt and sign the payload to ensure that data is secured and
102142
authenticated by both sender and receiver of a packet.
103143

104-
6. **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.
105-
106-
107-
7. **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.
144+
6. **Message Framing & Routing:** With an interaction encrypted and signed, the
145+
Message Layer constructs the payload format with required and optional header
146+
fields; which specify the message's properties and some routing information.
108147

148+
7) **IP Framing & Transport Management:** After the final payload has been
149+
constructed, it is sent to the underlying transport protocol for IP
150+
management of the data.
109151

110152
# Current Status of Matter
111153

112-
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.
113-
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.
114-
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.
115-
154+
Matter’s design and technical processes are intended to be open and transparent
155+
to the general public, including to Working Group non-members wherever possible.
156+
The availability of this GitHub repository and its source code under an Apache
157+
v2 license is an important and demonstrable step to achieving this commitment.
158+
Matter endeavors to bring together the best aspects of market-tested
159+
technologies and redeploy them as a unified and cohesive whole-system solution.
160+
The overall goal of this approach is to bring the benefits of Matter to
161+
consumers and manufacturers as quickly as possible. As a result, what you
162+
observe in this repository is an implementation-first approach to the technical
163+
specification, vetting integrations in practice. The Matter repository is
164+
growing and evolving to implement the overall architecture. The repository
165+
currently contains the security foundations, message framing and dispatch, and
166+
an implementation of the interaction model and data model. The code examples
167+
show simple interactions, and are supported on multiple transports -- Wi-Fi and
168+
Thread -- starting with resource-constrained (i.e., memory, processing) silicon
169+
platforms to help ensure Matter’s scalability.
116170

117171
# How to Contribute
118172

@@ -125,27 +179,21 @@ Instructions about how to build Matter can be found [here](./docs/README.md).
125179

126180
# Directory Structure
127181

128-
The Matter repository is structured as follows:
129-
| File/Folder | Content |
130-
|--------------------|---------------------------------------------------------------------|
131-
| build | Build system support content and built output directories  |
132-
| build_overrides | Build system parameter customization for different platforms |
133-
| config | Project configurations |
134-
| credentials | Development and test credentials |
135-
| docs | Documentation, including guides  |
136-
| examples | Example firmware applications that demonstrate use of Matter  |
137-
| integrations | 3rd Party integrations  |
138-
| scripts | Scripts needed to work with the Matter repository  |
139-
| src | Implementation of Matter  |
140-
| third_party | 3rd party code used by Matter  |
141-
| zzz_generated | zap generated template code - Revolving around cluster information  |
142-
| BUILD.gn | Build file for the gn build system  |
143-
| CODE_OF_CONDUCT.md | Code of conduct for Matter and contribution to it  |
144-
| CONTRIBUTING.md | Guidelines for contributing to Matter |
145-
| LICENSE | Matter license file  |
146-
| REVIEWERS.md | PR reviewers  |
147-
| gn_build.sh | Build script for specific projects such as Android, EFR32, etc.  |
148-
| README.md | This File |
182+
| The Matter repository is structured as follows: | File/Folder | Content |
183+
| ----------------------------------------------------- | ------------------------------------------------------------ | ------------- |
184+
| build | Build system support content and built output directories  | |
185+
| build_overrides | Build system parameter customization for different platforms |
186+
| config | Project configurations | | credentials | Development and test |
187+
| credentials | | docs | Documentation, including guides  | | examples | Example |
188+
| firmware applications that demonstrate use of Matter  | | integrations | 3rd |
189+
| Party integrations  | | scripts | Scripts needed to work with the Matter |
190+
| repository  | | src | Implementation of Matter  | | third_party | 3rd party code |
191+
| used by Matter  | | zzz_generated | zap generated template code - Revolving |
192+
| around cluster information  | | BUILD.gn | Build file for the gn build system  |
193+
| CODE_OF_CONDUCT.md | Code of conduct for Matter and contribution to it  | |
194+
| CONTRIBUTING.md | Guidelines for contributing to Matter | | LICENSE | Matter |
195+
| license file  | | REVIEWERS.md | PR reviewers  | | gn_build.sh | Build script |
196+
| for specific projects such as Android, EFR32, etc.  | | README.md | This File |
149197

150198
# License
151199

0 commit comments

Comments
 (0)