ACKme
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: doc/html/group__api__core__macro.html
- Revision:
- 29:b6af04b77a56
- Parent:
- 26:8067e3d463d3
--- a/doc/html/group__api__core__macro.html Mon Oct 27 13:32:40 2014 -0700 +++ b/doc/html/group__api__core__macro.html Mon Oct 27 13:42:26 2014 -0700 @@ -141,6 +141,10 @@ #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gabb158b483cd6d8a8d2d4bf8d38bc9830">WICONNECT_SUCCEEDED</a>(result, func)   ((result = (func)) == <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a>)</td></tr> <tr class="memdesc:gabb158b483cd6d8a8d2d4bf8d38bc9830"><td class="mdescLeft"> </td><td class="mdescRight">Populates <em>result</em> with return value from <em>func</em>, returns TRUE if return value is WICONNECT_SUCCESS. <br /></td></tr> <tr class="separator:gabb158b483cd6d8a8d2d4bf8d38bc9830"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga436d782bd2cdce3696eadda1083416af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga436d782bd2cdce3696eadda1083416af"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga436d782bd2cdce3696eadda1083416af">WICONNECT_IS_PROCESSING</a>(result, func)   ((result = (func)) == <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0">wiconnect::WICONNECT_PROCESSING</a>)</td></tr> +<tr class="memdesc:ga436d782bd2cdce3696eadda1083416af"><td class="mdescLeft"> </td><td class="mdescRight">Populates <em>result</em> with return value from <em>func</em>, returns TRUE if return value is WICONNECT_PROCESSING. <br /></td></tr> +<tr class="separator:ga436d782bd2cdce3696eadda1083416af"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2aa16118029ab13ab41514cb8eb93ba7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2aa16118029ab13ab41514cb8eb93ba7"></a> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga2aa16118029ab13ab41514cb8eb93ba7">WICONNECT_MAX_CMD_SIZE</a>   128</td></tr> <tr class="memdesc:ga2aa16118029ab13ab41514cb8eb93ba7"><td class="mdescLeft"> </td><td class="mdescRight">The maximum command size that may be sent to the WiConnect WiFi module. <br /></td></tr> @@ -162,7 +166,7 @@ <tr class="memdesc:ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"><td class="mdescLeft"> </td><td class="mdescRight">The maximum Wiconnect Module flash filesystem filename length. <br /></td></tr> <tr class="separator:ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga580e5f45fee866c845e0d3fd1eb1744a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga580e5f45fee866c845e0d3fd1eb1744a"></a> -#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a>   0xFFFFFFFF</td></tr> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a>   0xFFFFFFFFUL</td></tr> <tr class="memdesc:ga580e5f45fee866c845e0d3fd1eb1744a"><td class="mdescLeft"> </td><td class="mdescRight">Never timeout. <br /></td></tr> <tr class="separator:ga580e5f45fee866c845e0d3fd1eb1744a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga12620767dcf50182fb9f72fe5d995301"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga12620767dcf50182fb9f72fe5d995301"></a> @@ -170,7 +174,7 @@ <tr class="memdesc:ga12620767dcf50182fb9f72fe5d995301"><td class="mdescLeft"> </td><td class="mdescRight">Timeout immediately. <br /></td></tr> <tr class="separator:ga12620767dcf50182fb9f72fe5d995301"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6d336ec791dcd22238d2fc4995fb9431"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6d336ec791dcd22238d2fc4995fb9431"></a> -#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga6d336ec791dcd22238d2fc4995fb9431">WICONNECT_FIRMWARE_UPDATE_TIMEOUT</a>   90000</td></tr> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga6d336ec791dcd22238d2fc4995fb9431">WICONNECT_FIRMWARE_UPDATE_TIMEOUT</a>   90000UL</td></tr> <tr class="memdesc:ga6d336ec791dcd22238d2fc4995fb9431"><td class="mdescLeft"> </td><td class="mdescRight">Default firmware update timeout in ms. <br /></td></tr> <tr class="separator:ga6d336ec791dcd22238d2fc4995fb9431"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad466ede4f07512308e38402d777d8380"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad466ede4f07512308e38402d777d8380"></a> @@ -189,6 +193,10 @@ #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gae7b6cfdff3a9aef465d5c4434937417d">WICONNECT_USE_DEFAULT_STRING_BUFFERS</a></td></tr> <tr class="memdesc:gae7b6cfdff3a9aef465d5c4434937417d"><td class="mdescLeft"> </td><td class="mdescRight">When defined enables certain conversion API functions to use a default buffer to store string. <br /></td></tr> <tr class="separator:gae7b6cfdff3a9aef465d5c4434937417d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga593c6629b59a853057cd6a5547ed3f4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga593c6629b59a853057cd6a5547ed3f4f"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga593c6629b59a853057cd6a5547ed3f4f">WICONNECT_GPIO_IRQ_ENABLED</a></td></tr> +<tr class="memdesc:ga593c6629b59a853057cd6a5547ed3f4f"><td class="mdescLeft"> </td><td class="mdescRight">When defined enables external interrupts on specified gpios. <br /></td></tr> +<tr class="separator:ga593c6629b59a853057cd6a5547ed3f4f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaaff0108d684631b2bb88e1f6c255e9ac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaff0108d684631b2bb88e1f6c255e9ac"></a> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gaaff0108d684631b2bb88e1f6c255e9ac">WICONNECT_DEFAULT_MALLOC</a>   malloc</td></tr> <tr class="memdesc:gaaff0108d684631b2bb88e1f6c255e9ac"><td class="mdescLeft"> </td><td class="mdescRight">When WICONNECT_ENABLE_MALLOC defined, this is the default malloc function. <br /></td></tr> @@ -217,6 +225,10 @@ #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a>   false</td></tr> <tr class="memdesc:ga347d0e1228e8174563c6bcf48de18401"><td class="mdescLeft"> </td><td class="mdescRight">The default blocking mode of the Library. <br /></td></tr> <tr class="separator:ga347d0e1228e8174563c6bcf48de18401"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga80e1660ca602aff9f95ccbb4822fad9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga80e1660ca602aff9f95ccbb4822fad9c"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga80e1660ca602aff9f95ccbb4822fad9c">WICONNECT_ENABLE_DEBUGGING</a></td></tr> +<tr class="memdesc:ga80e1660ca602aff9f95ccbb4822fad9c"><td class="mdescLeft"> </td><td class="mdescRight">If defined, enables low-level debugging. <br /></td></tr> +<tr class="separator:ga80e1660ca602aff9f95ccbb4822fad9c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa1dbeca66111f3a22d0ee6b122d69270"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa1dbeca66111f3a22d0ee6b122d69270"></a> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>   NC</td></tr> <tr class="memdesc:gaa1dbeca66111f3a22d0ee6b122d69270"><td class="mdescLeft"> </td><td class="mdescRight">Default value for a pin, Not connected. <br /></td></tr>
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02