Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
Methods for activating/deactivating the module with http://goHACK.me. More...
Functions | |
WiconnectResult | ghmDownloadCapabilities (const char *capsNameOrCustomUrl=NULL, uint32_t version=0) |
Download a device capabilities file to WiFi module's internal file system. | |
WiconnectResult | ghmActivate (const char *userName, const char *password, const char *capsFilename=NULL) |
Activate WiFi module with http://goHACK.me. | |
WiconnectResult | ghmDeactivate (const char *userName, const char *password) |
Deactivate WiFi module with http://goHACK.me. | |
WiconnectResult | ghmIsActivated (bool *statusPtr) |
Return if WiFi module is activated with http://goHACK.me. |
Detailed Description
Methods for activating/deactivating the module with http://goHACK.me.
Function Documentation
WiconnectResult ghmActivate | ( | const char * | userName, |
const char * | password, | ||
const char * | capsFilename = NULL |
||
) | [inherited] |
Activate WiFi module with http://goHACK.me.
- Note:
- You must first sign-up with http://goHACK.me before you can activate the device. Go to http://goHACK.me to sign-up.
- Parameters:
-
[in] userName Your username [in] password Your password [in] capsFilename Optional, filename of existing capabilities file on module's internal file system.
- Returns:
- Result of method. See WiconnectResult
WiconnectResult ghmDeactivate | ( | const char * | userName, |
const char * | password | ||
) | [inherited] |
Deactivate WiFi module with http://goHACK.me.
- Note:
- You must first sign-up with http://goHACK.me before you can deactivate the device. Go to http://goHACK.me to sign-up.
- Parameters:
-
[in] userName Your username [in] password Your password
- Returns:
- Result of method. See WiconnectResult
WiconnectResult ghmDownloadCapabilities | ( | const char * | capsNameOrCustomUrl = NULL , |
uint32_t | version = 0 |
||
) | [inherited] |
Download a device capabilities file to WiFi module's internal file system.
- Parameters:
-
[in] capsNameOrCustomUrl Optional, specify the caps file name or URL to caps file [in] version Optional, version to set downloaded caps file as
- Returns:
- Result of method. See WiconnectResult
WiconnectResult ghmIsActivated | ( | bool * | statusPtr ) | [inherited] |
Return if WiFi module is activated with http://goHACK.me.
- Parameters:
-
[out] statusPtr Pointer to hold activation status.
- Returns:
- Result of method. See WiconnectResult
Generated on Tue Jul 12 2022 17:35:59 by 1.7.2