Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / apps / tests / tkn154 / nonbeacon-enabled / TestPromiscuous / README.txt

diff --git a/apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/README.txt b/apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/README.txt
new file mode 100644 (file)
index 0000000..743fa3a
--- /dev/null
+++ b/apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/README.txt
@@ -0,0 +1,42 @@
+README for TestPromiscuous
+Author/Contact: Jan Hauer <hauer@tkn.tu-berlin.de>
+
+Description:
+
+In this application the node enables promiscuous mode, i.e. its radio is
+switched to receive mode and all incoming frames that pass the CRC check are
+signalled to the upper layer. The application uses the TinyOS printf library
+(tos/lib/printf) to output information on the MAC header fields and payload for
+every received frame over the serial port. The second (TelosB: green) LED is
+toggled whenever a frame is received.
+
+Criteria for a successful test:
+
+A successful test means that for every received frame LED1 is toggled
+and the java application outputs some text. To see this effect you need a
+second node sending a packet, for example, use the
+../../beacon-enabled/TestStartSync/coordinator application to send periodic
+beacon packets. In this case LED1 should toggle every half second and
+printf java client should output some text on the frame content.
+
+
+Tools: The printf java client in $TOSDIR/../apps/tests/TestPrintf
+
+Usage: 
+
+Install the application on a node
+
+    $ make <platform> install
+
+Start the printf client, e.g. 
+
+    $ java net.tinyos.tools.PrintfClient -comm serial@/dev/ttyUSBXXX:<platform>
+
+(http://docs.tinyos.net/ has a section on how to use the TinyOS printf library)
+
+Known bugs/limitations:
+
+- The timestamps for ACKs are incorrect
+
+$Id$
+