Skip to content

Commit

Permalink
Pull request project-chip#1113: Cherry-pick Pull request project-chip…
Browse files Browse the repository at this point in the history
…#1098: Feature/2.2.0 1.2 alpha.1 doc update

Merge in WMN_TOOLS/matter from cp/doc_update to RC_2.2.0-1.2

Squashed commit of the following:

commit 60d2fb4fdc7851bae028bf75f1b49d34ec8c24d9
Author: Ezra Hale <ezra.hale@silabs.com>
Date:   Wed Aug 30 17:04:14 2023 +0000

    Pull request project-chip#1098: Feature/2.2.0 1.2 alpha.1 doc update

    Merge in WMN_TOOLS/matter from feature/2.2.0-1.2-alpha-doc-update to silabs

    Squashed commit of the following:

    commit 977b1e408f7e03b482aed250c0b1060cd97cdca2
    Author: Rehan Rasool <Rehan.Rasool@silabs.com>
    Date:   Wed Aug 30 14:29:21 2023 +0000

        Applied suggestion

    commit b31ea122a3c06b909eea477d6c1141e88ffee14b
    Author: KishorSilabs <kishor.rankhamb@silabs.com>
    Date:   Wed Aug 30 19:07:43 2023 +0530

        Applied suggestions

    commit 9ca85946f049c1ae291130b3d91833a8b06aabd8
    Author: KishorSilabs <kishor.rankhamb@silabs.com>
    Date:   Wed Aug 30 18:59:17 2023 +0530

        Modified doc

    ... and 20 more commits
  • Loading branch information
jmartinez-silabs committed Aug 30, 2023
1 parent c017696 commit 2d1ea41
Show file tree
Hide file tree
Showing 55 changed files with 831 additions and 355 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ Device: SiWx917 SoC
This repo contains documentation, demos, examples and all the code needed for Matter Accessory Device development on both Thread and Wi-Fi. The Thread development use cases differs from Wi-Fi because the Thread protocol requires the use of an Open Thread Border Router (OTBR).

