Prior to portable tx branch

[micorpython_ir.git] / README.md

diff --git a/README.md b/README.md
index 1e1fa25b39e2374ea9718214a92945c219b009fc..b264e185277dee74159e652658b344f8cbe9bafc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -73,11 +73,18 @@ This is a Python package. This minimises RAM usage: applications only import
 the device driver for the protocol in use.
 
 Copy the following to the target filesystem:
 the device driver for the protocol in use.
 
 Copy the following to the target filesystem:

- 1. `ir_rx` Directory and contents. Contains the device drivers.
- 2. `ir_rx_test.py` Demo of a receiver.
+ 1. `ir_rx` Directory and contents. Contains device drivers and test script.

 
 There are no dependencies.
 
 
 There are no dependencies.
 

+The test script may be used to characterise remote controls. To run it issue:
+```python
+from ir_rx import test
+```
+The script will display instructions for running against the various protocols.
+If you are unsure which protocol your remote uses, try each one in turn. If
+none of the options work it may be that an unsupported protocol is in use.
+

 The demo can be used to characterise IR remotes. It displays the codes returned
 by each button. This can aid in the design of receiver applications. The demo
 prints "running" every 5 seconds and reports any data received from the remote.
 The demo can be used to characterise IR remotes. It displays the codes returned
 by each button. This can aid in the design of receiver applications. The demo
 prints "running" every 5 seconds and reports any data received from the remote.