![]() |
WiConnect Host Library- API Reference Guide | ||
Core macros. More...
Macros | |
#define | MIN(x, y) ((x) < (y) ? (x) : (y)) |
Computes the minimum of x and y. | |
#define | MAX(x, y) ((x) > (y) ? (x) : (y)) |
Computes the maximum of x and y. | |
#define | ALIGN_n(x, n) ((((uint32_t)x) + ((n)-1)) & ~((n)-1)) |
Align x to n bytes (n must be power of 2) | |
#define | ALIGN_8(x) ALIGN_n(x, 8) |
Align x to 8 bytes. | |
#define | ALIGN_4(x) ALIGN_n(x, 4) |
Align x to 4 bytes. | |
#define | ARRAY_COUNT(x) (sizeof (x) / sizeof *(x)) |
Return number of elements in static array x. | |
#define | WICONNECT_FAILED(result, func) ((int)(result = (func)) < (int)wiconnect::WICONNECT_SUCCESS) |
Populates result with return value from func, returns TRUE if return value contains error. | |
#define | WICONNECT_SUCCEEDED(result, func) ((result = (func)) == wiconnect::WICONNECT_SUCCESS) |
Populates result with return value from func, returns TRUE if return value is WICONNECT_SUCCESS. | |
#define | WICONNECT_MAX_CMD_SIZE 128 |
The maximum command size that may be sent to the WiConnect WiFi module. | |
#define | WICONNECT_MAX_VERSION_SIZE 96 |
The maximum WiConnect WiFi module version string size. | |
#define | WICONNECT_MAX_SOCKETS 8 |
The maximum number of simulanteous opened sockets. | |
#define | WICONNECT_MAX_HOST_SIZE 64 |
The maximum server string length. | |
#define | WICONNECT_MAX_FILENAME_SIZE 96 |
The maximum Wiconnect Module flash filesystem filename length. | |
#define | WICONNECT_WAIT_FOREVER 0xFFFFFFFF |
Never timeout. | |
#define | WICONNECT_NO_WAIT 0 |
Timeout immediately. | |
#define | WICONNECT_FIRMWARE_UPDATE_TIMEOUT 90000 |
Default firmware update timeout in ms. | |
#define | WICONNECT_ASYNC_TIMER_ENABLED |
When defined enables asynchronous command processing. | |
#define | WICONNECT_ENABLE_MALLOC |
When defined enables user supplied dynamic memory allocation. | |
#define | WICONNECT_SERIAL_RX_BUFFER |
When defined enables Host<->Wiconnect Module serial RX buffering. | |
#define | WICONNECT_USE_DEFAULT_STRING_BUFFERS |
When defined enables certain conversion API functions to use a default buffer to store string. | |
#define | WICONNECT_DEFAULT_MALLOC malloc |
When WICONNECT_ENABLE_MALLOC defined, this is the default malloc function. | |
#define | WICONNECT_DEFAULT_FREE free |
When WICONNECT_ENABLE_MALLOC defined, this is the default free function. | |
#define | WICONNECT_DEFAULT_BAUD 115200 |
The default Host<->Wiconnect Module serial BAUD rate. | |
#define | WICONNECT_DEFAULT_TIMEOUT 3000 |
The default command timeout (i.e max command executing time) | |
#define | WICONNECT_MAX_QUEUED_COMMANDS 8 |
When WICONNECT_ASYNC_TIMER_ENABLED, this specifies the max number of asynchronous commands that may be queued. | |
#define | WICONNECT_DEFAULT_COMMAND_PROCESSING_PERIOD 50 |
When WICONNECT_ASYNC_TIMER_ENABLED, this specifies the period in milliseconds commands should be processed. | |
#define | WICONNECT_DEFAULT_NONBLOCKING false |
The default blocking mode of the Library. | |
#define | PIN_NC NC |
Default value for a pin, Not connected. | |
#define | delayMs(ms) wait_ms(ms) |
Function to stop processor for specified number of milliseconds. | |
Core macros.