[Telink] Update board support, DFU, factory data and platform configuration (#74059)

* telink: tl3238x: add new soc.
- add tl3238x into matter.
telink: tl3238x: adjust boot setting .
- close bootstrap and bootvalitdate.
- adjust rf settings.
- add 2m partition for customer.
- setting different discriminator.
- add dual mode logic.
- enable ota.
telink: tl3238x: enlarge the ble thread stack.
- after change the ble controller , the thread need
 to enlarge in pm mode.
telink: tl3238x: open ota and lzma for contact-sensor.
- open ota and add lzma.
telink: tl3238x: enlarge malloc.
- enlarge heap size for tl3238x.
telink: tl3238x: enlarge ble thread
- enlarge ble thread stack for jenkins alarm to 100%.

* Develop tl3238x develop merge v1.0.1.0 (#417)

- Optimized the RAM layout(default IRAM 96k, DRAM 64K).
- Optimized the 802.15.4 driver in Zephyr and power consumption in Matter ICD mode.
- Implemented retention deep sleep mode drivers for ADC and I2C under Zephyr.
- Adjusted the clock speed support under different power mode, default retention deep sleep mode is 48MHz, fully power mode is 96MHz.
- Supported TL9268M full power mode.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [Telink] validate slot0 for only once.

* telink: tl3238x: update multiple operation lists for mass production (#438)

 - Add ota event callback .
 - Increase maximum group number per fabric .
 - Increase the ISR_STACK_SIZE to 1024 .
 - Increase the SYSTEM_WORKQUEUE_STACK_SIZE to 2048 .
 - Increase the HEAP_MEM_POOL_SIZE to 1280 .
 - Increase the COMMON_LIBC_MALLOC_ARENA_SIZE to 20716 .
 - Increase the NET_IF_MCAST_IPV6_ADDR_COUNT to 47 .
 - Increase the TL_BLE_CTRL_THREAD_STACK_SIZE to 1536 .
 - Increase the OPENTHREAD_THREAD_STACK_SIZE to 4096 .
 - Increase the OPENTHREAD_RADIO_WORKQUEUE_STACK_SIZE to 2048 .
 - Increase the OPENTHREAD_IP6_MAX_EXT_MCAST_ADDRS to 40 .
 - Increase the NET_RX_STACK_SIZE to 2048 .

* fix typo

* [Telink] Update build environment and steps

- adjust CMakeLists for more SoCs
- add boards/.conf  for tl3238x
- move kconfig from example prj.conf to board.conf
- reduce CHIP MAIN_STACK_SIZE and OT message buffer
size for tl3218x_retention
- include ext_pm.h for tl323x
- restyled by cland-format
- update zephyr
- update tl_ble_sdk
- disable reduntant CI actions

* Fix OpenThread path selection based on CONFIG_OPENTHREAD_TELINK_LIBRARY (#3)

* Update Telink OpenThread Path Selection

fixes the incorrect OpenThread repository selection logic in Telink platform builds:

   - Explicitly set ZEPHYR_OPENTHREAD_MODULE_DIR to use standard openthread path
     when CONFIG_OPENTHREAD_TELINK_LIBRARY is not enabled
   - Replace the directory-existence check with CONFIG_OPENTHREAD_TELINK_LIBRARY
     based path selection
   - Ensures build logs always print the correct git revision information
     matching the actually used OpenThread repository

Now builds correctly distinguish between:
- CONFIG_OPENTHREAD_TELINK_LIBRARY=y: uses modules/lib/openthread_telink_lib
- CONFIG_OPENTHREAD_TELINK_LIBRARY=n: uses modules/lib/openthread

- update zephyr revision

* [Telink] Update Telink Zephyr and BLE SDK and add OTA Manual Process Script

1. SDK updates:
- update zephyr from
f243cd36e52a5bb370f0b6accaa1da29a825b842
to
30c10f8e319254d3771ab18bfb929019a2a7e38d
- update ble sdk from
200420569e5588abdd0c3d92f9e3e518e1fc8778
to
f50d422d780efb73af939650ef7b8c6bf5a0b99b

2. Fixes:
- revert incorrect modifications to pwm_b9x, pwm_tlx

3. Add OTA manual process tool:
- Add scripts/tools/telink/manual_process.py to manually generate Telink Matter OTA FW
- supports all SoC families (2/4MB) with chip-specific LZMA compression pipelines
- implements flexible input modes: .config parsing, manual parameters,
--already-signed, --only-lzma
- path-agnostic design with hardcoded tool paths for re-use in other environment

Restyled by autopep8

Restyled by isort

* Tl develop v1.5.1 fix tercel (#5)

telink: TL721X: fix tl721x and change setting.
- adopt the same setting as tl3238x .
- add config for openthread(put some code into ramcode) .
- add normal partition and lzma partition.
- update matter ci.

Signed-off-by: Haiwen Xia <haiwen.xia@telink-semi.com>

* telink: add dual mode configs and TL3238C-EVK40D board overlay

- Add TL3238C-EVK40D overlay for lighting-app 4MB dual mode
- Add tl3238x_4m_flash_dual_mode.conf (lighting-app, DUAL_MODE=2)
- Add tl3238x_retention_dual_mode.conf (light-switch-app, DUAL_MODE=1)
- Default single-mode configs to DUAL_MODE=0 with LZMA enabled
- Guard Zigbee merge with CONFIG_DUAL_MODE in CMakeLists.txt
- Add build guide READMEs for both apps
- Set device serial numbers in board configs
- Update Zephyr revision in CI workflow

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* [Telink] Check matter network state when power-on (#469)

* [Telink] Check if the thread dataset and fabirc were successfully written.

Signed-off-by: Fengtai Xie <fengtai.xie@telink-semi.com>

* Telink: update and feature integration for tl323x/tl721x

- set isComissioningStarted to false in OnCommissioningSessionEstablishmentError
to fix commissioning session state error.
This is a quick fix from https://github.com/project-chip/connectedhomeip/pull/72700.
- add dual mode configs for tl323x and TL3238C-EVK40D board overlay
- update Telink BLE SDK revision from
c4fdeaa0f3387543b9ec5f351ed74b3047988d00
to
46322e5b570e2a68373b18d4f08811acadd1266c
- update hal_telink to improve flash protection for 4MB flash on TL323X.
- update zephyr revision to
e08fc42546e58d808bfd39f35c8df296f5617a44
- adjust and unify telink boards *.conf/*.overlay process flow for TL323X/721X
- add TL323X/721X build README files and clarify TL721X does NOT support dual mode yet

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* Telink: add drafts of SDK release note, version file, Getting Started guide and reorganize READMEs (#8)

* Telink: add SDK release note, version file and reorganize READMEs

Establish the Telink Matter SDK documentation baseline for release
preparation:

- Add TELINK_VERSION (1.0.1.0) to identify the Telink SDK release
  paired with the upstream Matter master f4a8cf9.
- Add tl_matter_sdk_release_node.md with supported boards, build
  targets and resource usage (RAM/ROM/firmware size) for the TL323X
  and TL721X Matter (OTA + LZMA) configurations.
- Rename the upstream README to MATTER_README and promote the
  Telink README to README.md, so GitHub shows the Telink SDK docs on
  the repository landing page; add a cross-link to the upstream README.

No source code changes.

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* Restyled by prettier-markdown

* add telink technical words into github wordlist

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* change *readme.txt to *readme.md

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* Restyled by prettier-markdown

* Restyled by prettier-markdown

* Telink: add platform docs structure, Getting Started guide and firmware packaging script

- Add docs/platforms/telink/ (index + Getting Started) following the
  per-vendor layout of other Matter platforms; register in
  docs/platforms/index.md.
- Move tl_matter_sdk_release_note.md to
  docs/platforms/telink/releases/telink_release_notes.md (working copy)
  and add a versioned snapshot keyed to the tl_v1.0.1-beta-v1.5.1.0 tag.
- Add scripts/tools/telink/package_telink_firmware.sh for TL3238X/TL7218X
  build/extract/readme/zip; it snapshots the release note into
  telink_release_notes_<tl_v*.tag>.md from the nearest git tag.
- Update README.md links to the new doc locations.

No source code changes.

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* Restyled by prettier-markdown

* Restyled by shellharden

* Restyled by shfmt

* docs: add missing mis-spelling word

- devicetree

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

---------

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>
Co-authored-by: Restyled.io <commits@restyled.io>

* telink: add TL5218X platform support and update CI (#12)

Add TL5218X (TL521X) SoC platform support to the Matter Telink
platform, including build configurations, flash overlays, packaging
scripts, and CI workflow updates.

Platform support:
- Add TL5218X platform config headers (CHIPDevicePlatformConfig.h,
  CHIPPlatformConfig.h, SystemPlatformConfig.h) with memory and
  thread stack size adjustments.
- Add flash overlays for 2MB and 4MB flash variants, including LZMA
  compression and backup overlays.
- Add FactoryDataParser/Provider updates and suppress sensitive DAC
  key/certificate debug logs to avoid leaking cryptographic material.

Build configurations:
- Add lighting-app and lock-app board configs for tl5218x and
  tl5218x_retention, including OTA, dual-mode OTA, and LZMA variants.
- Update config/telink Kconfig.defaults and CMakeLists.txt for
  TL5218X.
- Add README documentation for tl5218x lighting-app and retention
  builds.
- Note that tl5218x_retention porting is not complete

Build system:
- Update scripts/build/builders/telink.py and targets.py to
  recognize TL5218X build targets.
- Update package_telink_firmware.sh with TL5218X packaging support.
- Update update_zephyr.py to support Zephyr PR ref fetching.

CI:
- Update examples-telink.yaml with TL5218X build targets and BLE SDK
  revision (2488b5b8bd5122f68d087ba2cd5a8f0c74572b8f).
- Update Zephyr revision reference for TL521X builds.

Signed-off-by: Hao Wu <hao.wu@telink-semi.com>
Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>
Co-authored-by: Hao Wu <hao.wu@telink-semi.com>

* telink: add BLE/Thread concurrent mode and Channel Sounding reflector (#16)

Add support for running BLE concurrently with an active Thread network on
TL7218X and TL3238X, and integrate a Channel Sounding (CS) RAS reflector for
TL7218X.

Introduces CHIP_CONCURRENT_MODE Kconfig option that keeps the BLE controller
alive after Thread commissioning. Key additions:
- BLE idle mode and tl_dual_mode_start coordination for TLX RF coexistence
- CS reflector implementation (CsReflector) for TL7218X
- Concurrent board configs for TL3238X and TL7218X with README docs
- CI: bump Zephyr to 8e3ccc0, BLE SDK to 088fca4
- Disable Cirque workflow (otbr-agent/ot-rcp upstream mismatch)

Depends on Zephyr PR telink-semi/zephyr#789.
CI (examples-telink.yaml) passed.

---------

Signed-off-by: Hao Wu <hao.wu@telink-semi.com>
Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>
Co-authored-by: Hao Wu <hao.wu@telink-semi.com>
Co-authored-by: Restyled.io <commits@restyled.io>

* [telink] Update v1.2.0 release notes with latest build data, add TL521X and concurrent/CS targets (#21)

* docs(telink): update release notes for v1.2.0-alpha, clean up legacy platforms

- Update TL323X/TL721X resource usage tables with latest build data
- Add TL521X 4M flash dual-mode lighting-app data
- Add concurrent mode and concurrent+CS targets for TL323X/TL721X
- Remove legacy platforms (B91/B92/W91/TL321X) from all docs
- Rename build_and_update_matter_notes.py to generate_and_update_matter_notes.py
- Update README.md, README_BUILD_SCRIPT.md and release notes accordingly
- Restyled by prettier-markdown
- Restyled by ruff
- Restyled by isort
- fix py scripts
- update fetch ble sdk

---------

Signed-off-by: Hao Wu <hao.wu@telink-semi.com>
Co-authored-by: Restyled.io <commits@restyled.io>

* docs: telink: update release documentation for rc1 (#14)

* docs: telink: update release documentation

- add rc1 version draft

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* Restyled by prettier-markdown

* doc: remove doc content for all chips except TL323X and TL721X

README.md
docs/platforms/telink/releases/telink_release_notes.md
docs/platforms/telink/telink_getting_started.md

Signed-off-by: Hao Wu <hao.wu@telink-semi.com>

* doc: review the previous modifications.

Improve the logic of the getting-started and release_notes docs.
Improve the README content.

Signed-off-by: Laiyue Wang <laiyue.wang@telink-semi.com>

* doc: update release documentation

- minor changes

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* Restyled by prettier-markdown

* docs: update telink documents

- release note
- getting started guide

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* Restyled by prettier-markdown

---------

Follow-up fix
=============

Correct TL323X chip version from A0 to A0/A1 in the Telink release notes.

---------

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>
Signed-off-by: Hao Wu <hao.wu@telink-semi.com>
Signed-off-by: Laiyue Wang <laiyue.wang@telink-semi.com>
Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: Hao Wu <hao.wu@telink-semi.com>
Co-authored-by: Laiyue Wang <laiyue.wang@telink-semi.com>

* [Telink] Update Zephyr SDK references to tl_zephyr (#29)

* telink: update Zephyr SDK references to tl_zephyr

Prepare for the GitHub repo renames: update CI-critical
references (.github/workflows/examples-telink.yaml,
chip-build-telink Dockerfiles) and Telink documentation links
from telink-semi/zephyr to telink-semi/tl_zephyr.

Historical release notes (docs/platforms/telink/releases/) are
left unchanged (GitHub 301 redirects cover them)..

Also updates self references from telink-semi/connectedhomeip to
telink-semi/tl_matter.

* style: prettier-format markdown tables after repo rename

The zephyr -> tl_zephyr repository rename lengthened URLs in markdown
tables. Re-run prettier (same version and config as the Restyled
prettier-markdown restyler) on the markdown files touched by the rename
so table column widths are aligned again.

* workflows: update tl_zephyr and tl_ble_sdk

- update tl_zephyr from
6825a2f00ba6de9adce66f32f55c8b457c46948c
to
5cd959604f6ab5ff6af81c46b3a8b9324040f718
- update tl_ble_sdk from
53eb98b32ea79ed7ab38f5daabde0a78a7880cd9
to
9135c8eddb7caf72256c911b0ef113fb4037b1b4

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* telink: fix getting-started clone directory after tl_matter rename

Address CodeRabbit review feedback on the repo rename.

- docs/platforms/telink/telink_getting_started.md: clone tl_matter into
  the connectedhomeip directory so the subsequent
  cd connectedhomeip step keeps working after the repository rename.
- scripts/tools/telink/update_zephyr.py: make the remote argument
  optional nargs so its tl_zephyr default actually takes effect
  when the argument is omitted.

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

---------

Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>

* telink: update Zephyr revision for TL521x split (#47)

* telink: replace SOC_RISCV_TELINK_TLX with SOC_FAMILY_TELINK_TLX after Zephyr SoC family split

The Zephyr SoC family split (soc/telink/tlx) removed the legacy
SOC_RISCV_TELINK_TLX umbrella symbol and introduced SOC_FAMILY_TELINK_TLX,
which is selected by every TLX sub-series (TL321X/TL323X/TL521X/TL721X/TL5X).

Without this change, the build_mcuboot custom target was skipped on
all TLX-family SoCs when CONFIG_BOOTLOADER_MCUBOOT=y (e.g. OTA builds),
causing mcuboot.bin to be missing and the post-build merge step to fail
with FileNotFoundError. B91/B92 (TLSR family) were unaffected because
SOC_RISCV_TELINK_B9X was not renamed.

Files updated:
- config/telink/chip-module/CMakeLists.txt: guard build_mcuboot and
  process_binaries on SOC_FAMILY_TELINK_TLX
- config/telink/chip-module/Kconfig.defaults: BLE ctrl defaults block and
  TELINK_TLX_MBEDTLS_HW_ACCELERATION default

* telink: update Zephyr reference to dev-tlk_v4.1 branch

Switch the Zephyr revision used by the Telink examples workflow from
pull/802/head to the dev-tlk_v4.1 branch, which now contains the latest
commit of the TL521x SoC split and subsequent updates.

Tracking the dev-tlk_v4.1 branch keeps CI testing the latest Zephyr
changes until the next stable tag is cut.

---------

Signed-off-by: Hao Wu <hao.wu@telink-semi.com>

* [Telink] Enable APP_SET_DEVICE_INFO_PROVIDER for All Clusters Minimal (#40)

* [Telink] Enable APP_SET_DEVICE_INFO_PROVIDER for All Clusters Minimal Application example

* [Telink] Compile DFUOverSMP.cpp in chip-module for all applications

The air-quality-sensor-app failed to link on tlsr9528a_retention with
undefined references to DFUOverSMP symbols, because its CMakeLists.txt
lacked the DFUOverSMP.cpp source rule that other examples had.

Compile examples/platform/telink/util/src/DFUOverSMP.cpp in the common
Telink chip-module so that every application using AppTaskCommon.cpp
links DFU over SMP support automatically when CONFIG_MCUMGR_TRANSPORT_BT
is enabled, and drop the now-redundant per-application rules.

* Revert "[Telink] Compile DFUOverSMP.cpp in chip-module for all applications"

This reverts commit 76bd90a540aff3154e5af89a2554d10b13574681.

* [Telink] Use 4mb flash overlay for (B92) All Clusters Minimal App

* [Telink] Compile DFUOverSMP.cpp in chip-module for all applications

The air-quality-sensor-app failed to link on tlsr9528a_retention with
undefined references to DFUOverSMP symbols, because its CMakeLists.txt
lacked the DFUOverSMP.cpp source rule that other examples had.

Compile examples/platform/telink/util/src/DFUOverSMP.cpp in the common
Telink chip-module so that every application using AppTaskCommon.cpp
links DFU over SMP support automatically when CONFIG_MCUMGR_TRANSPORT_BT
is enabled, and drop the now-redundant per-application rules.

* fix typo

---------

Co-authored-by: Damien Ji <yinghao.ji@telink-semi.com>

* telink: update tl_zephyr revision for zigbee-to-matter switch (#51)

Update the tl_zephyr revision used by the Telink examples workflow from
d6a8aa968e5fb97c0b63e2b436aced9084614c65 to
e87fbee38775b103bd676f8412e6a9d651f08d6b (HEAD of the dev-tlk_v4.1
branch).

The new revision adds:
- soc: telink_tl521x: reset radio at boot for zigbee-to-matter switch
  (#836): add an RF reset sequence in soc_early_init_hook (only when PM
  and MCUboot are disabled) to support switching from Zigbee to Matter
  for lighting devices on TL521X, mirroring the existing telink_tl323x
  logic.

Signed-off-by: Hao Wu <hao.wu@telink-semi.com>

* docs: telink: finalize v1.4.0 release notes and docs (#50)

- Add the v1.4.0 release notes and update the landing page to the v1.4.0
  release, supporting TL521X (A0) with lighting-app only.
- Switch from the beta tag tl_v1.4.0-beta-v1.5 to the official
  tl_v1.4.0-v1.5 and set the release type to Release.
- Expand the README (EN and CN) with typical applications, support
  information, and contribution guidance sections.
- Rework the getting-started guide with updated prerequisites, build and
  flashing instructions, appendices, and FAQs.
- Update the tl_zephyr revision to ec302e9 and the BLE SDK to de6f125c.
- Update repo links from telink-semi/connectedhomeip to telink-semi/tl_matter.

---------

Signed-off-by: Hao Wu <hao.wu@telink-semi.com>
Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>
Co-authored-by: Damien Ji <yinghao.ji@telink-semi.com>
Co-authored-by: Restyled.io <commits@restyled.io>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix spellcheck & code-lints

* reduce number of builds for all PRs

* fix code-lints

* fix typo

* clean code

* fix builds

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix builds

* fix docs build

* remove partial secure programming

* remove todo

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add tl7218x_4m_flash_lzma.overlay

* update hashes

* fix builds

* fix builds

* fix builds

* fix w91 NET_RX_STACK_SIZE with PM

* extend boot_partition for tl7218 lzma target

* update Zephyr hash

* revert wrong changes

* [Telink] Update builds to docker version 214

* update tl3238x 2Mb LZMA flash layout

* fixes for tl3238x SoC

* [Telink] fixes after bot review

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Signed-off-by: Haiwen Xia <haiwen.xia@telink-semi.com>
Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>
Signed-off-by: Fengtai Xie <fengtai.xie@telink-semi.com>
Signed-off-by: Hao Wu <hao.wu@telink-semi.com>
Signed-off-by: Laiyue Wang <laiyue.wang@telink-semi.com>
Co-authored-by: haiwen.xia <haiwen.xia@telink-semi.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Damien Ji <yinghao.ji@telink-semi.com>
Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: Hao Wu <hao.wu@telink-semi.com>
Co-authored-by: Laiyue Wang <laiyue.wang@telink-semi.com>
106 files changed
tree: eac1e6a276adc3a983c72c0b2e9887985b250f0c
  1. .agents/
  2. .claude/
  3. .devcontainer/
  4. .gemini/
  5. .githooks/
  6. .github/
  7. .vscode/
  8. build/
  9. build_overrides/
  10. config/
  11. credentials/
  12. data_model/
  13. docs/
  14. examples/
  15. integrations/
  16. scripts/
  17. src/
  18. third_party/
  19. zzz_generated/
  20. .actrc
  21. .clang-format
  22. .clang-tidy
  23. .default-version.min
  24. .dir-locals.el
  25. .editorconfig
  26. .gitattributes
  27. .gitignore
  28. .gitmodules
  29. .gn
  30. .matterlint
  31. .mergify.yml
  32. .pre-commit-config.yaml
  33. .prettierrc.json
  34. .pullapprove.yml
  35. .restyled.yaml
  36. .shellcheck_tree
  37. .spellcheck.yml
  38. AGENTS.md
  39. BUILD.gn
  40. CODE_OF_CONDUCT.md
  41. CODEOWNERS
  42. CONTRIBUTING.md
  43. GEMINI.md
  44. gn_build.sh
  45. iwyu.imp
  46. kotlin-detect-config.yaml
  47. lgtm.yml
  48. LICENSE
  49. NOTICE
  50. pigweed.json
  51. pyproject.toml
  52. README.md
  53. REVIEWERS.md
  54. SECURITY.md
  55. SPECIFICATION_VERSION
README.md

Documentation links

Matter

Builds

Builds

Android Ameba ASR BouffaloLab Darwin TI CC26X2X7 TI CC32XX EFR32 ESP32 Infineon i.MX Linux NXP FreeRTOS/Zephyr Linux ARM Linux Standalone nRF Connect SDK QPG STM32 Telink Tizen

Tests

Tests-Master Tests-LTS Unit / Integration Tests Cirque QEMU Nightly Run

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.

Note: The applications under examples/ are reference implementations intended for development and testing. They are not production-ready and are not intended to be shipped as-is in a commercial product.

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 (not production-ready)
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.