Revision 16:19ea694d96c0, committed 2014-08-26

Comitter:

julmbed

Date:

Tue Aug 26 09:35:47 2014 +0000

Parent:

15:a794a7ef6170

Child:

17:8c20a558d34f

Commit message:

added documentation..... still looks poor

Changed in this revision

--- a/VarStore.h	Tue Aug 26 09:20:44 2014 +0000
+++ b/VarStore.h	Tue Aug 26 09:35:47 2014 +0000
@@ -6,15 +6,28 @@
 #define STR_OK ""
 
 /** VarStore Class beta !!!!!!!
- *  Used for reading/modifying program variables
- *  from the console at runtime. Helpful for
- *  debugging.
+ *  Used for reading/modifying program variables from the console at runtime.
+ *   Helpful for   debugging
  *  It has a facility as well to reset the mbed
  *  from the serial console without pressing  
  *  any button.
  *  It does not block the serial/input channel
  *  in case it is needed for other stuff
  *  
+ *  From the console ( be aware that if you do not have local echo activated you wil not see what you tye. Commands are 
+ *  triggered at CR
+ *
+ *  s:var:value               -> sets the value of var to value at runtime
+ *  d:var                     -> dump content of var
+ *  s:arr:val1,val2,val3      -> set first three values of arr to val1,val2,val3
+ *  r                         -> reset mbed... and reload program
+ *  w:milisecs                -> (beta) release the console input for your program for a period of time7
+ *
+ *  I do have in a note pad sets of commands, e.g. dumps of variables I want to check and then I just 
+ *  copy and paste in to the terminal so see all of them at once or repeteadly show them.
+ *  
+ * hope it helps.
+ *  
  * Example:
  * @code
  *