Nicolas Duchoud / Mbed 2 deprecated condens

condens

Dependencies:   mbed MbedJSONValue

Files at this revision

API Documentation at this revision

Revision 3:26d5a21bbc66, committed 2019-08-22

Comitter:
duchonic
Date:
Thu Aug 22 22:31:27 2019 +0000
Parent:
2:d5f4f429f3db
Commit message:
docu

Changed in this revision

communication.h Show annotated file Show diff for this revision Revisions of this file 
--- a/communication.h	Thu Aug 22 22:27:16 2019 +0000
+++ b/communication.h	Thu Aug 22 22:31:27 2019 +0000
@@ -65,7 +65,10 @@
     std::string type;
 };
 
-
+/** Conf Class
+*
+*
+*/
 class Conf{
 public:
     Conf(int newTemperature=20){
@@ -108,8 +111,25 @@
     std::string tempKey;
 };
 
+/** Status Class
+*
+*
+*/
 class Status{
 public:
+    /** Constructor, set the keys
+     * @code
+        n1Key[0] = "N1.1";
+        n1Key[1] = "N1.2";
+        n1Key[2] = "N1.3";
+        n1Key[3] = "N1.4";
+        n2Key    = "N2";
+        n3Key    = "N3";
+        t1Key    = "T1";
+        hsKey    = "HS";
+        statusKey = "STATUS";
+     * @endcode
+    */
     Status(){
         n1Key[0] = "N1.1";
         n1Key[1] = "N1.2";
@@ -147,6 +167,10 @@
     std::string statusKey;
 };
 
+/** Command Class
+*
+*
+*/
 class Command{
 public:
     Command(){