Skip to content

Commit ec9050c

Browse files
ci(pre-commit): Apply automatic fixes
1 parent 50e3404 commit ec9050c

File tree

14 files changed

+43
-54
lines changed

14 files changed

+43
-54
lines changed

libraries/OpenThread/examples/CLI/COAP/coap_lamp/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Before uploading the sketch, you can modify the network and CoAP configuration:
5454
#define OT_COAP_RESOURCE_NAME "Lamp"
5555
```
5656
57-
**Important:**
57+
**Important:**
5858
- The network key and channel must match the Switch device configuration
5959
- The multicast address and resource name must match the Switch device
6060
- The network key must be a 32-character hexadecimal string (16 bytes)
@@ -118,30 +118,30 @@ The RGB LED provides visual feedback:
118118
119119
The coap_lamp example consists of the following main components:
120120
121-
1. **`otDeviceSetup()` function**:
121+
1. **`otDeviceSetup()` function**:
122122
- Configures the device as a Leader node using CLI Helper Functions
123123
- Sets up CoAP server and resource
124124
- Waits for device to become Leader
125125
- Returns success/failure status
126126
127-
2. **`setupNode()` function**:
127+
2. **`setupNode()` function**:
128128
- Retries setup until successful
129129
- Calls `otDeviceSetup()` with Leader role configuration
130130
131-
3. **`otCOAPListen()` function**:
131+
3. **`otCOAPListen()` function**:
132132
- Listens for CoAP requests from the Switch device
133133
- Parses CoAP PUT requests
134134
- Controls RGB LED based on payload (0 = OFF, 1 = ON)
135135
- Implements smooth fade transitions
136136
137-
4. **`setup()`**:
137+
4. **`setup()`**:
138138
- Initializes Serial communication
139139
- Starts OpenThread stack with `OpenThread.begin(false)`
140140
- Initializes OpenThread CLI
141141
- Sets CLI timeout
142142
- Calls `setupNode()` to configure the device
143143
144-
5. **`loop()`**:
144+
5. **`loop()`**:
145145
- Continuously calls `otCOAPListen()` to process incoming CoAP requests
146146
- Small delay for responsiveness
147147
@@ -163,4 +163,3 @@ The coap_lamp example consists of the following main components:
163163
## License
164164
165165
This example is licensed under the Apache License, Version 2.0.
166-

libraries/OpenThread/examples/CLI/COAP/coap_switch/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Before uploading the sketch, you can modify the network and CoAP configuration:
5656
#define OT_COAP_RESOURCE_NAME "Lamp"
5757
```
5858
59-
**Important:**
59+
**Important:**
6060
- The network key and channel **must match** the Lamp device configuration
6161
- The multicast address and resource name **must match** the Lamp device
6262
- The network key must be a 32-character hexadecimal string (16 bytes)
@@ -123,36 +123,36 @@ The RGB LED provides visual feedback:
123123

124124
The coap_switch example consists of the following main components:
125125

126-
1. **`otDeviceSetup()` function**:
126+
1. **`otDeviceSetup()` function**:
127127
- Configures the device to join an existing network using CLI Helper Functions
128128
- Sets up CoAP client
129129
- Waits for device to become Router or Child
130130
- Returns success/failure status
131131

132-
2. **`setupNode()` function**:
132+
2. **`setupNode()` function**:
133133
- Retries setup until successful
134134
- Calls `otDeviceSetup()` with Router/Child role configuration
135135

136-
3. **`otCoapPUT()` function**:
136+
3. **`otCoapPUT()` function**:
137137
- Sends CoAP PUT request to the lamp device
138138
- Waits for CoAP confirmation response
139139
- Returns success/failure status
140140
- Uses CLI Helper Functions to send commands and read responses
141141

142-
4. **`checkUserButton()` function**:
142+
4. **`checkUserButton()` function**:
143143
- Monitors button state with debouncing
144144
- Toggles lamp state on button press
145145
- Calls `otCoapPUT()` to send commands
146146
- Restarts setup if CoAP request fails
147147

148-
5. **`setup()`**:
148+
5. **`setup()`**:
149149
- Initializes Serial communication
150150
- Starts OpenThread stack with `OpenThread.begin(false)`
151151
- Initializes OpenThread CLI
152152
- Sets CLI timeout
153153
- Calls `setupNode()` to configure the device
154154

155-
6. **`loop()`**:
155+
6. **`loop()`**:
156156
- Continuously calls `checkUserButton()` to monitor button input
157157
- Small delay for responsiveness
158158

