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__network__types.html
- Revision:
- 26:8067e3d463d3
- Parent:
- 21:17bb3eddcbae
- Child:
- 29:b6af04b77a56
--- a/doc/html/group__api__network__types.html Tue Aug 26 16:53:06 2014 -0700 +++ b/doc/html/group__api__network__types.html Thu Oct 23 15:16:06 2014 -0700 @@ -47,7 +47,7 @@ <li><a href="modules.html"><span>Library API</span></a></li> <li><a href="examples.html"><span>API Examples</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> - <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect Reference Manual</span></a></li> + <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect Reference Manual</span></a></li> <li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> @@ -156,6 +156,28 @@ }</td></tr> <tr class="memdesc:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="mdescLeft"> </td><td class="mdescRight">Network connection status. <a href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">More...</a><br /></td></tr> <tr class="separator:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5f6f5c916a5dd1676f98da7fa511451d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">wiconnect::NetworkJoinResult</a> { <br /> +  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da2ac6866940725552e31532002ef649a5">wiconnect::NETWORK_JOIN_RESULT_NONE</a>, +<br /> +  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451dabfbb179ad94f8d5a57a9da86de9c65a8">wiconnect::NETWORK_JOIN_RESULT_SUCCESS</a>, +<br /> +  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da60569216928bd30142e2e143eaf58475">wiconnect::NETWORK_JOIN_RESULT_JOINING</a>, +<br /> +  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451daea6aa0a779a2823eadafa82dda6b7304">wiconnect::NETWORK_JOIN_RESULT_NO_SSID</a>, +<br /> +  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da02f32115d4a39e6028e5ebb4944f0bec">wiconnect::NETWORK_JOIN_RESULT_NO_PASSWORD</a>, +<br /> +  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451dabb8da6425a24810668eade3488113957">wiconnect::NETWORK_JOIN_RESULT_BAD_SECURITY</a>, +<br /> +  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da5c790fb0440c39d95ec785e1c31c3cb2">wiconnect::NETWORK_JOIN_RESULT_NOT_FOUND</a>, +<br /> +  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da76b3ad647f00a3dc52e71e4ed670e7dc">wiconnect::NETWORK_JOIN_RESULT_FAILED</a>, +<br /> +  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451daed880c261bae590a5f59aebb01b6912c">wiconnect::NETWORK_JOIN_RESULT_ABORTED</a> +<br /> + }</td></tr> +<tr class="memdesc:ga5f6f5c916a5dd1676f98da7fa511451d"><td class="mdescLeft"> </td><td class="mdescRight">Network connection status. <a href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">More...</a><br /></td></tr> +<tr class="separator:ga5f6f5c916a5dd1676f98da7fa511451d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac5aead2b4cca0122a60168e75ea41d36"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a> { <br />   <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a2911018510263b4d6db772cf6ea69385">wiconnect::NETWORK_RSSI_EXCELLENT</a> = 0, <br /> @@ -179,6 +201,51 @@ <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Network Types. </p> <h2 class="groupheader">Enumeration Type Documentation</h2> +<a class="anchor" id="ga5f6f5c916a5dd1676f98da7fa511451d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">wiconnect::NetworkJoinResult</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Network connection status. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da2ac6866940725552e31532002ef649a5"></a>NETWORK_JOIN_RESULT_NONE </td><td class="fielddoc"> +<p>Haven't attempted to join. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451dabfbb179ad94f8d5a57a9da86de9c65a8"></a>NETWORK_JOIN_RESULT_SUCCESS </td><td class="fielddoc"> +<p>Successfully joined the network. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da60569216928bd30142e2e143eaf58475"></a>NETWORK_JOIN_RESULT_JOINING </td><td class="fielddoc"> +<p>Currently attempting to join. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451daea6aa0a779a2823eadafa82dda6b7304"></a>NETWORK_JOIN_RESULT_NO_SSID </td><td class="fielddoc"> +<p>The SSID has not be configured. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da02f32115d4a39e6028e5ebb4944f0bec"></a>NETWORK_JOIN_RESULT_NO_PASSWORD </td><td class="fielddoc"> +<p>The network requires a password and none has been set. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451dabb8da6425a24810668eade3488113957"></a>NETWORK_JOIN_RESULT_BAD_SECURITY </td><td class="fielddoc"> +<p>The specified security type is not supported by the network. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da5c790fb0440c39d95ec785e1c31c3cb2"></a>NETWORK_JOIN_RESULT_NOT_FOUND </td><td class="fielddoc"> +<p>The network with the configured SSID was not found. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da76b3ad647f00a3dc52e71e4ed670e7dc"></a>NETWORK_JOIN_RESULT_FAILED </td><td class="fielddoc"> +<p>Failed to join the network. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451daed880c261bae590a5f59aebb01b6912c"></a>NETWORK_JOIN_RESULT_ABORTED </td><td class="fielddoc"> +<p>Joining was aborted (via command) </p> +</td></tr> +</table> + +<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00236">236</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p> + +</div> +</div> <a class="anchor" id="gac5aead2b4cca0122a60168e75ea41d36"></a> <div class="memitem"> <div class="memproto"> @@ -211,7 +278,7 @@ </td></tr> </table> -<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00231">231</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p> +<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00253">253</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p> </div> </div> @@ -241,7 +308,7 @@ </td></tr> </table> -<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00219">219</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p> +<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00224">224</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p> </div> </div>