Skip to content

Commit 2334eb4

Browse files
committed
fix(pre-commit): Fix spelling
1 parent 2d7f20c commit 2334eb4

File tree

21 files changed

+284
-282
lines changed

21 files changed

+284
-282
lines changed

libraries/Matter/examples/MatterColorLight/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The application showcases Matter commissioning, device control via smart home ec
55

66
## Supported Targets
77

8-
| SoC | WiFi | Thread | BLE Commissioning | RGB LED | Status |
8+
| SoC | Wi-Fi | Thread | BLE Commissioning | RGB LED | Status |
99
| --- | ---- | ------ | ----------------- | ------- | ------ |
1010
| ESP32 |||| Required | Fully supported |
1111
| ESP32-S2 |||| Required | Fully supported |
@@ -17,14 +17,14 @@ The application showcases Matter commissioning, device control via smart home ec
1717

1818
### Note on Commissioning:
1919

20-
- **ESP32 & ESP32-S2** do not support commissioning over Bluetooth LE. For these chips, you must provide WiFi credentials directly in the sketch code so they can connect to your network manually.
21-
- **ESP32-C6** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using WiFi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter WiFi station feature.
22-
- **ESP32-C5** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using WiFi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter WiFi station feature.
20+
- **ESP32 & ESP32-S2** do not support commissioning over Bluetooth LE. For these chips, you must provide Wi-Fi credentials directly in the sketch code so they can connect to your network manually.
21+
- **ESP32-C6** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
22+
- **ESP32-C5** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
2323

2424
## Features
2525

2626
- Matter protocol implementation for a color light device
27-
- Support for both WiFi and Thread(*) connectivity
27+
- Support for both Wi-Fi and Thread(*) connectivity
2828
- RGB color control with HSV color model
2929
- State persistence using `Preferences` library
3030
- Button control for toggling light and factory reset
@@ -52,16 +52,16 @@ The application showcases Matter commissioning, device control via smart home ec
5252
3. ESP32 Arduino libraries:
5353
- `Matter`
5454
- `Preferences`
55-
- `WiFi` (only for ESP32 and ESP32-S2)
55+
- `Wi-Fi` (only for ESP32 and ESP32-S2)
5656

5757
### Configuration
5858

5959
Before uploading the sketch, configure the following:
6060

61-
1. **WiFi credentials** (if not using BLE commissioning - mandatory for ESP32 | ESP32-S2):
61+
1. **Wi-Fi credentials** (if not using BLE commissioning - mandatory for ESP32 | ESP32-S2):
6262
```cpp
63-
const char *ssid = "your-ssid"; // Change to your WiFi SSID
64-
const char *password = "your-password"; // Change to your WiFi password
63+
const char *ssid = "your-ssid"; // Change to your Wi-Fi SSID
64+
const char *password = "your-password"; // Change to your Wi-Fi password
6565
```
6666

6767
2. **LED pin configuration** (if not using built-in RGB LED):
@@ -83,12 +83,12 @@ Before uploading the sketch, configure the following:
8383

8484
## Expected Output
8585

86-
Once the sketch is running, open the Serial Monitor at a baud rate of **115200**. The WiFi connection messages will be displayed only for ESP32 and ESP32-S2. Other targets will use Matter CHIPoBLE to automatically setup the IP Network. You should see output similar to the following, which provides the necessary information for commissioning:
86+
Once the sketch is running, open the Serial Monitor at a baud rate of **115200**. The Wi-Fi connection messages will be displayed only for ESP32 and ESP32-S2. Other targets will use Matter CHIPoBLE to automatically setup the IP Network. You should see output similar to the following, which provides the necessary information for commissioning:
8787

