diff --git a/tests/README.md b/tests/README.md index 0eb390e..070bf7d 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,7 +1,7 @@ # esp-open-rtos tests Testing is based on [Unity](https://github.com/ThrowTheSwitch/Unity) -C testing framework. +C testing framework. ## Features @@ -15,16 +15,20 @@ C testing framework. There's a test runner script `test_runner.py` written in Python3 that runs 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 `--type` or `-t` - Type of test case to run. Can be 'solo' or 'dual'. If not specified 'solo' test will be run. `--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. -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. @@ -34,16 +38,20 @@ If not specifid device `/dev/ttyUSB1` is used. Build test firmware, flash it using serial device `/dev/tty.wchusbserial1410` and run only *solo* test cases: + `./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: + `./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: + `./test_runner.py -a /dev/tty.wchusbserial1410 -n -l` Do not flash the firmware and run only 2 and 4 test cases: + `./test_runner.py -a /dev/tty.wchusbserial1410 -n 2 4` ## References