diff --git a/README.md b/README.md index 4f5297a7348bf8..5dc8b1583dc2da 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ +[![Silicon Labs](./docs/silabs/images/silabs-logo.jpg)](https://www.silabs.com) + # Silicon Labs Matter -Welcome to the Silicon Labs Matter Github repo. This is your one stop shop for all things related to Silicon Labs and Matter development. +Welcome to the Silicon Labs Matter Github repo. This is your one stop shop for +all things related to Silicon Labs and Matter development. -**To develop a Matter application with Silicon Labs please start here: [Silicon Labs Matter Table of Contents](./docs/silabs/README.md)** +**To develop a Matter application with Silicon Labs please start here:** ---- +**[Silicon Labs Matter Table of Contents](./docs/silabs/README.md)** +--- [![Builds](https://github.com/project-chip/connectedhomeip/workflows/Builds/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/build.yaml) @@ -36,7 +40,6 @@ Welcome to the Silicon Labs Matter Github repo. This is your one stop shop for a **Tests** - [![Unit / Integration Tests](https://github.com/project-chip/connectedhomeip/workflows/Unit%20/%20Integration%20Tests/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/unit_integration_test.yaml) [![Cirque](https://github.com/project-chip/connectedhomeip/workflows/Cirque/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/cirque.yaml) [![QEMU](https://github.com/project-chip/connectedhomeip/workflows/QEMU/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/qemu.yaml) @@ -45,166 +48,6 @@ Welcome to the Silicon Labs Matter Github repo. This is your one stop shop for a [![ZAP Templates](https://github.com/project-chip/connectedhomeip/workflows/ZAP/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/zap_templates.yaml) -**Documentation** - -[![Documentation Build](https://github.com/project-chip/connectedhomeip/actions/workflows/docbuild.yaml/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/docbuild.yaml) - -- [Matter SDK documentation page](https://project-chip.github.io/connectedhomeip-doc/index.html) - -# 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](https://csa-iot.org/developer-resource/specifications-download-request/) -for adoption now. - -Visit [buildwithmatter.com](https://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](docs/images/Matter_Arch_Overview.png) - -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](docs/images/Matter_Layered_Arch.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 - on/off the bulb as well as its color characteristics. - -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. - -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. - -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. - -5. **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. - -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. - -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. - -# 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](./CONTRIBUTING.md). - -# Building and Developing in Matter - -Instructions about how to build Matter can be found [here](./docs/README.md) . - # Directory Structure The Matter repository is structured as follows: diff --git a/docs/silabs/OVERVIEW.md b/docs/silabs/OVERVIEW.md index f3d4eb71377cd2..b5b6698cfd7727 100644 --- a/docs/silabs/OVERVIEW.md +++ b/docs/silabs/OVERVIEW.md @@ -1,16 +1,16 @@ # Silicon Labs Matter Repo Overview -Welcome to the Silicon Labs Matter Repo. For more information on Matter in general see the main [Matter Overview](../../README.md) page. +Welcome to the Silicon Labs Matter Repo. For more information on Matter in general see the main [Matter Overview](https://www.silabs.com/wireless/matter) page. Silicon Labs supports Matter on both 802.15.4 (Thread) and 802.11 (Wi-Fi) transport protocols. -This Repo is the starting point for all Silicon Labs-related Matter development. In this repo you will find documentation, demos, examples and all the code needed for Matter Accessory Device development on both Thread and . +This Repo is the starting point for all Silicon Labs-related Matter development. In this repo you will find documentation, demos, examples and all the code needed for Matter Accessory Device development on both Thread and Wi-Fi. -The Thread and development use cases differ because the Thread protocol requires the use of an Open Thread Border Router (OTBR). +The Thread development use cases differs from Wi-Fi because the Thread protocol requires the use of an Open Thread Border Router (OTBR). -The Thread demo and development use case is described in the Thread section of this documentation located here: [Matter Thread](./thread/THREAD.md) +The Thread demo and development use case is described in the Thread section of this documentation located here: [Matter Thread](./thread/DEMO_OVERVIEW.md) -The Wi-Fi demo and development use case is described in the Wi-Fi section of this documentation located here: [Matter Wi-Fi](./wifi/WIFI.md) +The Wi-Fi demo and development use case is described in the Wi-Fi section of this documentation located here: [Matter Wi-Fi](./wifi/DEMO_OVERVIEW.md) ---- [Table of Contents](./README.md) | [Thread Demo](./thread/DEMO_OVERVIEW.md) | [Wi-Fi Demo](./wifi/DEMO_OVERVIEW.md) \ No newline at end of file diff --git a/docs/silabs/images/silabs-logo.jpg b/docs/silabs/images/silabs-logo.jpg new file mode 100644 index 00000000000000..9379b65689b9ee Binary files /dev/null and b/docs/silabs/images/silabs-logo.jpg differ