8888
```
8989
Connecting to your-wifi-ssid
9090
.......
91-
WiFi connected
91+
Wi-Fi connected
9292
IP address: 192.168.1.100
9393

9494
Matter Node is not commissioned yet.
@@ -145,7 +145,7 @@ Use a Matter-compatible hub (like an Apple HomePod, Google Nest Hub, or Amazon E
145145
146146
The MatterColorLight example consists of the following main components:
147147
148-
1. **`setup()`**: Initializes hardware (button, LED), configures WiFi (if needed), sets up the Matter endpoint, restores the last known state from `Preferences`, and registers callbacks for state changes.
148+
1. **`setup()`**: Initializes hardware (button, LED), configures Wi-Fi (if needed), sets up the Matter endpoint, restores the last known state from `Preferences`, and registers callbacks for state changes.
149149
2. **`loop()`**: Checks the Matter commissioning state, handles button input for toggling the light and factory reset, and allows the Matter stack to process events.
150150
3. **Callbacks**:
151151
- `setLightState()`: Controls the physical RGB LED.
@@ -154,7 +154,7 @@ The MatterColorLight example consists of the following main components:
154154
155155
## Troubleshooting
156156
157-
- **Device not visible during commissioning**: Ensure WiFi or Thread connectivity is properly configured
157+
- **Device not visible during commissioning**: Ensure Wi-Fi or Thread connectivity is properly configured
158158
- **RGB LED not responding**: Verify pin configurations and connections
159159
- **Failed to commission**: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
160160
- **No serial output**: Check baudrate (115200) and USB connection

libraries/Matter/examples/MatterCommissionTest/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The application showcases Matter commissioning, device connection to smart home
55

66
## Supported Targets
77

8-
| SoC | WiFi | Thread | BLE Commissioning | Status |
8+
| SoC | Wi-Fi | Thread | BLE Commissioning | Status |
99
| --- | ---- | ------ | ----------------- | ------ |
1010
| ESP32 |||| Fully supported |
1111
| ESP32-S2 |||| Fully supported |
@@ -17,14 +17,14 @@ The application showcases Matter commissioning, device connection to smart home
1717

1818
### Note on Commissioning:
1919

20-
- **ESP32 & ESP32-S2** do not support commissioning over Bluetooth LE. For these chips, you must provide WiFi credentials directly in the sketch code so they can connect to your network manually.
21-
- **ESP32-C6** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using WiFi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter WiFi station feature.
22-
- **ESP32-C5** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using WiFi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter WiFi station feature.
20+
- **ESP32 & ESP32-S2** do not support commissioning over Bluetooth LE. For these chips, you must provide Wi-Fi credentials directly in the sketch code so they can connect to your network manually.
21+
- **ESP32-C6** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
22+
- **ESP32-C5** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
2323

2424
## Features
2525

2626
- Matter protocol implementation for an on/off light device
27-
- Support for both WiFi and Thread(*) connectivity
27+
- Support for both Wi-Fi and Thread(*) connectivity
2828
- Matter commissioning via QR code or manual pairing code
2929
- Automatic decommissioning after 30 seconds for continuous testing
3030
- Integration with Apple HomeKit, Amazon Alexa, and Google Home
@@ -43,16 +43,16 @@ The application showcases Matter commissioning, device connection to smart home
4343
2. Install ESP32 Arduino Core with Matter support
4444
3. ESP32 Arduino libraries:
4545
- `Matter`
46-
- `WiFi` (only for ESP32 and ESP32-S2)
46+
- `Wi-Fi` (only for ESP32 and ESP32-S2)
4747

4848
### Configuration
4949

5050
Before uploading the sketch, configure the following:
5151

52-
1. **WiFi credentials** (if not using BLE commissioning - mandatory for ESP32 | ESP32-S2):
52+
1. **Wi-Fi credentials** (if not using BLE commissioning - mandatory for ESP32 | ESP32-S2):
5353
```cpp
54-
const char *ssid = "your-ssid"; // Change to your WiFi SSID
55-
const char *password = "your-password"; // Change to your WiFi password
54+
const char *ssid = "your-ssid"; // Change to your Wi-Fi SSID
55+
const char *password = "your-password"; // Change to your Wi-Fi password
5656
```
5757

5858
## Building and Flashing
@@ -64,12 +64,12 @@ Before uploading the sketch, configure the following:
6464

6565
## Expected Output
6666

67-
Once the sketch is running, open the Serial Monitor at a baud rate of **115200**. The WiFi connection messages will be displayed only for ESP32 and ESP32-S2. Other targets will use Matter CHIPoBLE to automatically setup the IP Network. You should see output similar to the following, which provides the necessary information for commissioning:
67+
Once the sketch is running, open the Serial Monitor at a baud rate of **115200**. The Wi-Fi connection messages will be displayed only for ESP32 and ESP32-S2. Other targets will use Matter CHIPoBLE to automatically setup the IP Network. You should see output similar to the following, which provides the necessary information for commissioning:
6868

6969
```
7070
Connecting to your-wifi-ssid
7171
.......
72-
WiFi connected
72+
Wi-Fi connected
7373
IP address: 192.168.1.100
7474
7575
Matter Node is not commissioned yet.
@@ -136,12 +136,12 @@ Use a Matter-compatible hub (like an Apple HomePod, Google Nest Hub, or Amazon E
136136

137137
The MatterCommissionTest example consists of the following main components:
138138

139-
1. **`setup()`**: Configures WiFi (if needed), initializes the Matter On/Off Light endpoint, and starts the Matter stack.
139+
1. **`setup()`**: Configures Wi-Fi (if needed), initializes the Matter On/Off Light endpoint, and starts the Matter stack.
140140
2. **`loop()`**: Checks the Matter commissioning state, displays pairing information when not commissioned, waits for commissioning, and then automatically decommissions after 30 seconds to repeat the cycle.
141141

142142
## Troubleshooting
143143

144-
- **Device not visible during commissioning**: Ensure WiFi or Thread connectivity is properly configured
144+
- **Device not visible during commissioning**: Ensure Wi-Fi or Thread connectivity is properly configured
145145
- **Failed to commission**: Try waiting for the next cycle after decommissioning. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
146146
- **No serial output**: Check baudrate (115200) and USB connection
147147
- **Device keeps decommissioning**: This is expected behavior - the device automatically decommissions after 30 seconds to allow continuous testing

libraries/Matter/examples/MatterComposedLights/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The application showcases Matter commissioning, a single Matter node containing
55

66
## Supported Targets
77

8-
| SoC | WiFi | Thread | BLE Commissioning | Status |
8+
| SoC | Wi-Fi | Thread | BLE Commissioning | Status |
99
| --- | ---- | ------ | ----------------- | ------ |
1010
| ESP32 |||| Fully supported |
1111
| ESP32-S2 |||| Fully supported |
@@ -17,9 +17,9 @@ The application showcases Matter commissioning, a single Matter node containing
1717

1818
### Note on Commissioning:
1919

20-
- **ESP32 & ESP32-S2** do not support commissioning over Bluetooth LE. For these chips, you must provide WiFi credentials directly in the sketch code so they can connect to your network manually.
21-
- **ESP32-C6** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using WiFi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter WiFi station feature.
22-
- **ESP32-C5** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using WiFi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter WiFi station feature.
20+
- **ESP32 & ESP32-S2** do not support commissioning over Bluetooth LE. For these chips, you must provide Wi-Fi credentials directly in the sketch code so they can connect to your network manually.
21+
- **ESP32-C6** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
22+
- **ESP32-C5** Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project as an ESP-IDF component and to disable the Matter Wi-Fi station feature.
2323

2424
## Features
2525

@@ -28,7 +28,7 @@ The application showcases Matter commissioning, a single Matter node containing
2828
- Light #1: Simple On/Off Light
2929
- Light #2: Dimmable Light (on/off with brightness control)
3030
- Light #3: Color Light (RGB color control)
31-
- Support for both WiFi and Thread(*) connectivity
31+
- Support for both Wi-Fi and Thread(*) connectivity
3232
- Button control for factory reset (decommission)
3333
- Matter commissioning via QR code or manual pairing code
3434
- Integration with Apple HomeKit, Amazon Alexa, and Google Home
@@ -52,16 +52,16 @@ The application showcases Matter commissioning, a single Matter node containing
5252
2. Install ESP32 Arduino Core with Matter support
5353
3. ESP32 Arduino libraries:
5454
- `Matter`
55-
- `WiFi` (only for ESP32 and ESP32-S2)
55+
- `Wi-Fi` (only for ESP32 and ESP32-S2)
5656

5757
### Configuration
5858

5959
Before uploading the sketch, configure the following:
6060

61-
1. **WiFi credentials** (if not using BLE commissioning - mandatory for ESP32 | ESP32-S2):
61+
1. **Wi-Fi credentials** (if not using BLE commissioning - mandatory for ESP32 | ESP32-S2):
6262
```cpp
63-
const char *ssid = "your-ssid"; // Change to your WiFi SSID
64-
const char *password = "your-password"; // Change to your WiFi password
63+
const char *ssid = "your-ssid"; // Change to your Wi-Fi SSID
64+
const char *password = "your-password"; // Change to your Wi-Fi password
6565
```
6666

6767
2. **Button pin configuration** (optional):
@@ -79,12 +79,12 @@ Before uploading the sketch, configure the following:
7979

8080
## Expected Output
8181

82-
Once the sketch is running, open the Serial Monitor at a baud rate of **115200**. The WiFi connection messages will be displayed only for ESP32 and ESP32-S2. Other targets will use Matter CHIPoBLE to automatically setup the IP Network. You should see output similar to the following, which provides the necessary information for commissioning:
82+
Once the sketch is running, open the Serial Monitor at a baud rate of **115200**. The Wi-Fi connection messages will be displayed only for ESP32 and ESP32-S2. Other targets will use Matter CHIPoBLE to automatically setup the IP Network. You should see output similar to the following, which provides the necessary information for commissioning:
8383

8484
```
8585
Connecting to your-wifi-ssid
8686
.......
87-
WiFi connected
87+
Wi-Fi connected
8888
IP address: 192.168.1.100
8989
9090
Matter Node is not commissioned yet.
@@ -156,7 +156,7 @@ Use a Matter-compatible hub (like an Apple HomePod, Google Nest Hub, or Amazon E
156156

157157
The MatterComposedLights example consists of the following main components:
158158

159-
1. **`setup()`**: Initializes hardware (button), configures WiFi (if needed), sets up three Matter endpoints (OnOffLight, DimmableLight, ColorLight), and registers callbacks for state changes.
159+
1. **`setup()`**: Initializes hardware (button), configures Wi-Fi (if needed), sets up three Matter endpoints (OnOffLight, DimmableLight, ColorLight), and registers callbacks for state changes.
160160
2. **`loop()`**: Checks the Matter commissioning state, displays the state of all three lights every 5 seconds, handles button input for factory reset, and allows the Matter stack to process events.
161161
3. **Callbacks**:
162162
- `setLightOnOff1()`: Handles on/off state changes for Light #1.
@@ -165,7 +165,7 @@ The MatterComposedLights example consists of the following main components:
165165

166166
## Troubleshooting
167167

168-
- **Device not visible during commissioning**: Ensure WiFi or Thread connectivity is properly configured
168+
- **Device not visible during commissioning**: Ensure Wi-Fi or Thread connectivity is properly configured
169169
- **Only one or two lights appear**: Some smart home platforms may group or display lights differently. Check your app's device list
170170
- **Failed to commission**: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using `Arduino IDE Menu` -> `Tools` -> `Erase All Flash Before Sketch Upload: "Enabled"` or directly with `esptool.py --port <PORT> erase_flash`
171171
- **No serial output**: Check baudrate (115200) and USB connection

0 commit comments

Comments
 (0)