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

API getters/setters for core library settings. More...

Functions

WiconnectResult wiconnect::Wiconnect::setSetting (const char *settingStr, uint32_t value)
 Set a module setting. More...
 
WiconnectResult wiconnect::Wiconnect::setSetting (const char *settingStr, const char *value)
 Set a module setting. More...
 
WiconnectResult wiconnect::Wiconnect::getSetting (const char *settingStr, uint32_t *valuePtr)
 Get a module setting. More...
 
WiconnectResult wiconnect::Wiconnect::getSetting (const char *settingStr, char **valuePtr)
 Get a module setting. More...
 
WiconnectResult wiconnect::Wiconnect::getSetting (const char *settingStr, char *valueBuffer, uint16_t valueBufferLen)
 Get a module setting. More...
 
void wiconnect::Wiconnect::setBlockingEnabled (bool blockingEnabled)
 Sets if API calls are blocking or non-blocking. More...
 
bool wiconnect::Wiconnect::getBlockingEnabled (void)
 Gets if API calls are blocking or non-blocking.
 
void wiconnect::Wiconnect::setCommandDefaultTimeout (TimerTimeout timeoutMs)
 Sets the default maximum time an API method may execute before terminating and return a timeout error code. More...
 
TimerTimeout wiconnect::Wiconnect::getCommandDefaultTimeout ()
 Returns the current default maximum API execution time. More...
 
void wiconnect::Wiconnect::setPinToGpioMapper (PinToGpioMapper mapper)
 Sets a mapping function used to convert from a host Pin to WiConnect WiFi module GPIO. More...
 
void wiconnect::Wiconnect::setDebugLogger (LogFunc logFunc)
 Sets callback function used to debug WiConnect WiFi module RX/TX serial data. More...
 
void wiconnect::Wiconnect::setAssertLogger (LogFunc assertLogFunc)
 Sets callback used when Wiconnect Library hits and internal assertion. More...
 
void wiconnect::Wiconnect::setCommandProcessingPeriod (uint32_t periodMs)
 Set the period at which an asynchronous command should be processed. More...
 

Detailed Description

API getters/setters for core library settings.

Function Documentation

TimerTimeout wiconnect::Wiconnect::getCommandDefaultTimeout ( )

Returns the current default maximum API execution time.

Returns
Default command timeout in milliseconds
WiconnectResult wiconnect::Wiconnect::getSetting ( const char *  settingStr,
uint32_t *  valuePtr 
)

Get a module setting.

Refer to: http://wiconnect.ack.me/2.0/variables for a list of the available settings and descriptions

Parameters
settingStrString module setting name.
valuePtrPointer to buffer to contain integer value
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::getSetting ( const char *  settingStr,
char **  valuePtr 
)

Get a module setting.

Refer to: http://wiconnect.ack.me/2.0/variables for a list of the available settings and descriptions

Parameters
settingStrString module setting name.
valuePtrPointer to hold pointer to internal API buffer containing retrieved setting result
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::getSetting ( const char *  settingStr,
char *  valueBuffer,
uint16_t  valueBufferLen 
)

Get a module setting.

Refer to: http://wiconnect.ack.me/2.0/variables for a list of the available settings and descriptions

Parameters
settingStrString module setting name.
valueBufferBuffer to hold retrieved setting result
valueBufferLenThe length of the input buffer
Returns
Result of method. See WiconnectResult
void wiconnect::Wiconnect::setAssertLogger ( LogFunc  assertLogFunc)

Sets callback used when Wiconnect Library hits and internal assertion.

Note
This is mainly for debugging. There's nothing the callback can do to fix the assertion.
Parameters
[in]assertLogFuncLogging function pointer
void wiconnect::Wiconnect::setBlockingEnabled ( bool  blockingEnabled)

Sets if API calls are blocking or non-blocking.

Parameters
[in]blockingEnabledThe new blocking value
void wiconnect::Wiconnect::setCommandDefaultTimeout ( TimerTimeout  timeoutMs)

Sets the default maximum time an API method may execute before terminating and return a timeout error code.

Note
All API methods (execpt some sendCommand()) use this default value.
Parameters
[in]timeoutMsDefault command timeout in milliseconds
void wiconnect::Wiconnect::setCommandProcessingPeriod ( uint32_t  periodMs)

Set the period at which an asynchronous command should be processed.

Refer to Asynchronous Processing for more info.

Parameters
[in]periodMsProcessing period in milliseconds
void wiconnect::Wiconnect::setDebugLogger ( LogFunc  logFunc)

Sets callback function used to debug WiConnect WiFi module RX/TX serial data.

Parameters
[in]logFuncLogging function pointer
void wiconnect::Wiconnect::setPinToGpioMapper ( PinToGpioMapper  mapper)

Sets a mapping function used to convert from a host Pin to WiConnect WiFi module GPIO.

Parameters
[in]mapperPin to GPIO mapper function pointer
WiconnectResult wiconnect::Wiconnect::setSetting ( const char *  settingStr,
uint32_t  value 
)

Set a module setting.

Refer to: http://wiconnect.ack.me/2.0/variables for a list of the available settings and descriptions

Parameters
settingStrString module setting name.
valueThe integer value to set
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::setSetting ( const char *  settingStr,
const char *  value 
)

Set a module setting.

Refer to: http://wiconnect.ack.me/2.0/variables for a list of the available settings and descriptions

Parameters
settingStrString module setting name.
valueThe string value to set
Returns
Result of method. See WiconnectResult