@@ -174,4 +174,3 @@ The coap_switch example consists of the following main components:
174174
## License
175175

176176
This example is licensed under the Apache License, Version 2.0.
177-

libraries/OpenThread/examples/CLI/SimpleCLI/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Once the sketch is running, open the Serial Monitor at a baud rate of **115200**
5555

5656
```
5757
OpenThread CLI started - type 'help' for a list of commands.
58-
ot>
58+
ot>
5959
```
6060

6161
The `ot> ` prompt indicates that the OpenThread CLI console is ready. You can now type OpenThread CLI commands directly.
@@ -139,13 +139,13 @@ ipaddr
139139

140140
The SimpleCLI example consists of the following main components:
141141

142-
1. **`setup()`**:
142+
1. **`setup()`**:
143143
- Initializes Serial communication
144144
- Starts OpenThread stack with `OpenThread.begin(false)` (no auto-start)
145145
- Initializes OpenThread CLI
146146
- Starts the interactive CLI console on Serial
147147

148-
2. **`loop()`**:
148+
2. **`loop()`**:
149149
- Empty - all interaction happens through the CLI console
150150

151151
## Troubleshooting
@@ -164,4 +164,3 @@ The SimpleCLI example consists of the following main components:
164164
## License
165165

166166
This example is licensed under the Apache License, Version 2.0.
167-

libraries/OpenThread/examples/CLI/SimpleNode/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,13 @@ To create a multi-device Thread network:
103103

104104
The SimpleNode example consists of the following main components:
105105

106-
1. **`setup()`**:
106+
1. **`setup()`**:
107107
- Initializes Serial communication
108108
- Starts OpenThread stack with `OpenThread.begin()` (auto-start with default settings)
109109
- Initializes OpenThread CLI
110110
- Prints current Thread network information using `OpenThread.otPrintNetworkInformation()`
111111

112-
2. **`loop()`**:
112+
2. **`loop()`**:
113113
- Periodically displays the current device role using `OpenThread.otGetStringDeviceRole()`
114114
- Updates every 5 seconds
115115

@@ -129,4 +129,3 @@ The SimpleNode example consists of the following main components:
129129
## License
130130

131131
This example is licensed under the Apache License, Version 2.0.
132-

libraries/OpenThread/examples/CLI/SimpleThreadNetwork/ExtendedRouterNode/ExtendedRouterNode.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
#include "OThreadCLI_Util.h"
1717

1818
// Leader node shall use the same Network Key and channel
19-
#define CLI_NETWORK_KEY "00112233445566778899aabbccddeeff"
19+
#define CLI_NETWORK_KEY "00112233445566778899aabbccddeeff"
2020
#define CLI_NETWORK_CHANNEL "24"
2121
bool otStatus = true;
2222

libraries/OpenThread/examples/CLI/SimpleThreadNetwork/ExtendedRouterNode/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Before uploading the sketch, configure the network parameters to match the Leade
5050
#define CLI_NETWORK_CHANNEL "24"
5151
```
5252
53-
**Important:**
53+
**Important:**
5454
- The network key **must match** the Leader node's network key
5555
- The channel **must match** the Leader node's channel
5656
- The network key must be a 32-character hexadecimal string (16 bytes)
@@ -76,7 +76,7 @@ PanID[using CLI]: 0x1234
7676

7777
PanID[using OT API]: 0x1234
7878

79-
Thread NetworkInformation:
79+
Thread NetworkInformation:
8080
---------------------------
8181
Role: Router
8282
RLOC16: 0xfc00
@@ -129,7 +129,7 @@ Once the device joins the network, the `loop()` function displays comprehensive
129129

130130
The ExtendedRouterNode example consists of the following main components:
131131

132-
1. **`setup()`**:
132+
1. **`setup()`**:
133133
- Initializes Serial communication
134134
- Starts OpenThread stack with `OpenThread.begin(false)` (no auto-start)
135135
- Initializes OpenThread CLI
@@ -139,7 +139,7 @@ The ExtendedRouterNode example consists of the following main components:
139139
- Waits for device to become Router or Child (with 90-second timeout)
140140
- Demonstrates dual API usage for getting PAN ID
141141

142-
2. **`loop()`**:
142+
2. **`loop()`**:
143143
- Displays comprehensive network information using `OpenThread.otPrintNetworkInformation()`
144144
- Updates every 10 seconds
145145
- Shows error message if setup failed
@@ -161,4 +161,3 @@ The ExtendedRouterNode example consists of the following main components:
161161
## License
162162

163163
This example is licensed under the Apache License, Version 2.0.
164-

libraries/OpenThread/examples/CLI/SimpleThreadNetwork/LeaderNode/LeaderNode.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#include "OThreadCLI.h"
2929
#include "OThreadCLI_Util.h"
3030

31-
#define CLI_NETWORK_KEY "dataset networkkey 00112233445566778899aabbccddeeff"
31+
#define CLI_NETWORK_KEY "dataset networkkey 00112233445566778899aabbccddeeff"
3232
#define CLI_NETWORK_CHANNEL "dataset channel 24"
3333

3434
otInstance *aInstance = NULL;

libraries/OpenThread/examples/CLI/SimpleThreadNetwork/LeaderNode/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Before uploading the sketch, you can modify the network configuration:
4747
#define CLI_NETWORK_CHANNEL "dataset channel 24"
4848
```
4949
50-
**Important:**
50+
**Important:**
5151
- The network key must be a 32-character hexadecimal string (16 bytes)
5252
- The channel must be between 11 and 26 (IEEE 802.15.4 channels)
5353
- All devices in the same network must use the same network key and channel
@@ -112,15 +112,15 @@ To join other devices to this network:
112112

