![]() |
WiConnect Host Library- API Reference Guide | ||
The WiConnect Library runs on a host MCU and controls a WiConnect enabled WiFi module. This library is essentially a programming API for the WiConnect serial command set. More infomation about the serial command set may be found here: WiConnect Reference Guide
The library may be downloaded from here: WiConnect Repository
The WiConnect Library has multiple settings so as to allow for the most flexibility within a user's application.
Some of these configurations are as follows:
The WiConnect Library may be configured for either 'blocking' or 'non-blocking' operation:
In blocking mode, an API function will block until it completes. More details to come...
In non-blocking mode, an API function returns immediately. More details to come...
There are two cases when memory allocation is required:
In both cases, either static or dynamic memory allocation may be used.
In cases when memory allocation is needed, the API call requires a buffer pointer and length parameters. If both are supplied, the library uses the supplied external buffer. This is considered static allocation (however the buffer could have been dynamically allocated). The caller is responsible for maintaining the supplied buffer.
If, however, only the buffer length is supplied and the buffer pointer is NULL the Wiconnect Library will call the user supplied malloc() function. This is considered dynamic allocation. In this case, the library will maintain the buffer and release it when necessary using the user supplied free() function.
When applicable, the WiConnect Library will asynchronously process commands in the background. When the background processing completes, the supplied callback is called.
User commands may also be executed in the background using the enqueueCommand() API function.
More details to come...