Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / apps / tests / tkn154 / beacon-enabled / TestIndirect / README.txt

diff --git a/apps/tests/tkn154/beacon-enabled/TestIndirect/README.txt b/apps/tests/tkn154/beacon-enabled/TestIndirect/README.txt
new file mode 100644 (file)
index 0000000..f963b80
--- /dev/null
+++ b/apps/tests/tkn154/beacon-enabled/TestIndirect/README.txt
@@ -0,0 +1,43 @@
+README for TestIndirect
+Author/Contact: Jan Hauer <hauer@tkn.tu-berlin.de>
+
+Description:
+
+In this application one node takes the role of a PAN coordinator in a
+beacon-enabled 802.15.4 PAN, it transmits periodic beacons and additionally in
+every beacon interval it tries to transmit one DATA frame to a device using
+indirect tranmission. A second node that takes the role of a device first scans
+the pre-defined channel for beacons from the coordinator and once it finds a
+beacon it tries to synchronize to and track all future beacons. Whenever the
+coordinator has data to send (indicated in the beacon), the device extracts the
+DATA frame from the coordinator.
+
+Criteria for a successful test:
+
+Both nodes should toggle the LED1 in unison, about once every half second. 
+The coordinator should also toggle LED2 with the same frequency.
+
+
+Tools: NONE
+
+Usage: 
+
+1. Install the coordinator:
+
+    $ cd coordinator; make <platform> install
+
+2. Install one device
+
+    $ cd device; make <platform> install
+
+You can change some of the configuration parameters in app_profile.h
+
+Known bugs/limitations:
+
+- Many TinyOS 2 platforms do not have a clock that satisfies the
+  precision/accuracy requirements of the IEEE 802.15.4 standard (e.g. 
+  62.500 Hz, +-40 ppm in the 2.4 GHz band); in this case the MAC timing 
+  is not standard compliant
+
+$Id$
+