![]() |
WiConnect Host Library- API Reference Guide | ||
API methods for sending commands to WiConnect WiFi module. More...
Functions | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (const Callback &completeCallback, char *responseBuffer, int responseBufferLen, TimerTimeout timeoutMs, const ReaderFunc &reader, void *user, const char *cmd, va_list vaList) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (char *responseBuffer, int responseBufferLen, TimerTimeout timeoutMs, const ReaderFunc &reader, void *user, const char *cmd, va_list vaList) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (char *responseBuffer, int responseBufferLen, TimerTimeout timeoutMs, const ReaderFunc &reader, void *user, const char *cmd,...) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (TimerTimeout timeoutMs, const ReaderFunc &reader, void *user, const char *cmd,...) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (const ReaderFunc &reader, void *user, const char *cmd,...) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (char *responseBuffer, int responseBufferLen, TimerTimeout timeoutMs, const char *cmd,...) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (const Callback &completeCallback, char *responseBuffer, int responseBufferLen, const char *cmd,...) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (char *responseBuffer, int responseBufferLen, const char *cmd,...) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (const Callback &completeCallback, const char *cmd,...) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (const char *cmd,...) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (const Callback &completeCallback, TimerTimeout timeoutMs, const char *cmd,...) |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (TimerTimeout timeoutMs, const char *cmd,...) |
| Send command to WiConnect WiFi module. More... | |
| WiconnectResult | wiconnect::Wiconnect::sendCommand (const char *cmd, va_list vaList) |
| WiconnectResult | wiconnect::Wiconnect::checkCurrentCommand () |
| Check the status of the currently executing command. More... | |
| void | wiconnect::Wiconnect::stopCurrentCommand () |
| Stop the currently executing command. More... | |
| WiconnectResult | wiconnect::Wiconnect::enqueueCommand (QueuedCommand *command, const Callback &commandCompleteHandler=Callback()) |
| Add user command to be executed asynchronously. More... | |
API methods for sending commands to WiConnect WiFi module.
| WiconnectResult wiconnect::Wiconnect::checkCurrentCommand | ( | ) |
Check the status of the currently executing command.
Refer to WiconnectResult for more information about the return code.
| WiconnectResult wiconnect::Wiconnect::enqueueCommand | ( | QueuedCommand * | command, |
| const Callback & | commandCompleteHandler = Callback() |
||
| ) |
Add user command to be executed asynchronously.
Refer to Asynchronous Processing for more info.
| [in] | command | Pointer to QueuedCommand to be executed asynchronously |
| [in] | commandCompleteHandler | Callback to be executed when processing is complete. |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | const Callback & | completeCallback, |
| char * | responseBuffer, | ||
| int | responseBufferLen, | ||
| TimerTimeout | timeoutMs, | ||
| const ReaderFunc & | reader, | ||
| void * | user, | ||
| const char * | cmd, | ||
| va_list | vaList | ||
| ) |
Send command to WiConnect WiFi module.
| [in] | completeCallback | Callback when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length |
| [in] | responseBuffer | Buffer to hold command response |
| [in] | responseBufferLen | Length of responseBuffer |
| [in] | timeoutMs | Maximum time in milliseconds this command should execute |
| [in] | reader | Callback for reading data to be read from host and send to module during command |
| [in] | user | User data struct used during read Callback. Library doesn't use this. Set NULL if not used. |
| [in] | cmd | WiConnect command to send to module |
| [in] | vaList | Varaible list of arguments |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | char * | responseBuffer, |
| int | responseBufferLen, | ||
| TimerTimeout | timeoutMs, | ||
| const ReaderFunc & | reader, | ||
| void * | user, | ||
| const char * | cmd, | ||
| va_list | vaList | ||
| ) |
Send command to WiConnect WiFi module.
| [in] | responseBuffer | Buffer to hold command response |
| [in] | responseBufferLen | Length of responseBuffer |
| [in] | timeoutMs | Maximum time in milliseconds this command should execute |
| [in] | reader | Callback for reading data to be read from host and send to module during command |
| [in] | user | User data struct used during read Callback. Library doesn't use this. Set NULL if not used. |
| [in] | cmd | WiConnect command to send to module |
| [in] | vaList | Varaible list of arguments |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | char * | responseBuffer, |
| int | responseBufferLen, | ||
| TimerTimeout | timeoutMs, | ||
| const ReaderFunc & | reader, | ||
| void * | user, | ||
| const char * | cmd, | ||
| ... | |||
| ) |
Send command to WiConnect WiFi module.
| [in] | responseBuffer | Buffer to hold command response |
| [in] | responseBufferLen | Length of responseBuffer |
| [in] | timeoutMs | Maximum time in milliseconds this command should execute |
| [in] | reader | Callback for reading data to be read from host and send to module during command |
| [in] | user | User data struct used during read Callback. Library doesn't use this. Set NULL if not used. |
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | TimerTimeout | timeoutMs, |
| const ReaderFunc & | reader, | ||
| void * | user, | ||
| const char * | cmd, | ||
| ... | |||
| ) |
Send command to WiConnect WiFi module.
This method uses the library internal buffer.
| [in] | timeoutMs | Maximum time in milliseconds this command should execute |
| [in] | reader | Callback for reading data to be read from host and send to module during command |
| [in] | user | User data struct used during read Callback. Library doesn't use this. Set NULL if not used. |
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | const ReaderFunc & | reader, |
| void * | user, | ||
| const char * | cmd, | ||
| ... | |||
| ) |
Send command to WiConnect WiFi module.
| [in] | reader | Callback for reading data to be read from host and send to module during command |
| [in] | user | User data struct used during read Callback. Library doesn't use this. Set NULL if not used. |
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | char * | responseBuffer, |
| int | responseBufferLen, | ||
| TimerTimeout | timeoutMs, | ||
| const char * | cmd, | ||
| ... | |||
| ) |
Send command to WiConnect WiFi module.
| [in] | responseBuffer | Buffer to hold command response |
| [in] | responseBufferLen | Length of responseBuffer |
| [in] | timeoutMs | Maximum time in milliseconds this command should execute |
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | const Callback & | completeCallback, |
| char * | responseBuffer, | ||
| int | responseBufferLen, | ||
| const char * | cmd, | ||
| ... | |||
| ) |
Send command to WiConnect WiFi module.
| [in] | completeCallback | Callback when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length |
| [in] | responseBuffer | Buffer to hold command response |
| [in] | responseBufferLen | Length of responseBuffer |
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | char * | responseBuffer, |
| int | responseBufferLen, | ||
| const char * | cmd, | ||
| ... | |||
| ) |
Send command to WiConnect WiFi module.
| [in] | responseBuffer | Buffer to hold command response |
| [in] | responseBufferLen | Length of responseBuffer |
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | const Callback & | completeCallback, |
| const char * | cmd, | ||
| ... | |||
| ) |
Send command to WiConnect WiFi module.
| [in] | completeCallback | Callback when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length |
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | const char * | cmd, |
| ... | |||
| ) |
Send command to WiConnect WiFi module.
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | const Callback & | completeCallback, |
| TimerTimeout | timeoutMs, | ||
| const char * | cmd, | ||
| ... | |||
| ) |
This method uses the library internal buffer
| [in] | completeCallback | Callback when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length |
| [in] | timeoutMs | Maximum time in milliseconds this command should execute |
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | TimerTimeout | timeoutMs, |
| const char * | cmd, | ||
| ... | |||
| ) |
Send command to WiConnect WiFi module.
This method uses the library internal buffer
| [in] | timeoutMs | Maximum time in milliseconds this command should execute |
| [in] | cmd | WiConnect command to send to module |
| WiconnectResult wiconnect::Wiconnect::sendCommand | ( | const char * | cmd, |
| va_list | vaList | ||
| ) |
| [in] | cmd | WiConnect command to send to module |
| [in] | vaList | Varaible list of arguments |
| void wiconnect::Wiconnect::stopCurrentCommand | ( | ) |
Stop the currently executing command.