Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / apps / tosthreads / apps / TestCollection / TestCollectionAppC.nc

diff --git a/apps/tosthreads/apps/TestCollection/TestCollectionAppC.nc b/apps/tosthreads/apps/TestCollection/TestCollectionAppC.nc
index 4db9f298a37df58e0f12fef129879cdc980f1b9f..f248d97084be500577a3a9f968c628aea1a870c8 100644 (file)
--- a/apps/tosthreads/apps/TestCollection/TestCollectionAppC.nc
+++ b/apps/tosthreads/apps/TestCollection/TestCollectionAppC.nc
@@ -20,7 +20,30 @@
  * THE POSSIBILITY OF SUCH DAMAGE.
 */
 
-/*
+/**
+ * TestCollection is a reimplementation of the Multihop Oscilloscope application
+ * using TOSThreads. It periodically samples a universal software-based SineSensor
+ * and broadcasts a message every few readings. These readings can be displayed by
+ * the Java "Oscilloscope" application found in the the TestCollection/java
+ * subdirectory. The sampling rate starts at 4Hz, but can be changed from the Java
+ * application.
+ * 
+ * At least two motes must be used by this application, with one of them installed
+ * as a base station.  Base station motes can be created by installing them with
+ * NODE_ID % 500 == 0.
+ *   i.e. make <platform> threads install.0
+ *        make <platform> threads install.500
+ *        make <platform> threads install.1000
+ * 
+ * All other nodes can be installed with arbitrary NODE_IDs.
+ *   make <platform> threads install.123
+ * 
+ * Successful running of this application is verified by all NON-base station motes
+ * periodically flashing LED1 upon sending a message, and the base station mote,
+ * flashing LED2 upon successful reception of a message.  Additionally, correct
+ * operation should be verified by running the java tool described in the following
+ * section.
+ *
  * @author Chieh-Jan Mike Liang <cliang4@cs.jhu.edu>
  */