IDT v0.0.2 (#29931)

* Squashed commit of the following:

commit 29d46b1e1a49ea4952edb5767f057600e9a3f9be
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 21:48:48 2023 -0700

    Nit

commit b43293773d2a3efbbe640b3c56889ee557b77bcd
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 21:11:22 2023 -0700

    README and error reporting and controlelr resturct

commit 4ac762d9ca34d7e603921a0721a1bcd3b17223d8
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 19:15:59 2023 -0700

    Logging

commit 5b6b3254b5afc975989d70df3bc60c501ee8a045
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 18:38:25 2023 -0700

    Move logging

commit 9df3206fe6e87c801eef085ba3aded65b92d2fdb
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 18:13:57 2023 -0700

    Prober

commit 4683b34a3ef3e4e63decc5ad1f73cb7543d0620f
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 17:55:03 2023 -0700

    Make logcat resiliant

commit 12bb816fddee9261167c7fcfd0a5a0c67c5a01ad
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 17:30:37 2023 -0700

    Warn when file is not growing

commit 1451a027ae738cdffbea011d75a1358f953a4b9f
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 16:03:36 2023 -0700

    Real time analysis

commit 8c8ac7f348935de39bab08e7a4c5521359a8a7bb
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 12:22:00 2023 -0700

    Fix capabilities, screen

commit 6ccfcc7b00d9b32dbb1f71c0e604e2215f902ad5
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 11:27:38 2023 -0700

    Snoop

commit 29d8969c363146f8e10c5b6ba550c7f6b01c9500
Author: bozowski <bozowski@google.com>
Date:   Mon Oct 23 11:12:26 2023 -0700

    HCI logs

commit a856bf67f37826de6594161e44a6547425686814
Author: bozowski <bozowski@google.com>
Date:   Fri Oct 20 15:04:32 2023 -0700

    Fix pull

commit 1239a9066afb0f980e10611f8bc877e5834372e1
Author: bozowski <bozowski@google.com>
Date:   Fri Oct 20 14:51:22 2023 -0700

    OK

commit 2b3db4dfb2935513b0995bdea8afb211671c8390
Author: bozowski <bozowski@google.com>
Date:   Fri Oct 20 14:09:16 2023 -0700

    Screen recording

commit 5d02aa61f9439bcbabffcbf6ce57d75636093a1a
Author: bozowski <bozowski@google.com>
Date:   Fri Oct 20 13:34:05 2023 -0700

    Nits

commit 85517ff7901854b229a10914a5234ea58072ecaa
Author: bozowski <bozowski@google.com>
Date:   Fri Oct 20 13:07:40 2023 -0700

    Fix prober, color config

commit c5d668c40067a1615dc19ebd329f14cb00659b47
Author: bozowski <bozowski@google.com>
Date:   Fri Oct 20 12:45:20 2023 -0700

    Screen

commit 63525818453d0190df0f9b06f29efa200ca928d4
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 21:39:05 2023 -0700

    Nit

commit 1c8a45a7a7301031f904aa20ad4049a93a85bbde
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 21:22:14 2023 -0700

    Nit

commit 51c187f13301386cca0a14a2c0a32b61c38a7cc7
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 21:10:07 2023 -0700

    Splash

commit 0091588772a0dd29fce448a6cda1c19c655574b5
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 20:47:48 2023 -0700

    Refactor

commit c480a023875e807d7ccb5780ab3846730211239c
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 15:41:39 2023 -0700

    Refactor

commit 024eeb6f979a400f2315a68baa7a6a5ba094edfa
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 15:27:05 2023 -0700

    Bugreport

commit efcc621f5c772f60405ed4b0035102d71a97f4cd
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 14:51:30 2023 -0700

    Nit

commit d5474b7128607256972424bc3dd7b16012cc979c
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 14:33:18 2023 -0700

    Configs

commit 0fcbb101db0f38c41f01aaf54a29830a5e5527ab
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 04:26:54 2023 -0700

    TODO

commit b1c7a304c5a204fa43e12111cf4612471e6e5e4e
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 04:20:18 2023 -0700

    Clean BUILD

commit d86778a5adecfc4b50f330a6dd0af2cfe651e82d
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 04:16:19 2023 -0700

    Logging bug

commit 6ebf7c06cd45df1bfee44126e5707121d5149a22
Author: bozowski <bozowski@google.com>
Date:   Thu Oct 19 03:03:48 2023 -0700

    Branch

* Restyled by prettier-markdown

* Restyled by shellharden

* Restyled by autopep8

* Restyled by isort

* Spelling

* Lints

* Support RPi install

* Restyled by prettier-markdown

* Uneeded sudo

* Readme clarification

* Remove dead comment

* Remove dead comment

* Squashed commit of the following:

commit 36f3cebc8bead66b65bcfa1cc31892da05699a40
Author: Austin Bozowski <bozowski@google.com>
Date:   Wed Oct 25 20:07:16 2023 -0700

    Multiproc to async and target macOS

* Fix stopping procs on mac

* Replace multiproc with async

* Fix sudo kill issue on macOS

* Note

* Fix stopping pcap issue on macOS

* Cleanup

* BLE scanning on macOS

* Final cleanup for macOS and README

* Squashed commit of the following:

commit 3da0875bd3d1c1c8b43f9d1985a30ec570fcefb3
Author: Austin Bozowski <bozowski@google.com>
Date:   Fri Nov 3 01:49:45 2023 -0700

    README

commit b7d115d58fe7a0d8189e1bf48ab8397f47f6044a
Author: Austin Bozowski <bozowski@google.com>
Date:   Fri Nov 3 01:44:58 2023 -0700

    Refactor

commit b9dca9db08ff7a675a3bc33d4cfaba1040e0e648
Author: Austin Bozowski <bozowski@google.com>
Date:   Fri Nov 3 01:16:11 2023 -0700

    Refactor

commit d960b41e2bc5a697da7addd3bafdd8e5e0b3e97e
Author: Austin Bozowski <bozowski@google.com>
Date:   Fri Nov 3 00:43:21 2023 -0700

    Logging

commit 4f6644cfe1db756ff2ab337bb32c559523834d97
Author: Austin Bozowski <bozowski@google.com>
Date:   Fri Nov 3 00:18:11 2023 -0700

    Discovery

commit 6900a196f752b30b1539cf393d00c46f6066a5fa
Author: Austin Bozowski <bozowski@google.com>
Date:   Thu Nov 2 23:55:17 2023 -0700

    README

commit f2e9a8cd705f2cc7a1490fd0ef51de24865b1c47
Author: Austin Bozowski <bozowski@google.com>
Date:   Thu Nov 2 23:44:15 2023 -0700

    README

commit dc98974c4c1eece8f7a820b30df734a1c1787732
Author: Austin Bozowski <bozowski@google.com>
Date:   Thu Nov 2 23:27:02 2023 -0700

    Write dnssd log

commit 1fe3f98116407d59a2fd392d507ea3bb96705297
Author: Austin Bozowski <bozowski@google.com>
Date:   Thu Nov 2 22:34:32 2023 -0700

    Cleanup probers

commit 5e48bc0f95a2e0b218bf00f31c6b1bb7f0baeedf
Author: Austin Bozowski <bozowski@google.com>
Date:   Thu Nov 2 14:55:03 2023 -0700

    Probes

commit c9d14ed1ac32a9107bd2ff63ac9aaeaa32812384
Author: Austin Bozowski <bozowski@google.com>
Date:   Thu Nov 2 13:22:21 2023 -0700

    Probers

commit 12307e422bb206e9d6dd868698c58674648cb3b2
Author: Austin Bozowski <bozowski@google.com>
Date:   Wed Nov 1 15:43:31 2023 -0700

    Earlier prober

* Nits

* Remove temp tests

* Prevent re run of Bash proc and nits

* Restyled by prettier-markdown

* Restyled by autopep8

* Restyled by isort

* Spelling

* Lint

* Respond comment.

* Comment and rename

* Nits

* Clarify

* Add info on interfaces to README

* Document failure mode of not allowing bt perms in macOS

* Restyled by prettier-markdown

* Restyled by isort

* Verify py version and fix non py dep check

* Move host dependencies back to main

* Fix py version check

* Make task cleanup more graceful

* Nit

* Respond comments

* Ensure which is available in host_platform

* Add mac tcpdump build script thanks to James
Rename timeout config and explain it in comments
Slight change to where timeouts are in controller

* README

* Logging

* Explain all DNS SD content to the user (parse TXT etc.)

* Remove TODO

* TTL and nits

* Logging, limit tracert, nits

* Restyled by prettier-markdown

* Restyled by shellharden

* Restyled by shfmt

* Restyled by autopep8

* Restyled by isort

* Integrate mac android tcp and bump restyle

* Use termcolor for colored logs

* Timeout config documentation

* Remove unnecessary abstractions from controller

* Cleanup py version check

* Cleanup error reporting in controller

* Remove unneeded instance vars in playservices

* Fix logcat file scope issue introd in last commit

* Fix dedent

* Add bison to Dockerfile

* Make screen on check in android explicit

* Restyled by autopep8

* Restyled by isort

---------

Co-authored-by: Restyled.io <commits@restyled.io>
55 files changed
tree: a7fd4486e362096c4850787e0abd65ce21122980
  1. .devcontainer/
  2. .githooks/
  3. .github/
  4. .vscode/
  5. build/
  6. build_overrides/
  7. config/
  8. credentials/
  9. data_model/
  10. docs/
  11. examples/
  12. integrations/
  13. scripts/
  14. src/
  15. third_party/
  16. zzz_generated/
  17. .clang-format
  18. .clang-tidy
  19. .default-version.min
  20. .dir-locals.el
  21. .editorconfig
  22. .flake8
  23. .gitattributes
  24. .gitignore
  25. .gitmodules
  26. .gn
  27. .isort.cfg
  28. .mergify.yml
  29. .prettierrc.json
  30. .pullapprove.yml
  31. .restyled.yaml
  32. .shellcheck_tree
  33. .spellcheck.yml
  34. BUILD.gn
  35. CODE_OF_CONDUCT.md
  36. CONTRIBUTING.md
  37. gn_build.sh
  38. kotlin-detect-config.yaml
  39. lgtm.yml
  40. LICENSE
  41. NOTICE
  42. README.md
  43. REVIEWERS.md
  44. SPECIFICATION_VERSION
README.md

Matter

Builds

Builds

Android Ameba ASR BouffaloLab Darwin TI CC26X2X7 TI CC32XX EFR32 ESP32 Infineon i.MX Linux K32W with SE051 Linux ARM Linux Standalone Linux Standalone Mbed OS MW320 nRF Connect SDK Open IoT SDK QPG STM32 Telink Tizen

Tests

Unit / Integration Tests Cirque QEMU

Tools

ZAP Templates

Documentation

Documentation Build

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 for adoption now.

Visit 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

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

  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.
  1. 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.
  1. 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.
  1. 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.
  1. 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.

  2. 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.

  1. 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.

Building and Developing in Matter

Instructions about how to build Matter can be found here .

Directory Structure

The Matter repository is structured as follows:

File/FolderContent
buildBuild system support content and built output directories
build_overridesBuild system parameter customization for different platforms
configProject configurations
credentialsDevelopment and test credentials
docsDocumentation, including guides. Visit the Matter SDK documentation page to read it.
examplesExample firmware applications that demonstrate use of Matter
integrations3rd Party integrations
scriptsScripts needed to work with the Matter repository
srcImplementation of Matter
third_party3rd party code used by Matter
zzz_generatedzap generated template code - Revolving around cluster information
BUILD.gnBuild file for the gn build system
CODE_OF_CONDUCT.mdCode of conduct for Matter and contribution to it
CONTRIBUTING.mdGuidelines for contributing to Matter
LICENSEMatter license file
REVIEWERS.mdPR reviewers
gn_build.shBuild script for specific projects such as Android, EFR32, etc.
README.mdThis File

License

Matter is released under the Apache 2.0 license.