xref: /aosp_15_r20/external/openthread/tools/harness-automation/doc/quickstart.rst (revision cfb92d1480a9e65faed56933e9c12405f45898b4)
1*cfb92d14SAndroid Build Coastguard WorkerThread Harness Automation Quick Start
2*cfb92d14SAndroid Build Coastguard Worker=====================================
3*cfb92d14SAndroid Build Coastguard Worker
4*cfb92d14SAndroid Build Coastguard WorkerSetup
5*cfb92d14SAndroid Build Coastguard Worker-----
6*cfb92d14SAndroid Build Coastguard Worker
7*cfb92d14SAndroid Build Coastguard Worker#. Install Thread-Test-Harness1.1-Alpha v1.0-Release_40.0
8*cfb92d14SAndroid Build Coastguard Worker#. Install python 2.7
9*cfb92d14SAndroid Build Coastguard Worker#. Get the OpenThread and switch to the harness automation path::
10*cfb92d14SAndroid Build Coastguard Worker
11*cfb92d14SAndroid Build Coastguard Worker    git clone https://github.com/openthread/openthread.git
12*cfb92d14SAndroid Build Coastguard Worker    cd openthread/tools/harness-automation
13*cfb92d14SAndroid Build Coastguard Worker
14*cfb92d14SAndroid Build Coastguard Worker#. Install python libraries dependencies::
15*cfb92d14SAndroid Build Coastguard Worker
16*cfb92d14SAndroid Build Coastguard Worker    pip install -r requirements.txt
17*cfb92d14SAndroid Build Coastguard Worker
18*cfb92d14SAndroid Build Coastguard Worker#. Update settings.
19*cfb92d14SAndroid Build Coastguard Worker
20*cfb92d14SAndroid Build Coastguard Worker    Just copy the sample and modify according to the comments carefully::
21*cfb92d14SAndroid Build Coastguard Worker
22*cfb92d14SAndroid Build Coastguard Worker        cp autothreadharness/settings_sample.py autothreadharness/settings.py
23*cfb92d14SAndroid Build Coastguard Worker
24*cfb92d14SAndroid Build Coastguard WorkerRun single case
25*cfb92d14SAndroid Build Coastguard Worker---------------
26*cfb92d14SAndroid Build Coastguard Worker
27*cfb92d14SAndroid Build Coastguard Worker::
28*cfb92d14SAndroid Build Coastguard Worker
29*cfb92d14SAndroid Build Coastguard Worker    # bash
30*cfb92d14SAndroid Build Coastguard Worker    ./start.sh Router_5_1_1
31*cfb92d14SAndroid Build Coastguard Worker
32*cfb92d14SAndroid Build Coastguard Worker    # windows command line
33*cfb92d14SAndroid Build Coastguard Worker    start.bat Router_5_1_1
34*cfb92d14SAndroid Build Coastguard Worker
35*cfb92d14SAndroid Build Coastguard WorkerRun all cases
36*cfb92d14SAndroid Build Coastguard Worker-------------
37*cfb92d14SAndroid Build Coastguard Worker
38*cfb92d14SAndroid Build Coastguard Worker::
39*cfb92d14SAndroid Build Coastguard Worker
40*cfb92d14SAndroid Build Coastguard Worker    # bash
41*cfb92d14SAndroid Build Coastguard Worker    ./start.sh
42*cfb92d14SAndroid Build Coastguard Worker
43*cfb92d14SAndroid Build Coastguard Worker    # windows command line
44*cfb92d14SAndroid Build Coastguard Worker    start.bat
45*cfb92d14SAndroid Build Coastguard Worker
46*cfb92d14SAndroid Build Coastguard WorkerThis will record the results in result.json, so that you can continue running cases once broken. You can also get help information with argument -h or --help.
47*cfb92d14SAndroid Build Coastguard Worker
48*cfb92d14SAndroid Build Coastguard WorkerList devices
49*cfb92d14SAndroid Build Coastguard Worker------------
50*cfb92d14SAndroid Build Coastguard Worker
51*cfb92d14SAndroid Build Coastguard Worker::
52*cfb92d14SAndroid Build Coastguard Worker
53*cfb92d14SAndroid Build Coastguard Worker    # bash
54*cfb92d14SAndroid Build Coastguard Worker    ./start.sh -l
55*cfb92d14SAndroid Build Coastguard Worker
56*cfb92d14SAndroid Build Coastguard Worker    # windows command line
57*cfb92d14SAndroid Build Coastguard Worker    start.bat -l
58*cfb92d14SAndroid Build Coastguard Worker
59*cfb92d14SAndroid Build Coastguard WorkerCheck single device
60*cfb92d14SAndroid Build Coastguard Worker-------------------
61*cfb92d14SAndroid Build Coastguard Worker
62*cfb92d14SAndroid Build Coastguard Worker::
63*cfb92d14SAndroid Build Coastguard Worker
64*cfb92d14SAndroid Build Coastguard Worker    # bash
65*cfb92d14SAndroid Build Coastguard Worker    ./start.sh -l COM28
66*cfb92d14SAndroid Build Coastguard Worker
67*cfb92d14SAndroid Build Coastguard Worker    # windows command line
68*cfb92d14SAndroid Build Coastguard Worker    start.bat -l COM28
69*cfb92d14SAndroid Build Coastguard Worker
70*cfb92d14SAndroid Build Coastguard WorkerGet Help
71*cfb92d14SAndroid Build Coastguard Worker---------
72*cfb92d14SAndroid Build Coastguard Worker
73*cfb92d14SAndroid Build Coastguard Worker::
74*cfb92d14SAndroid Build Coastguard Worker
75*cfb92d14SAndroid Build Coastguard Worker    # bash
76*cfb92d14SAndroid Build Coastguard Worker    ./start.sh -h
77*cfb92d14SAndroid Build Coastguard Worker
78*cfb92d14SAndroid Build Coastguard Worker    # windows command line
79*cfb92d14SAndroid Build Coastguard Worker    start.bat -h
80