From 0d850cd8d72ffd899e7f4519ecd61d1b0f5123f9 Mon Sep 17 00:00:00 2001 From: Nicholas O'Leary Date: Sun, 11 Nov 2012 15:13:02 +0000 Subject: [PATCH] update readme --- tests/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tests/README.md b/tests/README.md index 02fc3a09..983c8d50 100644 --- a/tests/README.md +++ b/tests/README.md @@ -20,15 +20,15 @@ test case is built, uploaded and then the tests run. The test suite _does not_ run an MQTT server - it is assumed to be running already. - $ python testsuite.py + $ python testsuite.py A summary of activity is printed to the console. More comprehensive logs are written to the `logs` directory. ## What it does -For each example sketch, `sketch.ino`, the suite looks for a matching test case -`testcases/sketch.py`. +For each sketch in the library's `examples` directory, e.g. `mqtt_basic.ino`, the suite looks for a matching test case +`testcases/mqtt_basic.py`. The test case must follow these conventions: - sub-class `unittest.TestCase` @@ -44,8 +44,8 @@ a client and subscribing to topics. The file `testcases/settings.py` is used to config the test environment. - - `server_ip` - the IP address of the broker the client should connect to - - `arduino_ip` - the IP address the arduino should us + - `server_ip` - the IP address of the broker the client should connect to (the broker port is assumed to be 1883). + - `arduino_ip` - the IP address the arduino should use (when not testing DHCP). Before each sketch is compiled, these values are automatically substituted in. To do this, the suite looks for lines that _start_ with the following: