Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
Diff: api/WiconnectInterface.h
- Revision:
- 34:2616445d0823
- Parent:
- 29:b6af04b77a56
- Child:
- 37:5ee74d72efe4
--- a/api/WiconnectInterface.h Mon Oct 27 14:16:03 2014 -0700 +++ b/api/WiconnectInterface.h Wed Nov 26 23:46:00 2014 -0800 @@ -163,6 +163,17 @@ /** * @ingroup api_core_misc * + * @brief Return TRUE if the WiFi module's firmware supports the SDK version, + * FALSE if the WiFi module's firmware needs to be updated. See + * @ref updateFirmware() to update the module's firmware. + * + * @return TRUE WiFi firmware version is supported, FALSE else + */ + bool updateRequired(); + + /** + * @ingroup api_core_misc + * * @brief Toggle the WiConnect WiFi module reset signal. * * @note This only resets the module if the library was instantiated with the 'reset' pin @@ -712,6 +723,16 @@ */ static const char* getWiconnectResultStr(WiconnectResult wiconnectResult); + /** + * @ingroup conversion_util + * + * @brief Converts wiconnect version string to uint32_t representation. + * + * @param[in] Output of @ref getVersion() API call. + * @return 32bit integer WiConnect firmware version + */ + static uint32_t wiconnectVersionToInt(char *versionStr); + protected: #ifdef WICONNECT_ENABLE_MALLOC @@ -728,6 +749,7 @@ volatile bool commandExecuting; bool initialized; + bool needUpdate; bool nonBlocking; PinToGpioMapper pinToGpioMapper;