From 9b79757cc058afe80b399add8b91443a788bb98f Mon Sep 17 00:00:00 2001 From: Curtis Rahman Date: Wed, 17 Jan 2024 19:20:55 +0000 Subject: [PATCH] Pull request #1502: [Documentation] Further SMG Release Documentation Cleanup Merge in WMN_TOOLS/matter from documentation/doc_cleanup to silabs Squashed commit of the following: commit 60015ce5e7e6463c9ae6bace17c0a693f9008d01 Author: Curtis Rahman Date: Wed Jan 17 14:09:43 2024 -0500 Further doc cleanup --- docs/silabs/general/ARTIFACTS.md | 4 ++-- docs/silabs/general/COMMISSIONING.md | 2 +- docs/silabs/general/FLASH_SILABS_SiWx917_SOC_DEVICE.md | 2 +- docs/silabs/general/MATTER_ICD.md | 4 ++-- docs/silabs/general/SOFTWARE_REQUIREMENTS.md | 2 +- docs/silabs/thread/OT_SLEEPY_END_DEVICE.md | 2 +- docs/silabs/wifi/SW_SETUP.md | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/silabs/general/ARTIFACTS.md b/docs/silabs/general/ARTIFACTS.md index 556acf89aa1a7a..6ca5fbbf11bad3 100644 --- a/docs/silabs/general/ARTIFACTS.md +++ b/docs/silabs/general/ARTIFACTS.md @@ -85,8 +85,8 @@ SiWx917 SoC boards need to be flashed with proper firmware as mentioned below: ## SiWx917 SoC Configuration Files For JLink RTT Logging -In order to check device logs for the Matter Application on the SiWx917 SoC, the **JLink RTT** must be configured for the SiWx917 SoC device by following the instructions on the [JLink RTT SOC Support](../wifi/JLINK_GUIDE_917.md) for SiWx917 SoC. +In order to check device logs for the Matter Application on the SiWx917 SoC, the **JLink RTT** must be configured for the SiWx917 SoC device by following the instructions on the [JLink RTT SOC Support](../wifi/JLINK_GUIDE_917.md). The [JLinkDevices.xml](https://github.com/SiliconLabs/matter/releases/download/v2.3.0-1.3-alpha.1/JLinkDevices.xml) and **.elf** files referenced in the instructions may be found in the Assets section of this page. -**Note**:- For EFR32MG2x devices, JLink RTT Logging support is already enabled. +**Note**:- For EFR32MG2x devices, JLink RTT Logging support is already available. diff --git a/docs/silabs/general/COMMISSIONING.md b/docs/silabs/general/COMMISSIONING.md index 73145706b3ccc4..3c0842cb652fe8 100644 --- a/docs/silabs/general/COMMISSIONING.md +++ b/docs/silabs/general/COMMISSIONING.md @@ -10,7 +10,7 @@ The commissioning process supports two potential starting points: The current Matter revision supports Ethernet, Wi-Fi, and Thread devices. - Ethernet devices get into the operational network when their Ethernet cable is connected. Therefore the devices are normally already on the network before commissioning. -- Wi-Fi and Thread devices must have credentials configured before the devices can be joined into the operational network. This is normally done over BLE. +- Wi-Fi and Thread devices must have credentials configured before the devices join into the operational network. This is normally done over BLE. This page focuses on Wi-Fi and Thread. The first step for these devices is to enter commissioning mode, following one of two scenarios: diff --git a/docs/silabs/general/FLASH_SILABS_SiWx917_SOC_DEVICE.md b/docs/silabs/general/FLASH_SILABS_SiWx917_SOC_DEVICE.md index 7614866e5c5eee..7290b31451ab7e 100644 --- a/docs/silabs/general/FLASH_SILABS_SiWx917_SOC_DEVICE.md +++ b/docs/silabs/general/FLASH_SILABS_SiWx917_SOC_DEVICE.md @@ -9,7 +9,7 @@ Links to download Simplicity Commander's standalone versions are included below. - Mac: https://www.silabs.com/documents/public/software/SimplicityCommander-Mac.zip - Windows: https://www.silabs.com/documents/public/software/SimplicityCommander-Windows.zip -To Flash the bootloader and Binaries, refer [Flashing using Commander](./FLASHING_USING_COMMANDER.md) +To Flash the bootloader and binaries, refer to the [Flashing using Commander](./FLASHING_USING_COMMANDER.md) guide. ## (Optional) J-Link RTT for Logging: Multi-platform Logging software for device logs. Links to download J-Link RTT for logging are included below diff --git a/docs/silabs/general/MATTER_ICD.md b/docs/silabs/general/MATTER_ICD.md index 053ee662a45aad..40ca2ce4aa0f91 100644 --- a/docs/silabs/general/MATTER_ICD.md +++ b/docs/silabs/general/MATTER_ICD.md @@ -229,13 +229,13 @@ Persistent subscriptions are enabled by default on all Silicon Labs sample appli ### Subscription Timeout Resumption -Matter also provides a retry mechanism for devices to try to re-establish a lost subscription with a client. This feature should not be used on an ICD since it can significantly reduce battery life. This functionality is provided by enabling +Matter also provides a retry mechanism for devices to try to re-establish a lost subscription with a client. This feature should not be used on an ICD since it can significantly reduce battery life. This functionality can be disabled by adding `chip_subscription_timeout_resumption = false` ## Subscription Synchronization -To avoid forcing an ICD to become active multiple times, the Matter SDK allows an ICD to synchronize its subscription reporting and send all the reports at the same time. The mecansim syncrhonizes the maximum interval of the all subscription to only require the ICD to become active one. This functionality is provided by enabling +To avoid forcing an ICD to become active multiple times, the Matter SDK allows an ICD to synchronize its subscription reporting and send all the reports at the same time. The mecansim syncrhonizes the maximum interval of the all subscription to only require the ICD to become active one. This functionality can be enabled by adding `sl_use_subscription_synching = true` diff --git a/docs/silabs/general/SOFTWARE_REQUIREMENTS.md b/docs/silabs/general/SOFTWARE_REQUIREMENTS.md index aea90b5b3b8740..4040ab8f934ead 100644 --- a/docs/silabs/general/SOFTWARE_REQUIREMENTS.md +++ b/docs/silabs/general/SOFTWARE_REQUIREMENTS.md @@ -145,7 +145,7 @@ $ sudo apt-get install git gcc g++ pkg-config libssl-dev libdbus-1-dev libglib2. ### Software Packages Required for Wi-Fi EFR32 NCP Devices -1. GeckoSDK package. +1. Gecko SDK package. 2. WiseConnect SDK v2.x for RS9116 NCP. 3. Wiseconnect SDK v3.x for SiWx917 NCP. 4. [Firmware for RS9116 NCP](../general/ARTIFACTS.md#rs9116-firmware) diff --git a/docs/silabs/thread/OT_SLEEPY_END_DEVICE.md b/docs/silabs/thread/OT_SLEEPY_END_DEVICE.md index 14bf36d4d3b98a..227044961044a7 100644 --- a/docs/silabs/thread/OT_SLEEPY_END_DEVICE.md +++ b/docs/silabs/thread/OT_SLEEPY_END_DEVICE.md @@ -8,7 +8,7 @@ Matter provides an Intermittently Connected Device (ICD) operating mode to exten The Matter ICD manager leverages subscription report synchronization and OpenThread functionalities to allow devices to sleep for set periods without disrupting their Matter sessions. -In Matter v1.2 only ICD's with Short Idle Time (SIT) is supported. Matter 1.3 alpha provides provisional support for Long Idle Time (LIT) ICD's. A SIT ICD are devices that SHOULD be configured with a Slow Polling Interval shorter than or equal to 15 seconds. For example, in a typical scenario for door locks and window coverings, commands need to be sent to the ICD with a use-case imposed latency requirement. Typically, devices that are Short Idle Time ICDs are not initiators in the communication flow. +In Matter v1.2, only ICD's with Short Idle Time (SIT) are supported. Matter 1.3 alpha provides provisional support for Long Idle Time (LIT) ICD's. A SIT ICD are devices that SHOULD be configured with a Slow Polling Interval shorter than or equal to 15 seconds. For example, in a typical scenario for door locks and window coverings, commands need to be sent to the ICD with a use-case imposed latency requirement. Typically, devices that are Short Idle Time ICDs are not initiators in the communication flow. ## Operating Modes diff --git a/docs/silabs/wifi/SW_SETUP.md b/docs/silabs/wifi/SW_SETUP.md index da44d06f432daa..a58a08f4ec73ee 100644 --- a/docs/silabs/wifi/SW_SETUP.md +++ b/docs/silabs/wifi/SW_SETUP.md @@ -158,5 +158,5 @@ Navigate to If having issues building the above examples, users may need to run the following commands: - git submodule update --init --recursive --checkout + git submodule update --init --checkout pip install --upgrade prompt-toolkit