From 74690bfc3fa7cb34b0599917100c09b70eeedbd7 Mon Sep 17 00:00:00 2001 From: Hrishikesh Dhayagude Date: Sun, 12 Jun 2022 17:11:38 +0530 Subject: [PATCH] Update the release notes and the top-level README.md --- README.md | 27 ++++++++++++++++++++++++++- RELEASE_NOTES.txt | 20 ++++++++++---------- docs/en/introduction.rst | 1 + 3 files changed, 37 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3aebcbecb..b5cf14a46 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # ESP Matter -See the [docs](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/index.html) for more information. +## Introduction + +ESP Matter is the official Matter development framework for Espressif’s ESP32 series SoCs. It is built on top of the [open source Matter SDK] (https://github.com/project-chip/connectedhomeip/), and provides simplified APIs, commonly used peripherals, tools and utilities for security, manufacturing and production accompanied by exhaustive documentation. It includes rich production references, aimed to simplify the development process of Matter products and enable the users to go to production in the shortest possible time. + + +## Get ESP Matter + +Please clone this repository using the below command: + +``` +git clone --recursive https://github.com/espressif/esp-matter.git +``` + +> Note the --recursive option. This is required to pull in the various dependencies into esp-matter. In case you have already cloned the repository without this option, execute this to pull in the submodules: `git submodule update --init --recursive` + + +## Supported ESP-IDF and connectedhomeip versions + +ESP Matter currently works with[TE9 tag] (https://github.com/project-chip/connectedhomeip/releases/tag/TE9) of connectedhomeip. +For Wi-Fi devices (ESP32, ESP32-C3, ESP32-S3), ESP-IDF[v4.4.1 release] (https://github.com/espressif/esp-idf/releases/tag/v4.4.1) is required. +For Thread devices (ESP32-H2), ESP-IDF master branch at [commit 047903c] (https://github.com/espressif/esp-idf/commit/047903c) should be used. + + +### Documentation Build Status + +[![Documentation Status](https://readthedocs.com/projects/espressif-esp-matter/badge/?version=latest)](https://docs.espressif.com/projects/esp-matter/en/latest/) diff --git a/RELEASE_NOTES.txt b/RELEASE_NOTES.txt index 3075608a3..207a81dd6 100644 --- a/RELEASE_NOTES.txt +++ b/RELEASE_NOTES.txt @@ -1,10 +1,11 @@ -Version 0.8 -=========== +# 14-June-2022 + +First Github release of ESP Matter Features -------- - - Aligns to Matter Test Event 9 and ESP-IDF v4.4.1 - - ESP Matter Data Model - Intuitive, simple and dynamic + - Aligns to Matter Test Event 9 and ESP-IDF v4.4.1. + - ESP Matter Data Model - Intuitive, simple and dynamic. - Utility device types supported: Root Node OTA Requestor @@ -32,13 +33,12 @@ Features HVAC Thermostat Fan - - Mass manufacturing tool that generates manufacturing NVS partition image and onboarding codes - - RainMaker integration - - Zigbee to Matter and BLE Mesh to Matter Bridge + - Mass manufacturing tool that generates manufacturing NVS partition image and onboarding codes. + - RainMaker integration. + - Zigbee to Matter and BLE Mesh to Matter Bridge. Known Issues ------------ - - Device disconnects and reconnects to Wi-Fi after BLE deinit, post commissioning - - BLE memory is not freed if the device has already been commissioned on bootup + - BLE memory is not freed if the device has already been commissioned on bootup. - Host-based chip-tool shows the following error during commissioning/cluster control, but the functionality works fine: - CHIP Error 0x00000070: Unsolicited msg with originator bit clear + CHIP Error 0x00000070: Unsolicited msg with originator bit clear. diff --git a/docs/en/introduction.rst b/docs/en/introduction.rst index 29e5951d5..5145d1618 100644 --- a/docs/en/introduction.rst +++ b/docs/en/introduction.rst @@ -58,4 +58,5 @@ If you want to test Matter on Espressif devices without any additional setup: |Try it with Launchpad|_ .. |Try it with Launchpad| image:: ../_static/launchpad.png + :scale: 50 % .. _Try it with Launchpad: https://espressif.github.io/esp-launchpad/