API getters/setters for core library settings.
More...
API getters/setters for core library settings.
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
-
settingStr | String module setting name. |
valuePtr | Pointer 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
-
settingStr | String module setting name. |
valuePtr | Pointer 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
-
settingStr | String module setting name. |
valueBuffer | Buffer to hold retrieved setting result |
valueBufferLen | The 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] | assertLogFunc | Logging function pointer |
void wiconnect::Wiconnect::setBlockingEnabled |
( |
bool |
blockingEnabled | ) |
|
Sets if API calls are blocking or non-blocking.
- Parameters
-
[in] | blockingEnabled | The 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] | timeoutMs | Default 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] | periodMs | Processing period in milliseconds |
void wiconnect::Wiconnect::setDebugLogger |
( |
LogFunc |
logFunc | ) |
|
Sets callback function used to debug WiConnect WiFi module RX/TX serial data.
- Parameters
-
[in] | logFunc | Logging function pointer |
Sets a mapping function used to convert from a host Pin to WiConnect WiFi module GPIO.
- Parameters
-
[in] | mapper | Pin to GPIO mapper function pointer |
WiconnectResult wiconnect::Wiconnect::setSetting |
( |
const char * |
settingStr, |
|
|
uint32_t |
value |
|
) |
| |
WiconnectResult wiconnect::Wiconnect::setSetting |
( |
const char * |
settingStr, |
|
|
const char * |
value |
|
) |
| |