CHENGQI YANG / SmartLab_MuRata

Murata RF modules are designed to simplify wireless development and certification by minimizing the amount of RF expertise you need to wirelessly enable a wide range of applications.

Config/SoftAPConfig.h@9:0ce800923eda, 2016-03-16 (annotated)

Committer:
yangcq88517
Date:
Wed Mar 16 15:04:46 2016 +0000
Revision:
9:0ce800923eda
Parent:
0:8e83b9448758 
bug fix

Who changed what in which revision?

UserRevisionLine numberNew contents of line
yangcq88517 0:8e83b9448758 1 #ifndef SmartLab_MuRata_Config_SoftAPConfig
yangcq88517 0:8e83b9448758 2 #define SmartLab_MuRata_Config_SoftAPConfig
yangcq88517 0:8e83b9448758 3
yangcq88517 0:8e83b9448758 4 #include "WIFINetwork.h"
yangcq88517 0:8e83b9448758 5
yangcq88517 0:8e83b9448758 6 namespace SmartLabMuRata
yangcq88517 0:8e83b9448758 7 {
yangcq88517 9:0ce800923eda 8 /*
yangcq88517 9:0ce800923eda 9 * OnOff = 0 indicates AP is to be turned off. The rest of the parameters are ignored.
yangcq88517 9:0ce800923eda 10 * BSSID is not required
yangcq88517 9:0ce800923eda 11 * !!! cannot be WEP and WIFI_SECURITY_WPA_AES_PSK !!!
yangcq88517 9:0ce800923eda 12 */
yangcq88517 0:8e83b9448758 13 class SoftAPConfig : public WIFINetwork
yangcq88517 0:8e83b9448758 14 {
yangcq88517 0:8e83b9448758 15 public :
yangcq88517 0:8e83b9448758 16 enum State {
yangcq88517 9:0ce800923eda 17 /**
yangcq88517 9:0ce800923eda 18 * indicates AP is to be turned off. The rest of the parameters are ignored.
yangcq88517 9:0ce800923eda 19 */
yangcq88517 0:8e83b9448758 20 OFF = 0x00,
yangcq88517 0:8e83b9448758 21
yangcq88517 9:0ce800923eda 22 /**
yangcq88517 9:0ce800923eda 23 * indicates turning on soft AP using existing NVM parameters.
yangcq88517 9:0ce800923eda 24 */
yangcq88517 0:8e83b9448758 25 ON_NVM = 0x01,
yangcq88517 0:8e83b9448758 26
yangcq88517 9:0ce800923eda 27 /**
yangcq88517 9:0ce800923eda 28 * indicates turning on AP with the parameters provided. If the soft AP is already on, it is first turned off.
yangcq88517 9:0ce800923eda 29 */
yangcq88517 0:8e83b9448758 30 ON_PARAMETERS = 0x02,
yangcq88517 0:8e83b9448758 31 };
yangcq88517 0:8e83b9448758 32
yangcq88517 9:0ce800923eda 33 SoftAPConfig(State state, const char * SSID = NULL, const SecurityMode securityMode = WIFI_SECURITY_OPEN, const char * securityKey = NULL);
yangcq88517 0:8e83b9448758 34
yangcq88517 9:0ce800923eda 35 State GetOnOffStatus();
yangcq88517 0:8e83b9448758 36
yangcq88517 0:8e83b9448758 37 char GetPersistency();
yangcq88517 0:8e83b9448758 38
yangcq88517 9:0ce800923eda 39 /**
yangcq88517 9:0ce800923eda 40 * OFF
yangcq88517 9:0ce800923eda 41 * ON_NVM
yangcq88517 9:0ce800923eda 42 * ON_PARAMETERS
yangcq88517 9:0ce800923eda 43 */
yangcq88517 0:8e83b9448758 44 SoftAPConfig * SetOnOffState(const State onOff);
yangcq88517 0:8e83b9448758 45
yangcq88517 0:8e83b9448758 46 SoftAPConfig * SetPersistency(const bool persistency);
yangcq88517 0:8e83b9448758 47
yangcq88517 0:8e83b9448758 48 virtual SoftAPConfig * SetSecurityKey(const char * SecurityKey);
yangcq88517 0:8e83b9448758 49
yangcq88517 0:8e83b9448758 50 virtual SoftAPConfig * SetBSSID(const char * BSSID);
yangcq88517 0:8e83b9448758 51
yangcq88517 0:8e83b9448758 52 virtual SoftAPConfig * SetSSID(const char * SSID);
yangcq88517 0:8e83b9448758 53
yangcq88517 9:0ce800923eda 54 /**
yangcq88517 9:0ce800923eda 55 * Supported values :
yangcq88517 9:0ce800923eda 56 * WIFI_SECURITY_OPEN
yangcq88517 9:0ce800923eda 57 * WIFI_SECURITY_WPA_TKIP_PSK
yangcq88517 9:0ce800923eda 58 * WIFI_SECURITY_WPA2_AES_PSK
yangcq88517 9:0ce800923eda 59 * WIFI_SECURITY_WPA2_MIXED_PSK
yangcq88517 9:0ce800923eda 60 */
yangcq88517 0:8e83b9448758 61 virtual SoftAPConfig * SetSecurityMode(const SecurityMode securityMode);
yangcq88517 0:8e83b9448758 62
yangcq88517 0:8e83b9448758 63 virtual SoftAPConfig * SetChannel(const char channel);
yangcq88517 0:8e83b9448758 64
yangcq88517 0:8e83b9448758 65 private :
yangcq88517 9:0ce800923eda 66 State state;
yangcq88517 0:8e83b9448758 67
yangcq88517 9:0ce800923eda 68 /**
yangcq88517 9:0ce800923eda 69 * Persistency=1 indicates the soft AP’s on/off state and parameters (if OnOff = 2) will be saved in NVM.
yangcq88517 9:0ce800923eda 70 * For example, if OnOff =0 and Persistency=1, the soft AP will not be turned on after a reset.
yangcq88517 9:0ce800923eda 71 */
yangcq88517 9:0ce800923eda 72 bool persistency;
yangcq88517 0:8e83b9448758 73 };
yangcq88517 0:8e83b9448758 74 }
yangcq88517 0:8e83b9448758 75
yangcq88517 0:8e83b9448758 76 #endif