X-Git-Url: https://oss.titaniummirror.com/gitweb/?a=blobdiff_plain;f=apps%2Ftests%2FTestSimTimers%2FREADME;h=65f8f369af05e7e11f0dccc4cefb5b57cb8545ec;hb=06b8c5c8b1eba90e3f9bc99a4de612f27a97bad6;hp=29f24b986df6b49a660caffd09460fcab4ea862b;hpb=0650ae4864d810f331fc6dfa8ba78fc4b61d771d;p=tinyos-2.x.git

diff --git a/apps/tests/TestSimTimers/README b/apps/tests/TestSimTimers/README
index 29f24b98..65f8f369 100644
--- a/apps/tests/TestSimTimers/README
+++ b/apps/tests/TestSimTimers/README
@@ -1,12 +1,41 @@
-TestTimer, 4/9/07 
+README for TestTimer, 4/9/07 
+Author/Contact: tinyos-help@millennium.berkeley.edu
 
-This application tests TinyOS millisecond timers
-(TimerMilliC). It is intended for use with TOSSIM,
-to test whether the timer implementation is working
-correctly: its output consists of TOSSIM dbg() 
-statements.
+Description:
 
+This application tests TinyOS millisecond timers (TimerMilliC). It is
+intended for use with TOSSIM, to test whether the timer implementation
+is working correctly: its output consists of TOSSIM dbg() statements.
 The relevant output channel is "TestTimer".
 
-Philip Levis
+To test this application, compile for TOSSIM ('make micaz sim') and run
+script.py ('python script.py'). If the TOSSIM timers are operating
+correctly, then the output should say that timers are good, e.g.:
 
+DEBUG (0): Timer A is good @ 0:9:56.837925167.
+DEBUG (0): Timer B is good @ 0:9:57.356479854.
+DEBUG (0): Timer A is good @ 0:9:57.837925167.
+DEBUG (0): Timer A is good @ 0:9:58.837925167.
+DEBUG (0): Timer B is good @ 0:9:59.648472042.
+DEBUG (0): Timer A is good @ 0:9:59.837925167.
+DEBUG (0): Timer A is good @ 0:10:0.837925167.
+DEBUG (0): Timer A is good @ 0:10:1.837925167.
+DEBUG (0): Timer A is good @ 0:10:2.837925167.
+DEBUG (0): Timer A is good @ 0:10:3.837925167.
+
+If a timer is off, then the output will read
+
+DEBUG (0): Timer A is off. Should have fired in X, fired in Y @ Z.
+
+Note that if a timer is off by 1, the timer is still operating
+correctly. The way the atm128 counter registers work mean that you
+can't schedule very short timers, so sometimes the code needs to
+make it one tick longer.
+
+Tools:
+
+None.
+
+Known bugs/limitations:
+
+None.