374 lines
36 KiB
HTML
374 lines
36 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Adafruit IO Arduino Library: AdafruitIO_Ethernet Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Adafruit IO Arduino Library
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="class_adafruit_i_o___ethernet-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">AdafruitIO_Ethernet Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class for interfacing with the Adafruit Ethernet FeatherWing.
|
|
<a href="class_adafruit_i_o___ethernet.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_adafruit_i_o___ethernet_8h_source.html">AdafruitIO_Ethernet.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for AdafruitIO_Ethernet:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_adafruit_i_o___ethernet.png" usemap="#AdafruitIO_5FEthernet_map" alt=""/>
|
|
<map id="AdafruitIO_5FEthernet_map" name="AdafruitIO_5FEthernet_map">
|
|
<area href="class_adafruit_i_o.html" title="Class for interacting with Adafruit IO. " alt="AdafruitIO" shape="rect" coords="0,0,124,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:af1a988bb7893829b9b79ffeedc79e01b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o___ethernet.html#af1a988bb7893829b9b79ffeedc79e01b">AdafruitIO_Ethernet</a> (const char *user, const char *key)</td></tr>
|
|
<tr class="memdesc:af1a988bb7893829b9b79ffeedc79e01b"><td class="mdescLeft"> </td><td class="mdescRight">Instanciates an Adafruit Ethernet FeatherWing. <a href="#af1a988bb7893829b9b79ffeedc79e01b">More...</a><br /></td></tr>
|
|
<tr class="separator:af1a988bb7893829b9b79ffeedc79e01b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad21e9b8dfc58c9d24e53b16c0f61d04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o___ethernet.html#aad21e9b8dfc58c9d24e53b16c0f61d04">networkStatus</a> ()</td></tr>
|
|
<tr class="memdesc:aad21e9b8dfc58c9d24e53b16c0f61d04"><td class="mdescLeft"> </td><td class="mdescRight">Checks the connection status between the Ethernet FeatherWing and Adafruit IO. <a href="#aad21e9b8dfc58c9d24e53b16c0f61d04">More...</a><br /></td></tr>
|
|
<tr class="separator:aad21e9b8dfc58c9d24e53b16c0f61d04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac338282e3e033ab9639319e3de16c07c"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o___ethernet.html#ac338282e3e033ab9639319e3de16c07c">connectionType</a> ()</td></tr>
|
|
<tr class="memdesc:ac338282e3e033ab9639319e3de16c07c"><td class="mdescLeft"> </td><td class="mdescRight">Defines network module type. <a href="#ac338282e3e033ab9639319e3de16c07c">More...</a><br /></td></tr>
|
|
<tr class="separator:ac338282e3e033ab9639319e3de16c07c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_adafruit_i_o"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_adafruit_i_o')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_adafruit_i_o.html">AdafruitIO</a></td></tr>
|
|
<tr class="memitem:ad00a4c752e0e5eb1f8f0bec331c3a8b8 inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#ad00a4c752e0e5eb1f8f0bec331c3a8b8">AdafruitIO</a> (const char *user, const char *key)</td></tr>
|
|
<tr class="memdesc:ad00a4c752e0e5eb1f8f0bec331c3a8b8 inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Instantiate the AIO object. <a href="class_adafruit_i_o.html#ad00a4c752e0e5eb1f8f0bec331c3a8b8">More...</a><br /></td></tr>
|
|
<tr class="separator:ad00a4c752e0e5eb1f8f0bec331c3a8b8 inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab48e9f46e4fa02ca48da185e15298480 inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a id="ab48e9f46e4fa02ca48da185e15298480"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#ab48e9f46e4fa02ca48da185e15298480">~AdafruitIO</a> ()</td></tr>
|
|
<tr class="memdesc:ab48e9f46e4fa02ca48da185e15298480 inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Destructor to end the AIO object. <br /></td></tr>
|
|
<tr class="separator:ab48e9f46e4fa02ca48da185e15298480 inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ccbbb19dee3f329ad94a780e97cc381 inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a id="a3ccbbb19dee3f329ad94a780e97cc381"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a3ccbbb19dee3f329ad94a780e97cc381">connect</a> ()</td></tr>
|
|
<tr class="memdesc:a3ccbbb19dee3f329ad94a780e97cc381 inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Connects to AIO, setting up using parameters set when the class is instantiated. <br /></td></tr>
|
|
<tr class="separator:a3ccbbb19dee3f329ad94a780e97cc381 inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9241cda72188be719d8b14b562324174 inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a id="a9241cda72188be719d8b14b562324174"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a9241cda72188be719d8b14b562324174">wifi_disconnect</a> ()</td></tr>
|
|
<tr class="memdesc:a9241cda72188be719d8b14b562324174 inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects from WiFi. <br /></td></tr>
|
|
<tr class="separator:a9241cda72188be719d8b14b562324174 inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1006551006e1c780a67d36903bf9332d inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a1006551006e1c780a67d36903bf9332d">run</a> (uint16_t busywait_ms=0, bool fail_fast=false)</td></tr>
|
|
<tr class="memdesc:a1006551006e1c780a67d36903bf9332d inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Must be called frequently to keep AIO connections alive. When called with no arguments <a class="el" href="class_adafruit_i_o.html#a1006551006e1c780a67d36903bf9332d" title="Must be called frequently to keep AIO connections alive. When called with no arguments run() will try...">run()</a> will try to repair MQTT and WiFi connections before returning. To avoid potentially long timeout delays, sketches can use the busywait_ms and fail_fast arguments to return an imperfect status quickly. The calling sketch will then need to respond appropriately to that status. <a href="class_adafruit_i_o.html#a1006551006e1c780a67d36903bf9332d">More...</a><br /></td></tr>
|
|
<tr class="separator:a1006551006e1c780a67d36903bf9332d inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3afb61065ef04acce431ba305e799d3e inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_adafruit_i_o___feed.html">AdafruitIO_Feed</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a3afb61065ef04acce431ba305e799d3e">feed</a> (const char *name)</td></tr>
|
|
<tr class="memdesc:a3afb61065ef04acce431ba305e799d3e inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO feed. <a href="class_adafruit_i_o.html#a3afb61065ef04acce431ba305e799d3e">More...</a><br /></td></tr>
|
|
<tr class="separator:a3afb61065ef04acce431ba305e799d3e inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab81a46b288aafe74cd874fdd09e765ef inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_adafruit_i_o___feed.html">AdafruitIO_Feed</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#ab81a46b288aafe74cd874fdd09e765ef">feed</a> (const char *name, const char *owner)</td></tr>
|
|
<tr class="memdesc:ab81a46b288aafe74cd874fdd09e765ef inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO feed. <a href="class_adafruit_i_o.html#ab81a46b288aafe74cd874fdd09e765ef">More...</a><br /></td></tr>
|
|
<tr class="separator:ab81a46b288aafe74cd874fdd09e765ef inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f3332cae4a31d41f364b88046f56ae2 inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_adafruit_i_o___group.html">AdafruitIO_Group</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a5f3332cae4a31d41f364b88046f56ae2">group</a> (const char *name)</td></tr>
|
|
<tr class="memdesc:a5f3332cae4a31d41f364b88046f56ae2 inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO group. <a href="class_adafruit_i_o.html#a5f3332cae4a31d41f364b88046f56ae2">More...</a><br /></td></tr>
|
|
<tr class="separator:a5f3332cae4a31d41f364b88046f56ae2 inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a967c1bd7137e7328308c0dee8884ec5f inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_adafruit_i_o___dashboard.html">AdafruitIO_Dashboard</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a967c1bd7137e7328308c0dee8884ec5f">dashboard</a> (const char *name)</td></tr>
|
|
<tr class="memdesc:a967c1bd7137e7328308c0dee8884ec5f inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO dashboard. <a href="class_adafruit_i_o.html#a967c1bd7137e7328308c0dee8884ec5f">More...</a><br /></td></tr>
|
|
<tr class="separator:a967c1bd7137e7328308c0dee8884ec5f inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48acec3d0fa233369d9f493f9aee363d inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_adafruit_i_o___time.html">AdafruitIO_Time</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a48acec3d0fa233369d9f493f9aee363d">time</a> (<a class="el" href="_adafruit_i_o___definitions_8h.html#af58cf71b871e96df60a5065cdc7a2062">aio_time_format_t</a> format)</td></tr>
|
|
<tr class="memdesc:a48acec3d0fa233369d9f493f9aee363d inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO time. <a href="class_adafruit_i_o.html#a48acec3d0fa233369d9f493f9aee363d">More...</a><br /></td></tr>
|
|
<tr class="separator:a48acec3d0fa233369d9f493f9aee363d inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73b82ba6651748aa51347fe84b886e3f inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">const __FlashStringHelper * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a73b82ba6651748aa51347fe84b886e3f">statusText</a> ()</td></tr>
|
|
<tr class="memdesc:a73b82ba6651748aa51347fe84b886e3f inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Provide status explanation strings. <a href="class_adafruit_i_o.html#a73b82ba6651748aa51347fe84b886e3f">More...</a><br /></td></tr>
|
|
<tr class="separator:a73b82ba6651748aa51347fe84b886e3f inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23f598b5f0aa7d5c85d4e400275dacc9 inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a23f598b5f0aa7d5c85d4e400275dacc9">status</a> ()</td></tr>
|
|
<tr class="memdesc:a23f598b5f0aa7d5c85d4e400275dacc9 inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Status check. <a href="class_adafruit_i_o.html#a23f598b5f0aa7d5c85d4e400275dacc9">More...</a><br /></td></tr>
|
|
<tr class="separator:a23f598b5f0aa7d5c85d4e400275dacc9 inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86db7b788f6ef0fd9b6803d32406fc87 inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a86db7b788f6ef0fd9b6803d32406fc87">mqttStatus</a> (bool fail_fast=false)</td></tr>
|
|
<tr class="memdesc:a86db7b788f6ef0fd9b6803d32406fc87 inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Returns MQTT connection status. <a href="class_adafruit_i_o.html#a86db7b788f6ef0fd9b6803d32406fc87">More...</a><br /></td></tr>
|
|
<tr class="separator:a86db7b788f6ef0fd9b6803d32406fc87 inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5fd4a19cec76ca6af4f97e0eadfce8b inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#aa5fd4a19cec76ca6af4f97e0eadfce8b">boardID</a> ()</td></tr>
|
|
<tr class="memdesc:aa5fd4a19cec76ca6af4f97e0eadfce8b inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Identify the board. <a href="class_adafruit_i_o.html#aa5fd4a19cec76ca6af4f97e0eadfce8b">More...</a><br /></td></tr>
|
|
<tr class="separator:aa5fd4a19cec76ca6af4f97e0eadfce8b inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee3d9710e0b73ad65f7891ddb4ec8dd5 inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#aee3d9710e0b73ad65f7891ddb4ec8dd5">boardType</a> ()</td></tr>
|
|
<tr class="memdesc:aee3d9710e0b73ad65f7891ddb4ec8dd5 inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Identify the board type. <a href="class_adafruit_i_o.html#aee3d9710e0b73ad65f7891ddb4ec8dd5">More...</a><br /></td></tr>
|
|
<tr class="separator:aee3d9710e0b73ad65f7891ddb4ec8dd5 inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1851f3dfbfe7d8047fbea79f334398fc inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a1851f3dfbfe7d8047fbea79f334398fc">version</a> ()</td></tr>
|
|
<tr class="memdesc:a1851f3dfbfe7d8047fbea79f334398fc inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Identify the software version. <a href="class_adafruit_i_o.html#a1851f3dfbfe7d8047fbea79f334398fc">More...</a><br /></td></tr>
|
|
<tr class="separator:a1851f3dfbfe7d8047fbea79f334398fc inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed27c610d8942ca8f2f3794348c483ca inherit pub_methods_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#aed27c610d8942ca8f2f3794348c483ca">userAgent</a> ()</td></tr>
|
|
<tr class="memdesc:aed27c610d8942ca8f2f3794348c483ca inherit pub_methods_class_adafruit_i_o"><td class="mdescLeft"> </td><td class="mdescRight">Identify the user agent. <a href="class_adafruit_i_o.html#aed27c610d8942ca8f2f3794348c483ca">More...</a><br /></td></tr>
|
|
<tr class="separator:aed27c610d8942ca8f2f3794348c483ca inherit pub_methods_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a36d6a67a38a699b765136d0491c5ce64"><td class="memItemLeft" align="right" valign="top"><a id="a36d6a67a38a699b765136d0491c5ce64"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o___ethernet.html#a36d6a67a38a699b765136d0491c5ce64">_connect</a> ()</td></tr>
|
|
<tr class="memdesc:a36d6a67a38a699b765136d0491c5ce64"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to connect Ethernet FeatherWing to Adafruit IO. <br /></td></tr>
|
|
<tr class="separator:a36d6a67a38a699b765136d0491c5ce64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a051677b1215824eb0505f1a711d553fb"><td class="memItemLeft" align="right" valign="top"><a id="a051677b1215824eb0505f1a711d553fb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o___ethernet.html#a051677b1215824eb0505f1a711d553fb">_disconnect</a> ()</td></tr>
|
|
<tr class="memdesc:a051677b1215824eb0505f1a711d553fb"><td class="mdescLeft"> </td><td class="mdescRight">Disconnect the ethernet connection. <br /></td></tr>
|
|
<tr class="separator:a051677b1215824eb0505f1a711d553fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a0fb5b49bc33b6772929a15aae3ba178e"><td class="memItemLeft" align="right" valign="top">byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o___ethernet.html#a0fb5b49bc33b6772929a15aae3ba178e">_mac</a> [6]</td></tr>
|
|
<tr class="separator:a0fb5b49bc33b6772929a15aae3ba178e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a13fdfe76365308ea11f3f646804014"><td class="memItemLeft" align="right" valign="top">EthernetClient * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o___ethernet.html#a5a13fdfe76365308ea11f3f646804014">_client</a></td></tr>
|
|
<tr class="separator:a5a13fdfe76365308ea11f3f646804014"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_class_adafruit_i_o"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_adafruit_i_o')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_adafruit_i_o.html">AdafruitIO</a></td></tr>
|
|
<tr class="memitem:ad93ebea2feb9f99f23e273cd8a372dc5 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#ad93ebea2feb9f99f23e273cd8a372dc5">_status</a> = AIO_IDLE</td></tr>
|
|
<tr class="separator:ad93ebea2feb9f99f23e273cd8a372dc5 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d78b51b77dc3e786044726d93cff4b4 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a4d78b51b77dc3e786044726d93cff4b4">_last_ping</a></td></tr>
|
|
<tr class="separator:a4d78b51b77dc3e786044726d93cff4b4 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1276ef53722ba350635f4b80819f718c inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a1276ef53722ba350635f4b80819f718c">_last_mqtt_connect</a> = 0</td></tr>
|
|
<tr class="separator:a1276ef53722ba350635f4b80819f718c inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a828dbd1fed50a027c8291dc14fc37195 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">Adafruit_MQTT * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a828dbd1fed50a027c8291dc14fc37195">_mqtt</a></td></tr>
|
|
<tr class="separator:a828dbd1fed50a027c8291dc14fc37195 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5953719b782781c1b82521087fbc600 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">HttpClient * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#af5953719b782781c1b82521087fbc600">_http</a></td></tr>
|
|
<tr class="separator:af5953719b782781c1b82521087fbc600 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c2ae0c9a9fcc5ea2f43d66efad83b9f inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a5c2ae0c9a9fcc5ea2f43d66efad83b9f">_version</a> [10]</td></tr>
|
|
<tr class="separator:a5c2ae0c9a9fcc5ea2f43d66efad83b9f inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad96742c09949228d9ad716519162c8e9 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#ad96742c09949228d9ad716519162c8e9">_host</a> = "io.adafruit.com"</td></tr>
|
|
<tr class="separator:ad96742c09949228d9ad716519162c8e9 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1be2f700dd4c358585977e45bc107e89 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a1be2f700dd4c358585977e45bc107e89">_mqtt_port</a> = 8883</td></tr>
|
|
<tr class="separator:a1be2f700dd4c358585977e45bc107e89 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c17d619328831d9698751d579cc5d8f inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a6c17d619328831d9698751d579cc5d8f">_mqtt_eth_port</a></td></tr>
|
|
<tr class="separator:a6c17d619328831d9698751d579cc5d8f inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a386a449b8ed6a1a3f4a794f2268ef81a inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a386a449b8ed6a1a3f4a794f2268ef81a">_http_port</a> = 443</td></tr>
|
|
<tr class="separator:a386a449b8ed6a1a3f4a794f2268ef81a inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a948f72541fc2ce369e61069eddbee770 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a948f72541fc2ce369e61069eddbee770">_packetread_timeout</a></td></tr>
|
|
<tr class="separator:a948f72541fc2ce369e61069eddbee770 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb1001fe93bcd52a8146fe6807c2b89a inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#abb1001fe93bcd52a8146fe6807c2b89a">_username</a></td></tr>
|
|
<tr class="separator:abb1001fe93bcd52a8146fe6807c2b89a inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67e85df7be6f735ac07bbb15c0318e0d inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a67e85df7be6f735ac07bbb15c0318e0d">_key</a></td></tr>
|
|
<tr class="separator:a67e85df7be6f735ac07bbb15c0318e0d inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae15c2f177bab5b8ee6fbefd50cbe6221 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#ae15c2f177bab5b8ee6fbefd50cbe6221">_err_topic</a></td></tr>
|
|
<tr class="separator:ae15c2f177bab5b8ee6fbefd50cbe6221 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af016992f171d0640d728d2f7df979b3b inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#af016992f171d0640d728d2f7df979b3b">_throttle_topic</a></td></tr>
|
|
<tr class="separator:af016992f171d0640d728d2f7df979b3b inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0bbd54c82308aed36382fc8aa2e4a32c inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a0bbd54c82308aed36382fc8aa2e4a32c">_user_agent</a></td></tr>
|
|
<tr class="separator:a0bbd54c82308aed36382fc8aa2e4a32c inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adab122f11082e770d81525754512b1b0 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">Adafruit_MQTT_Subscribe * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#adab122f11082e770d81525754512b1b0">_err_sub</a></td></tr>
|
|
<tr class="separator:adab122f11082e770d81525754512b1b0 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1813d6ecea0526063bca7f47c5aec234 inherit pro_attribs_class_adafruit_i_o"><td class="memItemLeft" align="right" valign="top">Adafruit_MQTT_Subscribe * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a1813d6ecea0526063bca7f47c5aec234">_throttle_sub</a></td></tr>
|
|
<tr class="separator:a1813d6ecea0526063bca7f47c5aec234 inherit pro_attribs_class_adafruit_i_o"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class for interfacing with the Adafruit Ethernet FeatherWing. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af1a988bb7893829b9b79ffeedc79e01b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af1a988bb7893829b9b79ffeedc79e01b">◆ </a></span>AdafruitIO_Ethernet()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">AdafruitIO_Ethernet::AdafruitIO_Ethernet </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>user</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Instanciates an Adafruit Ethernet FeatherWing. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*user</td><td>Reference to a valid Adafruit IO Username. </td></tr>
|
|
<tr><td class="paramname">*key</td><td>Reference to a valid Adafruit IO Key. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aad21e9b8dfc58c9d24e53b16c0f61d04"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad21e9b8dfc58c9d24e53b16c0f61d04">◆ </a></span>networkStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> AdafruitIO_Ethernet::networkStatus </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks the connection status between the Ethernet FeatherWing and Adafruit IO. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if connected to Adafruit IO, otherwise False. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="class_adafruit_i_o.html#a80f3b21779818214d21264b8790f9c7f">AdafruitIO</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac338282e3e033ab9639319e3de16c07c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac338282e3e033ab9639319e3de16c07c">◆ </a></span>connectionType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* AdafruitIO_Ethernet::connectionType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Defines network module type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>String "ethernet_wing" </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="class_adafruit_i_o.html#a03b4b191ffe4a2b585f43865121b4fc0">AdafruitIO</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a0fb5b49bc33b6772929a15aae3ba178e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0fb5b49bc33b6772929a15aae3ba178e">◆ </a></span>_mac</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">byte AdafruitIO_Ethernet::_mac[6]</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">= {0xDE, 0xAD, 0xBE,</div><div class="line"> 0xEF, 0xFE, 0xED}</div></div><!-- fragment --><p>Ethernet FeatherWing MAC Address </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a13fdfe76365308ea11f3f646804014"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a13fdfe76365308ea11f3f646804014">◆ </a></span>_client</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">EthernetClient* AdafruitIO_Ethernet::_client</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Reference to EthernetClient, _client </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/<a class="el" href="_adafruit_i_o___ethernet_8h_source.html">AdafruitIO_Ethernet.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|