Skip to content

Commit 13f16a8

Browse files
committed
Fixing MISSPELL issues in README.md
1 parent 1f16b6c commit 13f16a8

File tree

2 files changed

+25
-21
lines changed

2 files changed

+25
-21
lines changed

.github/.wordlist.txt

+2
Original file line numberDiff line numberDiff line change
@@ -519,8 +519,10 @@ EthyleneOxideConcentrationMeasurement
519519
EvalCode
520520
EvalCodeWithName
521521
EvalFrameDefault
522+
EV
522523
EVB
523524
evk
525+
EVSE
524526
exceptfds
525527
ExchangeContext
526528
exe

examples/energy-management-app/linux/README.md

+23-21
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini**
1717
- [Running the Complete Example on Raspberry Pi 4](#running-the-complete-example-on-raspberry-pi-4)
1818
- [Running RPC Console](#running-rpc-console)
1919
- [Device Tracing](#device-tracing)
20-
- [Python TestCases](#python-testcases)
20+
- [Python Test Cases](#python-test-cases)
2121
- [Running the test cases:](#running-the-test-cases)
2222
- [CHIP-REPL Interaction](#chip-repl-interaction)
2323
- [Building chip-repl:](#building-chip-repl)
@@ -149,7 +149,7 @@ Obtain tracing json file.
149149
-o {OUTPUT_FILE} -t {ELF_FILE} {PIGWEED_REPO}/pw_trace_tokenized/pw_trace_protos/trace_rpc.proto
150150
```
151151

152-
## Python TestCases
152+
## Python Test Cases
153153

154154
When you want to test this cluster you can use chip-repl or chip-tool by hand.
155155
CHIP-REPL is slightly easier to interact with when dealing with some of the
@@ -158,20 +158,20 @@ complex structures.
158158
There are several test scripts provided for EVSE (in
159159
[src/python_testing](src/python_testing)):
160160

161-
- TC_EEVSE_2_2: This validates the primary functionality
162-
- TC_EEVSE_2_3: This validates Get/Set/Clear target commands
163-
- TC_EEVSE_2_4: This validates Faults
164-
- TC_EEVSE_2_5: This validates EVSE diagnostic command (optional)
161+
- `TC_EEVSE_2_2`: This validates the primary functionality
162+
- `TC_EEVSE_2_3`: This validates Get/Set/Clear target commands
163+
- `TC_EEVSE_2_4`: This validates Faults
164+
- `TC_EEVSE_2_5`: This validates EVSE diagnostic command (optional)
165165

166-
These scripts require the use of TestEventsTriggers via the GeneralDiagnostics
167-
cluster on Endpoint 0. This requires an enableKey (16 bytes) and a set of
168-
reserved int64_t TestEvent trigger codes.
166+
These scripts require the use of Test Event Triggers via the GeneralDiagnostics
167+
cluster on Endpoint 0. This requires an `enableKey` (16 bytes) and a set of
168+
reserved int64_t test event trigger codes.
169169

170170
By default the test event support is not enabled, and when compiling the example
171171
app you need to add `chip_enable_energy_evse_trigger=true` to the gn args.
172172

173173
$ gn gen out/debug
174-
$ ninja -C out/debug --args='chip_enable_energy_evse_trigger=true`
174+
$ ninja -C out/debug --args='chip_enable_energy_evse_trigger=true'
175175

176176
Once the application is built you also need to tell it at runtime what the
177177
chosen enable key is using the `--enable-key` command line option.
@@ -292,10 +292,11 @@ Out[2]: <chip.native.PyChipError object at 0x7f2432b16140>
292292
subscription = await devCtrl.ReadAttribute(1234,[(1, chip.clusters.EnergyEvse)], reportInterval=reportingTimingParams)
293293
```
294294

295-
- Step 6: Send an EnableCharging command which lasts for 60 seconds The
296-
EnableCharging takes an optional parameter which allows the charger to
297-
automatically disable itself at some preset time in the future. Note that it
298-
uses Epoch_s (which is from Jan 1 2000) which is a uint32_t in seconds.
295+
- Step 6: Send an `EnableCharging` command which lasts for 60 seconds The
296+
`EnableCharging` takes an optional `chargingEnabledUntil` parameter which
297+
allows the charger to automatically disable itself at some preset time in
298+
the future. Note that it uses Epoch_s (which is from Jan 1 2000) which is a
299+
uint32_t in seconds.
299300

300301
```python
301302
from datetime import datetime, timezone, timedelta
@@ -369,7 +370,7 @@ The test event triggers values can be found in:
369370

370371
- 0x0099000000000000 - Simulates the EVSE being installed on a 32A supply
371372
- 0x0099000000000002 - Simulates the EVSE being plugged in (this should
372-
generate an EVConnected event)
373+
generate an `EVConnected` event)
373374
- 0x0099000000000004 - Simulates the EVSE requesting power
374375

375376
To send a test event trigger to the app, use the following commands (in
@@ -384,7 +385,7 @@ chip-repl):
384385

385386
```
386387

387-
Now send the enable charging command (omit the chargingEnabledUntil arg this
388+
Now send the enable charging command (omit the `chargingEnabledUntil` arg this
388389
time):
389390

390391
```python
@@ -440,7 +441,7 @@ Now send the test event trigger to simulate the EV asking for demand:
440441

441442
- We can see that the `EventNumber 65538` was sent when the vehicle was
442443
plugged in, and a new `sessionID=0` was created.
443-
- We can also see that the EnergyTransferStarted was sent in
444+
- We can also see that the `EnergyTransferStarted` was sent in
444445
`EventNumber 65539`
445446

446447
What happens when we unplug the vehicle?
@@ -494,13 +495,14 @@ When we re-read the events:
494495
495496
```
496497

497-
- In `EventNumber 65540` we had an EnergyTransferStopped event with reason
498+
- In `EventNumber 65540` we had an `EnergyTransferStopped` event with reason
498499
`kOther`.
499500

500501
This was a rather abrupt end to a charging session (normally we would see
501502
the EVSE or EV decide to stop charging), but this demonstrates the cable
502503
being pulled out without a graceful charging shutdown.
503504

504-
- In `EventNumber 65541` we had an EvNotDetected event showing that the state
505-
was `kPluggedInCharging` prior to the EV being not detected (normally in a
506-
graceful shutdown this would be `kPluggedInNoDemand` or `kPluggedInDemand`).
505+
- In `EventNumber 65541` we had an `EvNotDetected` event showing that the
506+
state was `kPluggedInCharging` prior to the EV being not detected (normally
507+
in a graceful shutdown this would be `kPluggedInNoDemand` or
508+
`kPluggedInDemand`).

0 commit comments

Comments
 (0)