![]() |
WiConnect Host Library- API Reference Guide | ||
Methods for enabled/disabling module web setup. More...
Functions | |
WiconnectResult | wiconnect::NetworkInterface::startWebSetup (const char *ssid=NULL, const char *password=NULL, const Callback &completeHandler=Callback()) |
Start the WiConnect WiFi module 'web setup' feature. More... | |
WiconnectResult | wiconnect::NetworkInterface::stopWebSetup () |
Stop the WiConnect WiFi module 'web setup' feature. More... | |
WiconnectResult | wiconnect::NetworkInterface::isWebSetupRunning (bool *isRunningPtr) |
Return status of WiConnect WiFi module 'web setup' feature. More... | |
Methods for enabled/disabling module web setup.
WiconnectResult wiconnect::NetworkInterface::isWebSetupRunning | ( | bool * | isRunningPtr | ) |
Return status of WiConnect WiFi module 'web setup' feature.
This may be called at any time (whether web setpu has been stared or not).
[out] | isRunningPtr | Pointer to bool to contain TRUE if web setup is running, FALSE else |
WiconnectResult wiconnect::NetworkInterface::startWebSetup | ( | const char * | ssid = NULL , |
const char * | password = NULL , |
||
const Callback & | completeHandler = Callback() |
||
) |
Start the WiConnect WiFi module 'web setup' feature.
This command has an optional background processing feature. Background processing is enabled if the completeHandler parameter is specified. If enabled, the library will poll the module every second for the web setup status (essentially it'll call isWebSetupRunning() every second in the background). When the web setup is no longer running the callback will be executed. The background processing is disabled when stopWebSetup() is called.
Refer to Asynchronous Processing for more info.
[in] | ssid | Optional, optionally set the SSID of module's softAp |
[in] | password | Optional, optionally set the WPA2-PSK password for the module'S softap Note: make an OPEN softAp, set this parameter to a null string (i.e. "") |
[in] | completeHandler | Optional, callback to be executed when module web setup completes. |
WiconnectResult wiconnect::NetworkInterface::stopWebSetup | ( | ) |
Stop the WiConnect WiFi module 'web setup' feature.
This method should be called AFTER startWebSetup() to prematurely terminate web setup. Note that this is not needed if web setup completes by itself (i.e. if the user exits web setup from the webpage).