113113
The LeaderNode example consists of the following main components:
114114

115-
1. **`setup()`**:
115+
1. **`setup()`**:
116116
- Initializes Serial communication
117117
- Starts OpenThread stack with `OpenThread.begin(false)` (no auto-start)
118118
- Initializes OpenThread CLI
119119
- Configures the device as a Leader using CLI Helper Functions:
120120
- `OThreadCLI.println()` - Sends CLI commands
121121
- Commands: "dataset init new", "dataset networkkey", "dataset channel", "dataset commit active", "ifconfig up", "thread start"
122122

123-
2. **`loop()`**:
123+
2. **`loop()`**:
124124
- Checks if device role is Leader using `OpenThread.otGetDeviceRole()`
125125
- Displays network information using native OpenThread API calls:
126126
- `otThreadGetNetworkName()` - Network name
@@ -148,4 +148,3 @@ The LeaderNode example consists of the following main components:
148148
## License
149149

150150
This example is licensed under the Apache License, Version 2.0.
151-

libraries/OpenThread/examples/CLI/SimpleThreadNetwork/RouterNode/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Before uploading the sketch, configure the network parameters to match the Leade
5050
#define CLI_NETWORK_CHANNEL "dataset channel 24"
5151
```
5252
53-
**Important:**
53+
**Important:**
5454
- The network key **must match** the Leader node's network key
5555
- The channel **must match** the Leader node's channel
5656
- The network key must be a 32-character hexadecimal string (16 bytes)
@@ -123,15 +123,15 @@ To create a multi-device Thread network:
123123

124124
The RouterNode example consists of the following main components:
125125

126-
1. **`setup()`**:
126+
1. **`setup()`**:
127127
- Initializes Serial communication
128128
- Starts OpenThread stack with `OpenThread.begin(false)` (no auto-start)
129129
- Initializes OpenThread CLI
130130
- Configures the device to join an existing network using CLI Helper Functions:
131131
- `OThreadCLI.println()` - Sends CLI commands
132132
- Commands: "dataset clear", "dataset networkkey", "dataset channel", "dataset commit active", "ifconfig up", "thread start"
133133

134-
2. **`loop()`**:
134+
2. **`loop()`**:
135135
- Checks if device role is Router or Child using `OpenThread.otGetDeviceRole()`
136136
- Displays network information using native OpenThread API calls:
137137
- `otThreadGetNetworkName()` - Network name
@@ -160,4 +160,3 @@ The RouterNode example consists of the following main components:
160160
## License
161161

162162
This example is licensed under the Apache License, Version 2.0.
163-

libraries/OpenThread/examples/CLI/SimpleThreadNetwork/RouterNode/RouterNode.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
#include "OThreadCLI.h"
2828
#include "OThreadCLI_Util.h"
2929

30-
#define CLI_NETWORK_KEY "dataset networkkey 00112233445566778899aabbccddeeff"
30+
#define CLI_NETWORK_KEY "dataset networkkey 00112233445566778899aabbccddeeff"
3131
#define CLI_NETWORK_CHANNEL "dataset channel 24"
3232

3333
otInstance *aInstance = NULL;

0 commit comments

Comments
 (0)