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

API methods for sending commands to WiConnect WiFi module. More...

Functions

WiconnectResult wiconnect::Wiconnect::sendCommand (const Callback &completeCallback, char *responseBuffer, int responseBufferLen, int 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, int 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, int timeoutMs, const ReaderFunc &reader, void *user, const char *cmd,...)
 Send command to WiConnect WiFi module. More...
 
WiconnectResult wiconnect::Wiconnect::sendCommand (int 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, int 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, int timeoutMs, const char *cmd,...)
 
WiconnectResult wiconnect::Wiconnect::sendCommand (int 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...
 

Detailed Description

API methods for sending commands to WiConnect WiFi module.

Function Documentation

WiconnectResult wiconnect::Wiconnect::checkCurrentCommand ( )

Check the status of the currently executing command.

Refer to WiconnectResult for more information about the return code.

Note
This command is only applicable for non-blocking mode. Refer to Blocking / Non-blocking Modes.
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( const Callback completeCallback,
char *  responseBuffer,
int  responseBufferLen,
int  timeoutMs,
const ReaderFunc reader,
void *  user,
const char *  cmd,
va_list  vaList 
)

Send command to WiConnect WiFi module.

Note
Refer to Sending Commands To WiFi Module for more info
Parameters
[in]completeCallbackCallback when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length
[in]responseBufferBuffer to hold command response
[in]responseBufferLenLength of responseBuffer
[in]timeoutMsMaximum time in milliseconds this command should execute
[in]readerCallback for reading data to be read from host and send to module during command
[in]userUser data struct used during read Callback. Library doesn't use this. Set NULL if not used.
[in]cmdWiConnect command to send to module
[in]vaListVaraible list of arguments
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( char *  responseBuffer,
int  responseBufferLen,
int  timeoutMs,
const ReaderFunc reader,
void *  user,
const char *  cmd,
va_list  vaList 
)

Send command to WiConnect WiFi module.

Note
Refer to Sending Commands To WiFi Module for more info
Parameters
[in]responseBufferBuffer to hold command response
[in]responseBufferLenLength of responseBuffer
[in]timeoutMsMaximum time in milliseconds this command should execute
[in]readerCallback for reading data to be read from host and send to module during command
[in]userUser data struct used during read Callback. Library doesn't use this. Set NULL if not used.
[in]cmdWiConnect command to send to module
[in]vaListVaraible list of arguments
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( char *  responseBuffer,
int  responseBufferLen,
int  timeoutMs,
const ReaderFunc reader,
void *  user,
const char *  cmd,
  ... 
)

Send command to WiConnect WiFi module.

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]responseBufferBuffer to hold command response
[in]responseBufferLenLength of responseBuffer
[in]timeoutMsMaximum time in milliseconds this command should execute
[in]readerCallback for reading data to be read from host and send to module during command
[in]userUser data struct used during read Callback. Library doesn't use this. Set NULL if not used.
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( int  timeoutMs,
const ReaderFunc reader,
void *  user,
const char *  cmd,
  ... 
)

Send command to WiConnect WiFi module.

This method uses the library internal buffer.

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]timeoutMsMaximum time in milliseconds this command should execute
[in]readerCallback for reading data to be read from host and send to module during command
[in]userUser data struct used during read Callback. Library doesn't use this. Set NULL if not used.
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( const ReaderFunc reader,
void *  user,
const char *  cmd,
  ... 
)

Send command to WiConnect WiFi module.

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]readerCallback for reading data to be read from host and send to module during command
[in]userUser data struct used during read Callback. Library doesn't use this. Set NULL if not used.
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( char *  responseBuffer,
int  responseBufferLen,
int  timeoutMs,
const char *  cmd,
  ... 
)

Send command to WiConnect WiFi module.

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]responseBufferBuffer to hold command response
[in]responseBufferLenLength of responseBuffer
[in]timeoutMsMaximum time in milliseconds this command should execute
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( const Callback completeCallback,
char *  responseBuffer,
int  responseBufferLen,
const char *  cmd,
  ... 
)

Send command to WiConnect WiFi module.

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]completeCallbackCallback when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length
[in]responseBufferBuffer to hold command response
[in]responseBufferLenLength of responseBuffer
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( char *  responseBuffer,
int  responseBufferLen,
const char *  cmd,
  ... 
)

Send command to WiConnect WiFi module.

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]responseBufferBuffer to hold command response
[in]responseBufferLenLength of responseBuffer
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( const Callback completeCallback,
const char *  cmd,
  ... 
)

Send command to WiConnect WiFi module.

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]completeCallbackCallback when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( const char *  cmd,
  ... 
)

Send command to WiConnect WiFi module.

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( const Callback completeCallback,
int  timeoutMs,
const char *  cmd,
  ... 
)

This method uses the library internal buffer

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]completeCallbackCallback when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length
[in]timeoutMsMaximum time in milliseconds this command should execute
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( int  timeoutMs,
const char *  cmd,
  ... 
)

Send command to WiConnect WiFi module.

This method uses the library internal buffer

Note
Refer to Sending Commands To WiFi Module for more info
This method supports variable arguments
Parameters
[in]timeoutMsMaximum time in milliseconds this command should execute
[in]cmdWiConnect command to send to module
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::Wiconnect::sendCommand ( const char *  cmd,
va_list  vaList 
)
Note
Refer to Sending Commands To WiFi Module for more info
Parameters
[in]cmdWiConnect command to send to module
[in]vaListVaraible list of arguments
Returns
Result of method. See WiconnectResult
void wiconnect::Wiconnect::stopCurrentCommand ( )

Stop the currently executing command.

Note
This command is only applicable for non-blocking mode. Refer to Blocking / Non-blocking Modes.