Skip to content

Commit

Permalink
docs: update chip name to Matter and misc edits (#10561)
Browse files Browse the repository at this point in the history 
* doc: update CHIP name on intro pages

Update CHIP to Matter in top-level readme and contributing.md.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

* doc: update CHIP name in generic examples

Updated CHIP to Matter in non-nrfconnect generic examples.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

* doc: update CHIP name on nrfconnect pages

Updated CHIP to Matter on nrfconnect pages.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

* doc: update CHIP name in tool guides

Updated CHIP to Matter in tool guides.
Updated structure of the Android guide.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

* doc: update CHIP name in docs/ files

Changed CHIP to Matter in md files in docs/.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

* Restyled by prettier-markdown

* wordlist: add CSA term

Updated .wordlist with CSA.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

Co-authored-by: Restyled.io <commits@restyled.io>
  • Loading branch information
@greg-fer @restyled-commits @pull
2 people authored and pull[bot] committed Nov 15, 2021
1 parent 18baad8 commit 4184519
Show file tree
Hide file tree
Showing 23 changed files with 292 additions and 292 deletions.
1 change: 1 addition & 0 deletions .github/.wordlist.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,7 @@ cpuapp
cpython
crypto
cryptographic
CSA
csu
csv
ctl
Expand Down
49 changes: 24 additions & 25 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,41 @@

Want to contribute? Great! First, read this page (including the small print at
the end). By submitting a pull request, you represent that you have the right to
license your contribution to the Connectivity Standards Alliance and the community, and agree by
submitting the patch that your contributions are licensed under the
[Apache 2.0 license](./LICENSE). Before submitting the pull request, please make
sure you have tested your changes and that they follow the project guidelines
for contributing code.
license your contribution to the Connectivity Standards Alliance and the
community, and agree by submitting the patch that your contributions are
licensed under the [Apache 2.0 license](./LICENSE). Before submitting the pull
request, please make sure you have tested your changes and that they follow the
project guidelines for contributing code.

# Contributing as an Open Source Contributor

As an open source contributor you can report bugs and request features in the
[Issue Tracker](https://github.com/project-chip/connectedhomeip/issues), as well
as contribute bug fixes and features that do not impact Matter
specification as a pull request. For example: ports of Matter to add APIs
to alternative programming languages (e.g. Java, JS), hardware ports, or an
optimized implementation of existing functionality. For features that impact the
specification, please join Matter work group within the Connectivity Standards Alliance.
The requirements to become an open source contributor of the
[Project CHIP Repository](https://github.com/project-chip/connectedhomeip) are:
as contribute bug fixes and features that do not impact Matter specification as
a pull request. For example: ports of Matter to add APIs to alternative
programming languages (e.g. Java, JS), hardware ports, or an optimized
implementation of existing functionality. For features that impact the
specification, please join Matter work group within the Connectivity Standards
Alliance. The requirements to become an open source contributor of the
[Matter Repository](https://github.com/project-chip/connectedhomeip) are:

- Agree to the [Code of Conduct](./CODE_OF_CONDUCT.md)
- Agree to the [License](./LICENSE)
- Have signed the
[Zigbee Project CHIP Working Group CLA](https://gist.github.com/clapre/65aa9fc63981da765039e0bb7e8701be)
[Matter Working Group CLA](https://gist.github.com/clapre/65aa9fc63981da765039e0bb7e8701be)

# Contributing as a Connectivity Standards Alliance Project CHIP Working Group Member
# Contributing as a Connectivity Standards Alliance Matter Working Group Member

As a participant of the Connectivity Standards Alliance Project CHIP Working Group, you can
attend Working Group meetings, propose changes to the Matter
As a participant of the Connectivity Standards Alliance Matter Working Group,
you can attend Working Group meetings, propose changes to the Matter
specification, and contribute code for approved updates to the specification.
The requirements to become a member of the
[Project CHIP Repository](https://github.com/project-chip/connectedhomeip) are:
[Matter Repository](https://github.com/project-chip/connectedhomeip) are:

- Must be a [Participant member](http://www.zigbeealliance.org/join) or higher
of the Connectivity Standards Alliance
- Must be a Project CHIP Working Group member
- Have signed the Alliance Project CHIP Working Group CLA
- Must be a Matter Working Group member
- Have signed the Alliance Matter Working Group CLA
- Have approval from your company's official approver

# Bugs
Expand Down Expand Up @@ -67,15 +67,14 @@ new feature:

# Contributing Code

Project CHIP follows the "Fork-and-Pull" model for accepting contributions.
Matter follows the "Fork-and-Pull" model for accepting contributions.

### Initial Setup

Setup your GitHub fork and continuous-integration services:

1. Fork the
[Project CHIP repository](https://github.com/project-chip/connectedhomeip) by
clicking "Fork" on the web UI.
1. Fork the [Matter repository](https://github.com/project-chip/connectedhomeip)
by clicking "Fork" on the web UI.

2. All contributions must pass all checks and reviews to be accepted.

Expand Down Expand Up @@ -165,8 +164,8 @@ on occasion.

#### Documentation Best Practices

Project CHIP uses Doxygen to markup (or markdown) all C, C++, Objective C,
Objective C++, Perl, Python, and Java code. Read our
Matter uses Doxygen to markup (or markdown) all C, C++, Objective C, Objective
C++, Perl, Python, and Java code. Read our
[Doxygen Best Practices, Conventions, and Style](https://github.com/project-chip/connectedhomeip/blob/master/docs/style/DOXYGEN.adoc)

#### Submit Pull Request
Expand Down
123 changes: 60 additions & 63 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Connected Home over IP
# Matter

![Builds](https://github.com/project-chip/connectedhomeip/workflows/Builds/badge.svg)

Expand All @@ -17,24 +17,24 @@

![ZAP Templates](https://github.com/project-chip/connectedhomeip/workflows/ZAP/badge.svg)

# What is Project Connected Home over IP?
# What is Matter?

Project Connected Home over IP is a new Working Group within the Zigbee
Alliance. This Working Group plans to develop and promote the adoption of a new,
royalty-free connectivity standard to increase compatibility among smart home
products, with security as a fundamental design tenet.
Matter (formerly Project Connected Home over IP, or Project CHIP) is a new
Working Group within the Connectivity Standards Alliance (CSA, formerly Zigbee
Alliance). This Working Group plans to develop and promote the adoption of a
new, royalty-free connectivity standard to increase compatibility among smart
home products, with security as a fundamental design tenet.

The goal of the Connected Home over IP project is to simplify development for
manufacturers and increase compatibility for consumers. The project is built
around a shared belief that smart home devices should be secure, reliable, and
seamless to use. By building upon Internet Protocol (IP), the project aims to
enable communication across smart home devices, mobile apps, and cloud services
and to define a specific set of IP-based networking technologies for device
The goal of the Matter project is to simplify development for manufacturers and
increase compatibility for consumers. The project is built around a shared
belief that smart home devices should be secure, reliable, and seamless to use.
By building upon Internet Protocol (IP), the project aims to enable
communication across smart home devices, mobile apps, and cloud services and to
define a specific set of IP-based networking technologies for device
certification.

The Zigbee Alliance officially opened the Project Connected Home over IP
(Project CHIP) Working Group on January 17, 2020 and is in the process of
drafting the specification.
The CSA officially opened the Matter Working Group on January 17, 2020 and is in
the process of drafting the specification.

Visit [buildwithmatter.com](https://buildwithmatter.com) to learn more and read
the latest news and updates about the project.
Expand All @@ -43,14 +43,13 @@ the latest news and updates about the project.

## Development Goals

Project Connected Home over IP is developed with the following goals and
principles in mind:
Matter is developed with the following goals and principles in mind:

**Unifying:** Project CHIP will produce a new specification, building with and
on top of market-tested, existing technologies.
**Unifying:** Matter will produce a new specification, building with and on top
of market-tested, existing technologies.

**Interoperable:** The specification permits communication between any Project
CHIP-certified device, subject to users’ permission.
**Interoperable:** The specification permits communication between any
Matter-certified device, subject to users’ permission.

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

Expand Down Expand Up @@ -82,17 +81,17 @@ transparent to the general public, including to non-members wherever possible.

## Architecture Overview

![CHIP Architecture Overview](docs/images/CHIP_IP_pyramid.png)
![Matter Architecture Overview](docs/images/CHIP_IP_pyramid.png)

The Project, as illustrated above, defines the application layer that will be
deployed on devices and controllers as well as the supported IPv6-based networks
to help achieve our interoperability architectural goal. Project CHIP will
initially support Wi-Fi and Thread for core, operational communications and
Bluetooth Low Energy (BLE) to simplify device commissioning and setup.
to help achieve our interoperability architectural goal. Matter will initially
support Wi-Fi and Thread for core, operational communications and Bluetooth Low
Energy (BLE) to simplify device commissioning and setup.

The Application Layer can be further broken down seven main components:

![CHIP Stack Architecture](docs/images/CHIP_Arch_Pyramid.png)
![Matter Stack Architecture](docs/images/CHIP_Arch_Pyramid.png)

1. **Application:** High order business logic of a device. For example, an
application that is focused on lighting might contain logic to handle turning
Expand Down Expand Up @@ -124,60 +123,58 @@ The Application Layer can be further broken down seven main components:
constructed, it is sent to the underlying transport protocol for IP
management of the data.

# Current Status of Project Connected Home over IP
# Current Status of Matter

The Project’s design and technical processes are intended to be open and
transparent to the general public, including to Work 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’s design and technical processes are intended to be open and transparent
to the general public, including to Work 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.

The Project endeavors to bring together the best aspects of market-tested
Matter endeavors to bring together the best aspects of market-tested
technologies and to redeploy them as a unified and cohesive whole-system
solution. The overall goal of this approach is to bring the benefits of the
Project 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.
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 Project repository is growing and evolving to implement the overall
The Matter repository is growing and evolving to implement the overall
architecture. The repository currently contains the security foundations,
message framing and dispatch, 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 the Project’s
(i.e., memory, processing) silicon platforms to help ensure Matter’s
scalability.

# How to Contribute

We welcome your contributions to Project Connected Home over IP. Read our
contribution guidelines [here](./CONTRIBUTING.md).
We welcome your contributions to Matter. Read our contribution guidelines
[here](./CONTRIBUTING.md).

# Building and Developing in Project
# Building and Developing in Matter

Instructions about how to build Project Connected Home over IP can be found
[here](./docs/README.md).
Instructions about how to build Matter can be found [here](./docs/README.md).

# Directory Structure

The Connected Home over IP repository is structured as follows:

| File / Folder | Contents |
| -------------------------------------- | ---------------------------------------------------------------------------------------- |
| `build/` | Build system support content and build output directories |
| [BUILDING.md](docs/guides/BUILDING.md) | More detailed information on configuring and building Project CHIP for different targets |
| `CODE_OF_CONDUCT.md` | Code of Conduct for Project CHIP, and contributions to it |
| [CONTRIBUTING.md](./CONTRIBUTING.md) | Guidelines for contributing to Project CHIP |
| `docs/` | Documentation, including [guides](./docs/guides) |
| `examples/` | Example firmware applications that demonstrate use of Project CHIP technology |
| `integrations/` | Third party integrations related to this project |
| `integrations/docker/` | Docker scripts and Dockerfiles |
| `LICENSE` | Project CHIP [License file](./LICENSE) (Apache 2.0) |
| `BUILD.gn` | Top level GN build file |
| `README.md` | This file |
| `src/` | Implementation of Project CHIP |
| `third_party/` | Third-party code used by Project CHIP |
| `scripts/` | Scripts needed to work with the Project CHIP repo |
The Matter repository is structured as follows:

| File / Folder | Contents |
| -------------------------------------- | ---------------------------------------------------------------------------------- |
| `build/` | Build system support content and build output directories |
| [BUILDING.md](docs/guides/BUILDING.md) | More detailed information on configuring and building Matter for different targets |
| `CODE_OF_CONDUCT.md` | Code of Conduct for Matter, and contributions to it |
| [CONTRIBUTING.md](./CONTRIBUTING.md) | Guidelines for contributing to Matter |
| `docs/` | Documentation, including [guides](./docs/guides) |
| `examples/` | Example firmware applications that demonstrate use of the Matter technology |
| `integrations/` | Third party integrations related to this project |
| `integrations/docker/` | Docker scripts and Dockerfiles |
| `LICENSE` | Matter [License file](./LICENSE) (Apache 2.0) |
| `BUILD.gn` | Top level GN build file |
| `README.md` | This file |
| `src/` | Implementation of Matter |
| `third_party/` | Third-party code used by Matter |
| `scripts/` | Scripts needed to work with the Matter repository |

# License

Project CHIP is released under the [Apache 2.0 license](./LICENSE).
Matter is released under the [Apache 2.0 license](./LICENSE).
18 changes: 9 additions & 9 deletions docs/PROJECT_FLOW.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## CHIP Project Flow
## Matter Project Flow

This section is intended to cover how CHIP uses GitHub Projects, Issues,
This section is intended to cover how Matter uses GitHub Projects, Issues,
Milestones, Releases, and Branches for program/project management in the code
repository.

### Issues

CHIP uses issues as simple problem descriptions or feature requests. In general,
all work contributed to the repository in the form of pull requests (PR) should
be under the auspices of some open issue. This may seem onerous and in some
cases duplicative, so consider these guidelines when deciding whether to you can
get away with not creating an issue:
Matter uses issues as simple problem descriptions or feature requests. In
general, all work contributed to the repository in the form of pull requests
(PR) should be under the auspices of some open issue. This may seem onerous and
in some cases duplicative, so consider these guidelines when deciding whether to
you can get away with not creating an issue:

- Trivial fixes: issues can function as TODO lists, simple reminders that
something should be addressed. Sometimes, though, the work required to fix
Expand Down Expand Up @@ -38,7 +38,7 @@ PR Don'ts:

### Milestones

In CHIP parlance, a milestone is simply a tag for an expected due date or
In Matter parlance, a milestone is simply a tag for an expected due date or
release. Milestones are intended to help contributors and their managers to
prioritize work. There are 2 types: Date-based and Release-based.

Expand Down Expand Up @@ -80,6 +80,6 @@ one of the task-tracking projects (the first type).

### Branches, releases, and general development flow

Master should always be CHIPs best branch. Release branches, once cut, are
Master should always be Matter's best branch. Release branches, once cut, are
closed for any feature work. Software fixes for release branches must first land
on master unless demonstrably infeasible.
Loading

0 comments on commit 4184519

Please sign in to comment.