Diff: Config/SoftAPConfig.h

Revision:

9:0ce800923eda

Parent:

0:8e83b9448758

--- a/Config/SoftAPConfig.h	Mon Feb 15 15:17:50 2016 +0000
+++ b/Config/SoftAPConfig.h	Wed Mar 16 15:04:46 2016 +0000
@@ -5,32 +5,42 @@
 
 namespace SmartLabMuRata
 {
+/*
+* OnOff = 0 indicates AP is to be turned off. The rest of the parameters are ignored.
+* BSSID is not required
+* !!! cannot be WEP and WIFI_SECURITY_WPA_AES_PSK !!!
+*/
 class SoftAPConfig : public WIFINetwork
 {
 public :
     enum State {
-        /// <summary>
-        /// indicates AP is to be turned off. The rest of the parameters are ignored.
-        /// </summary>
+        /**
+        * indicates AP is to be turned off. The rest of the parameters are ignored.
+        */
         OFF = 0x00,
 
-        /// <summary>
-        /// indicates turning on soft AP using existing NVM parameters,
-        /// </summary>
+        /**
+        * indicates turning on soft AP using existing NVM parameters.
+        */
         ON_NVM = 0x01,
 
-        /// <summary>
-        /// indicates turning on AP with the parameters provided. If the soft AP is already on, it is first turned off.
-        /// </summary>
+        /**
+        * indicates turning on AP with the parameters provided. If the soft AP is already on, it is first turned off.
+        */
         ON_PARAMETERS = 0x02,
     };
 
-    SoftAPConfig(State state, const char * SSID = "", const SecurityMode securityMode = WIFI_SECURITY_OPEN, const char * securityKey = NULL);
+    SoftAPConfig(State state, const char * SSID = NULL, const SecurityMode securityMode = WIFI_SECURITY_OPEN, const char * securityKey = NULL);
 
-    char GetOnOffStatus();
+    State GetOnOffStatus();
 
     char GetPersistency();
 
+    /**
+    * OFF
+    * ON_NVM
+    * ON_PARAMETERS
+    */
     SoftAPConfig * SetOnOffState(const State onOff);
 
     SoftAPConfig * SetPersistency(const bool persistency);
@@ -41,46 +51,25 @@
 
     virtual SoftAPConfig * SetSSID(const char * SSID);
 
-    /// <summary>
-    /// WIFI_SECURITY_OPEN
-    /// WIFI_SECURITY_WPA_TKIP_PSK
-    /// WIFI_SECURITY_WPA2_AES_PSK
-    /// WIFI_SECURITY_WPA2_MIXED_PSK
-    /// supported
-    /// </summary>
-    /// <param name="securityMode"></param>
-    /// <returns></returns>
+    /**
+    * Supported values :
+    * WIFI_SECURITY_OPEN
+    * WIFI_SECURITY_WPA_TKIP_PSK
+    * WIFI_SECURITY_WPA2_AES_PSK
+    * WIFI_SECURITY_WPA2_MIXED_PSK
+    */
     virtual SoftAPConfig * SetSecurityMode(const SecurityMode securityMode);
 
     virtual SoftAPConfig * SetChannel(const char channel);
-    /*
-     * Parameters are as follows:
-     * UINT8 Request Sequence
-     * UINT8 Onoff
-     * UINT8 Persistency
-     * UINT8 SSID [up to 33]
-     * UINT8 Channel
-     * UINT8 Security mode
-     * UINT8 Security key length (0-64)
-     * … Security key [ ]
-     * OnOff = 0 indicates AP is to be turned off. The rest of the parameters are ignored.
-     * OnOff = 1 indicates turning on soft AP using existing NVM parameters,
-     * OnOff = 2 indicates turning on AP with the parameters provided. If the soft AP is already on, it is first turned off.
-     * Persistency=1 indicates the soft AP’s on/off state and parameters (if OnOff = 2) will be saved in NVM. For example, if OnOff =0 and Persistency=1, the soft AP will not be turned on after a reset.
-     */
 
 private :
-    State onOff;
-    bool persistency;
+    State state;
 
-    /// <summary>
-    /// OnOff = 0 indicates AP is to be turned off. The rest of the parameters are ignored.
-    /// BSSID is not required
-    /// !!! cannot be WEP and WIFI_SECURITY_WPA_AES_PSK !!!
-    /// </summary>
-    /// <param name="SSID">only required when OnOff = 2, which is ON_PARAMETERS</param>
-    /// <param name="securityMode"></param>
-    /// <param name="securityKey"></param>
+    /**
+    * Persistency=1 indicates the soft AP’s on/off state and parameters (if OnOff = 2) will be saved in NVM.
+    * For example, if OnOff =0 and Persistency=1, the soft AP will not be turned on after a reset.
+    */
+    bool persistency;
 };
 }