update readme

This commit is contained in:
Nicholas O'Leary
2012-11-11 15:13:02 +00:00
parent cc8d0c3913
commit e4ceba6f9e

View File

@ -27,8 +27,8 @@ to the `logs` directory.
## What it does ## What it does
For each example sketch, `sketch.ino`, the suite looks for a matching test case For each sketch in the library's `examples` directory, e.g. `mqtt_basic.ino`, the suite looks for a matching test case
`testcases/sketch.py`. `testcases/mqtt_basic.py`.
The test case must follow these conventions: The test case must follow these conventions:
- sub-class `unittest.TestCase` - 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. 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 - `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 us - `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 Before each sketch is compiled, these values are automatically substituted in. To
do this, the suite looks for lines that _start_ with the following: do this, the suite looks for lines that _start_ with the following: