Diff: SvProtocol.h

Revision:

5:a7849d022f69

Parent:

0:e0131e671ea0

--- a/SvProtocol.h	Tue Feb 24 11:17:10 2015 +0000
+++ b/SvProtocol.h	Wed Feb 25 08:17:43 2015 +0000
@@ -14,19 +14,58 @@
 		virtual void Read(void* aData, uint32_t aLenBytes) = 0;
 };
 
+/** SvProtocol for Bin-Communication with SvVis3
+@code
+SerialBLK pc(USBTX, USBRX);
+SvProtocol ua0(&pc);
+
+void main()
+{
+	pc.format(8,SerialBLK::None,1); pc.baud(500000);
+	ua0.SvMessage("ProcVisDemo");
+	Timer stw; stw.start();
+	while(1) {
+		CommandHandler();
+		if( (stw.read_ms()>100) ) {
+			stw.reset();
+			sv1++; sv2++;
+			if( ua0.acqON ) {
+				ua0.WriteSvI16(1, sv1);
+				ua0.WriteSvI16(2, sv2);
+			}
+		}
+  }
+}
+
+void CommandHandler()
+{
+  uint8_t cmd;
+  int16_t idata1, idata2;
+  if( !pc.IsDataAvail() )
+    return;
+  cmd = ua0.GetCommand();
+  if( cmd==2 ) {
+	idata1 = ua0.ReadI16(); idata2 = ua0.ReadI16();
+    ua0.SvPrintf("Command2 %d %d", idata1, idata2);
+  }
+}
+@endcode
+*/
 class SvProtocol {
 	public:
 		IStreamHL* _st;
 		uint8_t acqON;
     uint8_t svMessageON;
 	public:
+	
+	    //! Constructed with an IStreamHL as Parameter
 		SvProtocol(IStreamHL* aStrm) {
 			acqON=0; svMessageON=1;
 			_st=aStrm; 
 		}
 	
-		// Check's first for acqOn/Off Command
-    // ret 0 if acqOn/Off was handled in GetCommand
+    /** Check's first for acqOn/Off Command
+    ret 0 if acqOn/Off was handled in GetCommand */
     int GetCommand();
 		
 		void Puts(char* aCStr); // Terminate with 0
@@ -34,6 +73,7 @@
     // \r\n is appended automatically
     void Printf(const char* format, ...);
 
+    //! use this printf when you communicate with the SV-Protocol (SvVis3)
     void SvPrintf(const char *format, ...);
     
     void WriteSV(int aId, char* aData) {
@@ -41,6 +81,7 @@
       _st->PutChar(aId); Puts(aData); 
     }
     
+    //! If you only want to send Text ( no full printf )
     void SvMessage(char* aTxt) {
       if( !svMessageON ) return;
       _st->PutChar(10); Puts(aTxt);
@@ -49,24 +90,28 @@
     void VectHeader(int aId, int aNVals)
       { _st->PutChar(aId); _st->PutChar(aNVals); }
     
+    //! Write an int16_t Variable
     void WriteSvI16(int aId, int16_t aData)
       { _st->PutChar(aId+10); _st->Write(&aData,2); }
     
     void WriteSvI32(int aId, int32_t aData)
       { _st->PutChar(aId); _st->Write(&aData,4); }
     
+    //! Write a float Variable
     void WriteSV(int aId, float aData)
       { _st->PutChar(aId+20); _st->Write(&aData,4); }
     
     // float in 3.13 Format
     void WriteSV3p13(int aId, float aData);
 
+    //! read int16_t
     int16_t ReadI16()
       { int16_t ret; _st->Read(&ret,2); return ret; }
 
     int32_t ReadI32()
       { int32_t ret; _st->Read(&ret,4); return ret; }
     
+    //! read float
     float ReadF()
       { float ret; _st->Read(&ret,4); return ret; }
 };