Skip to content

Commit 2918c66

Browse files
committed
YAML documentation: node id and endpoint defaults
1 parent f7db85e commit 2918c66

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/testing/yaml.md

+9
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,11 @@ All YAML tests assume that the DUT has previously been commissioned before
293293
running. DUTs should be commissioned using chip-tool. Use the same KVS file when
294294
running the test.
295295

296+
By default, the tests use node ID 0x12344321. The easiest way to run the tests
297+
is to commission with this node ID. Alternately, you can change the target node
298+
ID on the command line, as shown in the [Running the tests](#running-the-tests)
299+
section.
300+
296301
#### Running the tests
297302

298303
There are several options for running tests locally. Because the YAML runner
@@ -338,6 +343,10 @@ with --
338343
339344
```
340345

346+
Each test defines a default endpoint to target. Root node cluster tests run
347+
against endpoint 0 by default. Most other cluster tests run against endpoint 1.
348+
You can set the endpoint for the test using the `endpoint` config variable.
349+
341350
#### Factory resetting the DUT
342351

343352
On the host machine, you can simulate a factory reset by deleting the KVS file.

0 commit comments

Comments
 (0)