Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / apps / tosthreads / capps / SenseAndSend / SenseAndSend.c

diff --git a/apps/tosthreads/capps/SenseAndSend/SenseAndSend.c b/apps/tosthreads/capps/SenseAndSend/SenseAndSend.c
index 242d6503f3ce7a0db6c89738ce401928b5ecc605..c49a761e62955ca4c0dbbd62ee6d18c2531639eb 100644 (file)
--- a/apps/tosthreads/capps/SenseAndSend/SenseAndSend.c
+++ b/apps/tosthreads/capps/SenseAndSend/SenseAndSend.c
@@ -30,6 +30,23 @@
  */
 
 /**
+ * SenseAndSend is a threaded implementation of an application that takes various
+ * sensor readings in parallel (by dedicating one thread to each reading), and
+ * assembling them into a packet to be sent out over the radio.  It is written
+ * specifically for use with the tmote onboard sensor package, and will not compile
+ * for any other platforms.
+ * 
+ * Readings are taken from each of the 4 oboard sensors and sent out over the radio
+ * interface in an infinite loop.  Upon successful transmission, LED0 is toggled,
+ * and the process starts over again.
+ * 
+ * A successful test will result in LED0 toggling periodically at a rate of
+ * approximately 220ms (the time it takes to take a humidity + temperature sensor
+ * reading since they share the same hardware and cannot be taken in parallel). 
+ * 
+ * Additionally, a base station application should be run to verify the reception
+ * of packets sent from a SenseAndSend mote, with reasonable looking sensor data.
+ *
  * @author Kevin Klues <klueska@cs.stanford.edu>
  */