Skip to content

Commit 1ce3a16

Browse files
committed
fix(pre-commit): Fix spelling
1 parent 47c5e6c commit 1ce3a16

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

docs/en/matter/matter.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ About
77

88
The Matter library provides support for creating Matter-compatible devices including:
99

10-
* Support for WiFi and Thread connectivity
10+
* Support for Wi-Fi and Thread connectivity
1111
* Matter commissioning via QR code or manual pairing code
1212
* Multiple endpoint types for various device categories
1313
* Event monitoring and callback support
@@ -23,7 +23,7 @@ Matter (formerly Project CHIP - Connected Home over IP) is an open-source connec
2323

2424
**Key Features:**
2525

26-
* **Multi-Protocol Support**: Works over WiFi, Thread, and Ethernet
26+
* **Multi-Protocol Support**: Works over Wi-Fi, Thread, and Ethernet
2727
* **Interoperability**: Devices from different manufacturers work together
2828
* **Security**: Built-in security features including encryption and authentication
2929
* **Local Control**: Devices can communicate locally without requiring cloud connectivity
@@ -34,27 +34,27 @@ Matter Network Topology
3434

3535
.. code-block:: text
3636
37-
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
38-
│ Matter Hub │◄─────►│ WiFi Router │◄─────►│ ESP Border │
39-
│ (HomePod etc) │ │ │ │ Border Router │
40-
└─────────────────┘ └─────────────────┘ └─────────────────┘
37+
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
38+
│ Matter Hub │◄─────►│ Wi-Fi Router │◄─────►│ ESP Border │
39+
│ (HomePod etc) │ │ │ │ Border Router │
40+
└─────────────────┘ └─────────────────┘ └─────────────────┘
4141
│ │ │
4242
│ ▼ │
4343
│ ┌─────────────────┐ │
4444
│ │ Matter Device │ │
45-
│ │ (via WiFi) │ │
45+
│ │ (via Wi-Fi) │ │
4646
│ └─────────────────┘ │
4747
│ │
4848
▼ ▼
4949
┌─────────────────┐ ┌─────────────────┐
5050
│ Matter Device │ │ Matter Device │
51-
│ (via WiFi) │ │ (via Thread) │
51+
│ (via Wi-Fi) │ │ (via Thread) │
5252
└─────────────────┘ └─────────────────┘
5353
5454
5555
**Network Interfaces:**
5656

57-
* **WiFi**: High-bandwidth connection for devices that require constant power
57+
* **Wi-Fi**: High-bandwidth connection for devices that require constant power
5858
* **Thread**: Low-power mesh networking for battery-operated devices
5959
* **Ethernet**: Wired connection for stationary devices
6060

@@ -73,7 +73,7 @@ Matter
7373
The ``Matter`` class is the main entry point for all Matter operations. It serves as the central manager that handles:
7474

7575
* **Device Commissioning**: Managing the commissioning process via QR code or manual pairing code
76-
* **Network Connectivity**: Checking and managing WiFi and Thread connections
76+
* **Network Connectivity**: Checking and managing Wi-Fi and Thread connections
7777
* **Event Handling**: Monitoring Matter events and device state changes
7878
* **Device Management**: Decommissioning and factory reset functionality
7979

@@ -83,7 +83,7 @@ The ``Matter`` class provides the following key methods:
8383

8484
* ``begin()``: Initializes the Matter stack
8585
* ``isDeviceCommissioned()``: Checks if the device is commissioned
86-
* ``isWiFiConnected()``: Checks WiFi connection status (if WiFi is enabled)
86+
* ``isWi-FiConnected()``: Checks Wi-Fi connection status (if Wi-Fi is enabled)
8787
* ``isThreadConnected()``: Checks Thread connection status (if Thread is enabled)
8888
* ``isDeviceConnected()``: Checks overall device connectivity
8989
* ``decommission()``: Factory resets the device
@@ -99,7 +99,7 @@ The ``MatterEndPoint`` class is the base class for all Matter endpoints. It prov
9999
* **Endpoint Management**: Each endpoint has a unique endpoint ID for identification
100100
* **Attribute Access**: Methods to get and set attribute values from Matter clusters
101101
* **Identify Cluster**: Support for device identification (visual feedback)
102-
* **Secondary Network Interfaces**: Support for multiple network interfaces (WiFi, Thread, Ethernet)
102+
* **Secondary Network Interfaces**: Support for multiple network interfaces (Wi-Fi, Thread, Ethernet)
103103
* **Attribute Change Callbacks**: Base framework for handling attribute changes from Matter controllers
104104

105105
.. toctree::
@@ -152,19 +152,19 @@ Common Issues
152152

153153
**Device won't commission**
154154
* Ensure the Matter hub is in pairing mode
155-
* Check that WiFi or Thread connectivity is properly configured
155+
* Check that Wi-Fi or Thread connectivity is properly configured
156156
* Verify the QR code or pairing code is correct
157-
* For ESP32/ESP32-S2, ensure WiFi credentials are set in the code
157+
* For ESP32/ESP32-S2, ensure Wi-Fi credentials are set in the code
158158

159159
**Commissioning fails**
160160
* Try factory resetting the device by calling ``Matter.decommission()``
161161
* Erase flash memory: ``Arduino IDE Menu`` -> ``Tools`` -> ``Erase All Flash Before Sketch Upload: "Enabled"``
162162
* Or use esptool: ``esptool.py --port <PORT> erase_flash``
163163

164-
**WiFi connection issues**
165-
* Verify WiFi credentials (SSID and password) are correct
166-
* Check that the device is within range of the WiFi router
167-
* Ensure the WiFi network is 2.4 GHz (Matter requires 2.4 GHz WiFi)
164+
**Wi-Fi connection issues**
165+
* Verify Wi-Fi credentials (SSID and password) are correct
166+
* Check that the device is within range of the Wi-Fi router
167+
* Ensure the Wi-Fi network is 2.4 GHz (Matter requires 2.4 GHz Wi-Fi)
168168

169169
**Thread connection issues**
170170
* Verify Thread border router is properly configured
@@ -207,7 +207,7 @@ For debugging and monitoring Matter events, you can set up an event callback:
207207
Serial.println("Device commissioned!");
208208
break;
209209
case MATTER_WIFI_CONNECTIVITY_CHANGE:
210-
Serial.println("WiFi connectivity changed");
210+
Serial.println("Wi-Fi connectivity changed");
211211
break;
212212
// ... handle other events
213213
}

docs/en/matter/matter_ep.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The ``MatterEndPoint`` class is the base class for all Matter endpoints. It prov
1010
* **Endpoint Management**: Each endpoint has a unique endpoint ID for identification within the Matter network
1111
* **Attribute Access**: Methods to get and set attribute values from Matter clusters
1212
* **Identify Cluster**: Support for device identification (visual feedback like LED blinking)
13-
* **Secondary Network Interfaces**: Support for multiple network interfaces (WiFi, Thread, Ethernet)
13+
* **Secondary Network Interfaces**: Support for multiple network interfaces (Wi-Fi, Thread, Ethernet)
1414
* **Attribute Change Callbacks**: Base framework for handling attribute changes from Matter controllers
1515

1616
All Matter endpoint classes inherit from ``MatterEndPoint``, providing a consistent interface and common functionality across all device types.

0 commit comments

Comments
 (0)