- To get started with the Thread demo and development see
[Matter Thread](https://siliconlabs.github.io/matter/2.1.0-1.1/thread/DEMO_OVERVIEW.html)
[Matter Thread](https://siliconlabs.github.io/matter/2.2.0-1.2-alpha.1/thread/DEMO_OVERVIEW.html)
- To get started with the Wi-Fi demo and development see
[Matter Wi-Fi](https://siliconlabs.github.io/matter/2.1.0-1.1/wifi/DEMO_OVERVIEW.html)
[Matter Wi-Fi](https://siliconlabs.github.io/matter/2.2.0-1.2-alpha.1/wifi/DEMO_OVERVIEW.html)

The full documentation set starts here:
[Silicon Labs Matter GitHub Documentation](https://siliconlabs.github.io/matter/2.1.0-1.1)
[Silicon Labs Matter GitHub Documentation](https://siliconlabs.github.io/matter/2.2.0-1.2-alpha.1)

---

Expand Down
46 changes: 38 additions & 8 deletions docs/silabs/NEW_FEATURES.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,81 @@
# Silicon Labs Matter New Features

## New Features for v2.2.0-1.2-alpha.1

### Support for Intermittently Connected Devices (ICD)

- Full support for ICD Short idle time (SIT) Devices in support of the Matter 1.2 specification.
- In this release Silicon Labs has provided full support for Short Idle Time intermittently connected devices.
- These are ICDs (formerly called Sleepy End Devices) which must remain responsive to user input such as Door Locks and Window Coverings.
- ICD Management cluster server implementation
- Silicon Labs has provided an implementation of the ICD cluster server and the configuration of the ICD
- ICD Manager and ICD Event manager has been implemented to manage the Idle and Active mode of the ICD
- NEW DNS advertisement Text Key SAI: indicates the SLEEPY_ACTIVE_INTERVAL (default to 4000 ms when ICD is not enabled)
- NEW Matter ICD configuration defines:
- CHIP_CONFIG_ICD_IDLE_MODE_INTERVAL set value for the ICD IdleInterval attribute
- CHIP_CONFIG_ICD_ACTIVE_MODE_INTERVAL set value for the ICD ActiveInterval attribute
- CHIP_CONFIG_ICD_ACTIVE_MODE_THRESHOLD set value for the ICD ActiveThreshold attribute
- CHIP_CONFIG_ICD_CLIENTS_SUPPORTED_PER_FABRIC set value for the ICD ClientsSupportedPerFabric attribute
- All of these defines can be configured by our following build arguments (default values listed here)
- sl_idle_mode_interval_ms = 600000 `# 10min Idle Mode Interval`
- sl_active_mode_interval_ms = 1000 `# 1s Active Mode Interval`
- sl_active_mode_threshold_ms = 500 `# 500ms Active Mode Threshold`
- sl_icd_supported_clients_per_fabric = 2 `# 2 registration slots per fabric`
- The OpenThread polling rates used in either ICD mode can be configured with (default value listed here)
- sl_ot_idle_interval_ms = 15000 `# 15s Idle Intervals`
- sl_ot_active_interval_ms = 200 `# 200ms Active Intervals`

- CHANGES:
- Optimized the subscription reports by synchronizing all client’s subscriptions with the ICD idle mode interval. This ensures the minimal amount of wake ups possible due to subscription reports
- The previous `--sed` build preset has been replaced by `--icd`. This goes in line with previous sleepy end device behavior being deprecated and replaced by the ICD behavior.
- Silicon Labs' Light Switch and Door Lock apps support the ICD implementation and have the ICD cluster enabled. To build those apps as ICDs, use the aforementioned prefix `--icd` in your usual build command.
- e.g.: `./scripts/examples/gn_silabs_example.sh ./examples/light-switch-app/silabs/efr32/ ./out/light-switch-app_ICD BRD4187C --icd`
## New Features for v2.1.0-1.1
- ### Update to GSDK Version 4.2.3

The GSDK Version 4.2.3 includes important security enhancements for the Open Thread Stack which in turn updates all Matter over Thread implementations.

## New Features for v2.0.0-1.1

## Matter Intermittently Connected Devices (ICD / Sleepy) Improvements
- ### Expose the API for a device to change the max interval in a subscription request
### Matter Intermittently Connected Devices (ICD / Sleepy) Improvements
- #### Expose the API for a device to change the max interval in a subscription request
A device can, when accepting a subscription request, change the maximum reporting interval for it to match with its idle time instead of accepting the requested intervals.
When not using this API, the ICDs idle time interval could functionally be shortened by a controller without the ICD being able to refuse the subscription.

For more details see the [Matter Intermittently Connected Devices](./general/MATTER_ICD.md) section.

- ### Persistent Subscription
- #### Persistent Subscription
The device will persist a subscription to be able to recover its subscription with a subscriber in case of a reboot.

For more details see the [Matter Intermittently Connected Devices](./general/MATTER_ICD.md) section.

- ### During the commissioning flow, the device will not be able to go to idle mode until the commissioning is complete.
- #### During the commissioning flow, the device will not be able to go to idle mode until the commissioning is complete.
Before, the thread devices would go to idle mode right after completing its srp registration but before the sigma1 message was received.
With 1.1, devices will remain in Active Mode until the commissioning is complete.

- ### Adding the Active Mode Threshold feature.
- #### Adding the Active Mode Threshold feature.
When a thread ICD goes from Idle Mode to Active Mode, the ICD will stay in Active Mode for a defined amount before going back to Idle Mode.
The timer starts after the last communication.
For this feature to take affect, there needs to be at least one message coming in or going out. If the device just polls its thread router and nothing else happens, this doesn't come into play.

For more details see the [Openthread Sleepy End Device](./general/OT_SLEEPY_END_DEVICE.md) section.

## Matter Sleepy End Devices over Wi-Fi
### Matter Sleepy End Devices over Wi-Fi

- A Matter Sleepy End Device is a device where the EFR32 along with the Wi-Fi coprocessor go into sleep mode during idle time resulting in less power consumption. This helps devices running on limited power sources like battery powered devices.
The EFR32 goes into sleep mode whenever the device is idle. The Wi-Fi coprocessor goes into Power Save (PS) Poll legacy power save mode where it wakes for every Delivery Traffic Information Map (DTIM) interval to check for any packets.

For more details see the [Wi-Fi Sleepy End Device](wifi/WIFI_SLEEPY_END_DEVICE.md) section.

## Added support for CMPS (Custom Part Manufacturing Service)
### Added support for CMPS (Custom Part Manufacturing Service)

- The new provisioning script allows easy setup of factory data in Matter devices. This tool provides a common architecture for use both in development and production environments, which allows easy deployment of the developed products.

The provisioning script may be used to set all factory settings, including Discriminator, Passcode, and the attestation credentials (PAI, DAC and CD).

The provision/provision.py tool supersedes the silabs_example/credentials/creds.py script.

## Matter Wi-Fi Direct Internet Connectivity
### Matter Wi-Fi Direct Internet Connectivity

- The Matter Wi-Fi Direct Internet Connectivity (DIC) solution connects to proprietary cloud solutions for direct access to software downloads, to device controls, or to aggregate statistics on where and how the device is being used.

Expand Down
10 changes: 4 additions & 6 deletions docs/silabs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,10 @@
1. [Matter Wi-Fi Demo Overview](wifi/DEMO_OVERVIEW.md)
2. [Building a Matter Wi-Fi End Device](wifi/SW_SETUP.md)
3. [Running the Matter Demo on EFR32 hosts](wifi/RUN_DEMO.md)
4. [Ozone Environment Setup for the SiWx917 SoC](wifi/SiWx917_Enablement_For_Ozone.md)
5. [Flashing the SiWx917 SoC](general/FLASH_SILABS_SiWx917_SOC_DEVICE.md)
6. [Running the Matter Demo on SiWx917 SoC](wifi/RUN_DEMO_SiWx917_SoC.md)
7. [Matter Wi-Fi Sleepy End Devices](wifi/WIFI_SLEEPY_END_DEVICE.md)
8. [Matter Wi-Fi Sleepy End Device Power Measurement](wifi/WIFI_Sleepy_Device_Power_Measurement.md)
9. [Matter Wi-Fi Direct Internet Connectivity(DIC)](wifi/DIC_Wi-Fi.md)
4. [Running the Matter Demo on SiWx917 SoC](wifi/RUN_DEMO_SiWx917_SoC.md)
5. [Matter Wi-Fi Sleepy End Devices](wifi/WIFI_SLEEPY_END_DEVICE.md)
6. [Matter Wi-Fi Sleepy End Device Power Measurement](wifi/WIFI_Sleepy_Device_Power_Measurement.md)
7. [Matter Wi-Fi Direct Internet Connectivity(DIC)](wifi/DIC_Wi-Fi.md)

6. Matter Bridging to Zigbee/Z-Wave

Expand Down
4 changes: 2 additions & 2 deletions docs/silabs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
project = 'Matter'
copyright = 'Copyright © 2023 Silicon Laboratories. All rights reserved.'
author = 'Silicon Labs'
release = '2.1.0-1.1'
version = '2.1.0-1.1'
release = '2.2.0-1.2-alpha.1'
version = '2.2.0-1.2-alpha.1'


# -- General configuration ---------------------------------------------------
Expand Down
45 changes: 32 additions & 13 deletions docs/silabs/general/ARTIFACTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Matter chip-tool. Note the image is ~10GB in size so depending on your internet
connection this download may take some time. Start the Matter Hub Raspberry Pi
image download here:

https://www.silabs.com/documents/public/software/SilabsMatterPi_2.0.0-1.1.zip
https://www.silabs.com/documents/public/software/SilabsMatterPi_2.2.0-1.2-alpha.1.zip

## Radio Co-Processor (RCP) Images

Expand All @@ -20,15 +20,15 @@ used with a Raspberry Pi to allow the Raspberry Pi's Open Thread Border Router
to access the Thread network. Radio Co-Processor (RCP) images are available in
the Assets section of this page:

https://github.com/SiliconLabs/matter/releases/tag/v2.1.0-1.1
https://github.com/SiliconLabs/matter/releases/tag/v2.2.0-1.2-alpha.1

## Matter Accessory Device Images

The Matter Accessory Device Images are used to turn an EFR into a Matter device.
These are pre-built binary images for the Matter Demo. Matter Accessory Device
Images are located in the Assets section of this page:

https://github.com/SiliconLabs/matter/releases/tag/v2.1.0-1.1
https://github.com/SiliconLabs/matter/releases/tag/v2.2.0-1.2-alpha.1

For Matter over Thread, 3 different types of images are provided:

Expand All @@ -43,21 +43,40 @@ EFR32MG2x device, you will need to flash a bootloader binary on your device alon
with the application image. Bootloader binaries for all of the Matter supported
devices are available here:

https://github.com/SiliconLabs/matter/releases/tag/v2.1.0-1.1
https://github.com/SiliconLabs/matter/releases/tag/v2.2.0-1.2-alpha.1

## RS9116 Firmware

The RS9116 firmware is used to update the RS9116 - it can be found in the
repository you have cloned, at the following relative path from the `/matter`
directory, `./third_party/silabs/wiseconnect-wifi-bt-sdk/firmware`
The RS9116 firmware (rs9116_firmware_files_with_rev.zip) is used to update the RS9116 which can be found in the Assets section of this page:

## SiWx917 Firmware
https://github.com/SiliconLabs/matter/releases/tag/v2.2.0-1.2-alpha.1

> **Note**: SiWx917 firmware is only available to Alpha customers. Contact Silicon Labs support to obtain the WiseMCU SDK and install it as per the instructions on the [Software Requirements page](./SOFTWARE_REQUIREMENTS.md).
**Note**:
RS9116 chip/module needs to be flashed with proper firmware as mentioned below:
- `RS916.x.x.x.x.x.rps - This firmware image is valid for RS9116 1.5 revision chip/module`
- `RS9116.x.x.x.x.x.rps - This firmware image is valid for RS9116 1.4/1.3 revision chip/module`

The SiWx917 firmware is used to update the SiWx917 device connectivity firmware. It can be found in the
repository you have cloned, at the following relative path from the `/matter`
directory, `./third_party/silabs/wisemcu-wifi-bt-sdk/connectivity_firmware`
## SiWx917 Firmware for SiWx917 NCP

The SiWx917 firmware(SiWx917NCP_firmware_files.zip) is used to update the SiWx917 NCP which can be found in the Assets section of this page:

https://github.com/SiliconLabs/matter/releases/tag/v2.2.0-1.2-alpha.1

**Note**:
SiWx917 NCP board need to be flashed with proper firmware as mentioned below:
- ``SiWG917-A.2.9.X.X.X.rps - This firmware image is valid for BRD8036A (A0 Expansion v1.1) board`


## SiWx917 Firmware for SiWx917 SoC

The SiWx917 firmware (SiWx917SOC_firmware_files.zip) along with WiSeConnect 3 SDK is used to update the SiWx917 SoC which can be found in the Assets section of this page:

https://github.com/SiliconLabs/matter/releases/tag/v2.2.0-1.2-alpha.1

**Note**:
SiWx917 SoC boards need to be flashed with proper firmware as mentioned below:
- `SiWG917-A.2.9.X.X.X.rps - This firmware image is valid for BRD4325B(A0 dual flash 1.2) board`
- `SiWG917-B.2.9.X.X.X.rps - This firmware image is valid for BRD4325C(B0 common flash v1.2) board`

## SiWx917 SoC Configuration Files for Flashing the Matter Application

Expand All @@ -67,4 +86,4 @@ be configured for the SiWx917 SoC device by following the instructions on the [O
The **JLinkDevices.xml** and **ELF** files referenced in the instructions may be found
in the Assets section of this page:

https://github.com/SiliconLabs/matter/releases/tag/v2.1.0-1.1
https://github.com/SiliconLabs/matter/releases/tag/v2.2.0-1.2-alpha.1
2 changes: 1 addition & 1 deletion docs/silabs/general/COMMISSIONING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Commissioning
# Matter Commissioning

## Overview

Expand Down
6 changes: 3 additions & 3 deletions docs/silabs/general/COMMIT_HASHES.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ in this release of the Silicon Labs Matter Out of Box Experience

| Repo | Branch | Commit Hash |
| ------------------------------------------ | ------ | ---------------------------------------- |
| https://github.com/SiliconLabs/ot-br-posix | main | 1813352247aa60fb8993773918f1e5b4af6f3b79 |
| https://github.com/SiliconLabs/ot-br-posix | main | bb565ca0164981f58a2659222c30917399703a9b |

## Radio Co-Processor (RCP)

| Repo | Branch | Commit Hash |
| --------------------------------------- | ------ | ---------------------------------------- |
| https://github.com/SiliconLabs/ot-efr32 | main | 7a567da02a078546eb34136c1c44170c8832dd55 |
| https://github.com/SiliconLabs/ot-efr32 | main | 3528d4bba47743a5367a822e350aaccb04698542 |

## Connectivity Standards Alliance (CSA) connectedhomeip (Matter)

| Repo | Branch | Commit Hash |
| ----------------------------------------------- | ------ | ---------------------------------------- |
| https://github.com/project-chip/connectedhomeip | v1.1-branch | 8f66f4215bc0708efc8cc73bda80620e67d8955f |
| https://github.com/project-chip/connectedhomeip | master | 684b9d6246e5e5ef33db589af61a30e224d61ee3 |

## Matter chip-tool

Expand Down
Loading

0 comments on commit 2d1ea41

Please sign in to comment.