[docs] revise THCI README (#3005)

This commit is contained in:
Jeff Bumgardner
2018-08-28 20:50:20 -07:00
committed by Jonathan Hui
parent 54bf9ef0e0
commit b133a194fb
+26 -23
View File
@@ -2,55 +2,58 @@ THCI & Test Environment Setup
=============================
THCI (Thread Host Controller Interface) is an implementation of the Python abstract class template "IThci",
which is used by Thread Test Harness Software to control OpenThread-based reference devices according to each test
which is used by the Thread Test Harness Software to control OpenThread-based reference devices according to each test
scenario.
Currently, there are two THCI implementations for OpenThread. One is for OpenThread CLI which is based on the CC2538
example platform and is included in the current Thread Test Harness Software release. The other is for OpenThread wpanctl
which is based on wpantund running on a linux host (for example: Raspberry Pi 3B) working with a NCP (Network Co-Processor)
board (for example: Nordic Semiconductor nRF52840) running a OpenThread NCP image.
Currently, there are two THCI implementations for OpenThread:
Platform developers should modify the THCI implementation directly to match their platform (for example: serial baud rate).
Alternatively, platform developers may follow the instructions below to add a new THCI implementation to the Test
Harness.
* OpenThread CLI — Based on the CC2538 example platform, which is included in the current Thread Test Harness Software
release.
* OpenThread `wpanctl` — Based on `wpantund` running on a Linux host (for example, a Raspberry Pi 3B) working with a Network
Co-Processor (NCP) (for example, a Nordic Semiconductor nRF52840) running an OpenThread NCP image.
Platform developers should modify the THCI implementation directly to match their platform (for example, serial baud rate).
Alternatively, platform developers may follow the instructions below to add a new THCI implementation to the Test Harness.
## OpenThread Environment Setup ##
1. Copy "OpenThread.png" to \GRL\Thread1.1\Web\images folder.
1. Copy "OpenThread.png" to `C:\GRL\Thread1.1\Web\images`.
2. Copy "deviceInputFields.xml" to \GRL\Thread1.1\Web\data folder.
2. Copy "deviceInputFields.xml" to `\GRL\Thread1.1\Web\data`.
3. Copy "OpenThread.py" to \GRL\Thread1.1\Thread_Harness\THCI folder.
3. Copy "OpenThread.py" to `\GRL\Thread1.1\Thread_Harness\THCI`.
4. Connect DUT (Device Under Test), sniffer and CC2538DK (or hardware running OpenThread) as reference device to Host PC.
4. Connect the DUT (Device Under Test), a sniffer, and CC2538DK (or other hardware running OpenThread, as the reference device)
to the Host PC.
5. Launch Thread Test Harness Software and modify the default configuration if needed then click "Start".
5. Launch the Thread Test Harness Software, modify the default configuration if needed, and select **Start**.
6. Drag OpenThread: TI CC2538DK reference device to Test Bed list with desired number.
6. Drag the "OpenThread: TI CC2538DK" reference device to the **Test Bed** section with the desired number.
7. Select one or more test cases to execute.
## OpenThread WpanCtl Environment Setup ##
1. Copy "OpenThread.png" to \GRL\Thread1.1\Web\images folder.
1. Copy "OpenThread.png" to `\GRL\Thread1.1\Web\images`.
2. Copy "deviceInputFields.xml" to \GRL\Thread1.1\Web\data folder.
2. Copy "deviceInputFields.xml" to `\GRL\Thread1.1\Web\data`.
3. Copy "OpenThread_WpanCtl.py" to \GRL\Thread1.1\Thread_Harness\THCI folder.
3. Copy "OpenThread_WpanCtl.py" to `\GRL\Thread1.1\Thread_Harness\THCI`.
4. Connect the NCP board (nRF52840) to Raspberry Pi's USB port and verify that wpanctl command works.
4. Connect the NCP board (nRF52840) to the Raspberry Pi's USB port and verify that the `wpanctl` command works.
5. Connect the Raspberry Pi's GPIOs (for Raspberry Pi 3B, link Pin8 as TXD, Pin10 as RXD and Pin14 as GND) with
5. Connect the Raspberry Pi's GPIOs (for Raspberry Pi 3B, link Pin8 as TXD, Pin10 as RXD, and Pin14 as GND) with
a UART2USB adapter.
6. Connect DUT (with Step 5's adapter), sniffer and other golden devices as reference device to Host PC.
6. Connect the DUT (with Step 5's adapter), sniffer, and other golden devices (as reference devices) to the Host PC.
7. Get the DUT serial port hardware identifier and add a new platform group named OpenThread_WpanCtl in
\GRL\Thread1.1\Config\Configuration.ini. See https://openthread.io/certification/automation-setup#acting_as_a_new_reference_platform.
`\GRL\Thread1.1\Config\Configuration.ini`. See https://openthread.io/certification/automation-setup#acting_as_a_new_reference_platform
for more information.
8. Launch Thread Test Harness Software and modify the default configuration if needed then click "Start".
8. Launch the Thread Test Harness Software, modify the default configuration if needed, and select **Start**.
9. Drag OpenThread_WpanCtl: Wpantund + NCP reference device to Test Bed list with desired number.
9. Drag the "OpenThread_WpanCtl: Wpantund + NCP" reference device to the **Test Bed** section with the desired number.
10. Select one or more test cases to execute.