ACKme Logo WiConnect Host Library- API Reference Guide
 
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Activation

Methods for activating/deactivating the module with http://goHACK.me. More...

Functions

WiconnectResult wiconnect::GhmInterface::ghmDownloadCapabilities (const char *capsNameOrCustomUrl=NULL, uint32_t version=0)
 Download a device capabilities file to WiFi module's internal file system. More...
 
WiconnectResult wiconnect::GhmInterface::ghmActivate (const char *userName, const char *password, const char *capsFilename=NULL)
 Activate WiFi module with http://goHACK.me. More...
 
WiconnectResult wiconnect::GhmInterface::ghmDeactivate (const char *userName, const char *password)
 Deactivate WiFi module with http://goHACK.me. More...
 
WiconnectResult wiconnect::GhmInterface::ghmIsActivated (bool *statusPtr)
 Return if WiFi module is activated with http://goHACK.me. More...
 

Detailed Description

Methods for activating/deactivating the module with http://goHACK.me.

Function Documentation

WiconnectResult wiconnect::GhmInterface::ghmActivate ( const char *  userName,
const char *  password,
const char *  capsFilename = NULL 
)

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]userNameYour username
[in]passwordYour password
[in]capsFilenameOptional, filename of existing capabilities file on module's internal file system.
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::GhmInterface::ghmDeactivate ( const char *  userName,
const char *  password 
)

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]userNameYour username
[in]passwordYour password
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::GhmInterface::ghmDownloadCapabilities ( const char *  capsNameOrCustomUrl = NULL,
uint32_t  version = 0 
)

Download a device capabilities file to WiFi module's internal file system.

Parameters
[in]capsNameOrCustomUrlOptional, specify the caps file name or URL to caps file
[in]versionOptional, version to set downloaded caps file as
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::GhmInterface::ghmIsActivated ( bool *  statusPtr)

Return if WiFi module is activated with http://goHACK.me.

Parameters
[out]statusPtrPointer to hold activation status.
Returns
Result of method. See WiconnectResult