j3d1/esp-open-rtos
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
sheinz 2016-10-25 14:27:03 +03:00
parent 4c24d01ba1
commit 9d2649b77b
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
tests/README.md
View file

@ -15,16 +15,20 @@ C testing framework.
There's a test runner script `test_runner.py` written in Python3 that runs There's a test runner script `test_runner.py` written in Python3 that runs
test cases on ESP8266 connected to a host. test cases on ESP8266 connected to a host.
Test runner is heavily relying on device reset using DTR and RTS signals.
Popular ESP8266 boards such as **NodeMcu** and **Wemos D1** support device
reset into flash mode.
### Options ### Options
`--type` or `-t` - Type of test case to run. Can be 'solo' or 'dual'. `--type` or `-t` - Type of test case to run. Can be 'solo' or 'dual'.
If not specified 'solo' test will be run. If not specified 'solo' test will be run.
`--aport` or `-a` - Serial port for device A. `--aport` or `-a` - Serial port for device A.
If not specifid device `/dev/ttyUSB0` is used. If not specified device `/dev/ttyUSB0` is used.
`--bport` or `-b` - Serial port for device B. `--bport` or `-b` - Serial port for device B.
If not specifid device `/dev/ttyUSB1` is used. If not specified device `/dev/ttyUSB1` is used.
`--no-flash` or `-n` - Do not flash the test firmware before running tests. `--no-flash` or `-n` - Do not flash the test firmware before running tests.
@ -34,16 +38,20 @@ If not specifid device `/dev/ttyUSB1` is used.
Build test firmware, flash it using serial device `/dev/tty.wchusbserial1410` Build test firmware, flash it using serial device `/dev/tty.wchusbserial1410`
and run only *solo* test cases: and run only *solo* test cases:
`./test_runner.py -a /dev/tty.wchusbserial1410` `./test_runner.py -a /dev/tty.wchusbserial1410`
Build test firmware. Flash both devices as `-t dual` is specifid. And run both Build test firmware. Flash both devices as `-t dual` is specified. And run both
*solo* and *dual* test cases: *solo* and *dual* test cases:
`./test_runner.py -a /dev/tty.wchusbserial1410 -b /dev/tty.wchusbserial1420 -t dual` `./test_runner.py -a /dev/tty.wchusbserial1410 -b /dev/tty.wchusbserial1420 -t dual`
Do not flash the firmware, only display available test cases on the device: Do not flash the firmware, only display available test cases on the device:
`./test_runner.py -a /dev/tty.wchusbserial1410 -n -l` `./test_runner.py -a /dev/tty.wchusbserial1410 -n -l`
Do not flash the firmware and run only 2 and 4 test cases: Do not flash the firmware and run only 2 and 4 test cases:
`./test_runner.py -a /dev/tty.wchusbserial1410 -n 2 4` `./test_runner.py -a /dev/tty.wchusbserial1410 -n 2 4`
## References ## References