Merge TinyOS 2.1.1 into master.

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

diff --git a/apps/tests/tkn154/beacon-enabled/TestAssociate/README.txt b/apps/tests/tkn154/beacon-enabled/TestAssociate/README.txt
new file mode 100644 (file)
index 0000000..f8623dd
--- /dev/null
+++ b/apps/tests/tkn154/beacon-enabled/TestAssociate/README.txt
@@ -0,0 +1,44 @@
+README for TestAssociate
+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 waits for
+devices to request association to its PAN. Whenever a device tries to
+associate, the PAN coordinator accepts the association and assigns to the
+device a unique short address (starting from zero, incremented for every new
+association request). A second node acts as a device, it first scans the
+pre-defined channel for beacons from the coordinator and once it finds a beacon
+it tries to associate to the PAN. A short time after association the device
+then disassociates from the PAN. 
+
+Criteria for a successful test:
+
+Both, coordinator and device, should toggle LED1 in unison about once every 5 
+seconds. The coordinator should also toggle LED2 every second.
+
+
+Tools: NONE
+
+Usage: 
+
+1. Install the coordinator:
+
+    $ cd coordinator; make <platform> install
+
+2. Install one (or more) devices:
+
+    $ 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$o
+