From fe889bd10d903a764624caeeaf3cd1f9aa890abf Mon Sep 17 00:00:00 2001 From: C Freeman Date: Wed, 27 Mar 2024 13:31:24 -0400 Subject: [PATCH] YAML documentation: node id and endpoint defaults (#32756) --- docs/testing/yaml.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/testing/yaml.md b/docs/testing/yaml.md index 2099d623c1b3db..107c761fbef71e 100644 --- a/docs/testing/yaml.md +++ b/docs/testing/yaml.md @@ -293,6 +293,11 @@ All YAML tests assume that the DUT has previously been commissioned before running. DUTs should be commissioned using chip-tool. Use the same KVS file when running the test. +By default, the tests use node ID 0x12344321. The easiest way to run the tests +is to commission with this node ID. Alternately, you can change the target node +ID on the command line, as shown in the [Running the tests](#running-the-tests) +section. + #### Running the tests There are several options for running tests locally. Because the YAML runner @@ -338,6 +343,10 @@ with -- ``` +Each test defines a default endpoint to target. Root node cluster tests run +against endpoint 0 by default. Most other cluster tests run against endpoint 1. +You can set the endpoint for the test using the `endpoint` config variable. + #### Factory resetting the DUT On the host machine, you can simulate a factory reset by deleting the KVS file.