1125 lines
55 KiB
HTML
1125 lines
55 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 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="#friends">Friends</a> |
|
|
<a href="class_adafruit_i_o-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">AdafruitIO Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class for interacting with Adafruit IO.
|
|
<a href="class_adafruit_i_o.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_adafruit_i_o_8h_source.html">AdafruitIO.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for AdafruitIO:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_adafruit_i_o.png" usemap="#AdafruitIO_map" alt=""/>
|
|
<map id="AdafruitIO_map" name="AdafruitIO_map">
|
|
<area href="class_adafruit_i_o___ethernet.html" title="Class for interfacing with the Adafruit Ethernet FeatherWing. " alt="AdafruitIO_Ethernet" shape="rect" coords="0,56,124,80"/>
|
|
<area href="class_adafruit_i_o___f_o_n_a.html" title="Class for interfacing with an Adafruit FONA Ceullar Module. " alt="AdafruitIO_FONA" shape="rect" coords="134,56,258,80"/>
|
|
</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:ad00a4c752e0e5eb1f8f0bec331c3a8b8"><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"><td class="mdescLeft"> </td><td class="mdescRight">Instantiate the AIO object. <a href="#ad00a4c752e0e5eb1f8f0bec331c3a8b8">More...</a><br /></td></tr>
|
|
<tr class="separator:ad00a4c752e0e5eb1f8f0bec331c3a8b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab48e9f46e4fa02ca48da185e15298480"><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"><td class="mdescLeft"> </td><td class="mdescRight">Destructor to end the AIO object. <br /></td></tr>
|
|
<tr class="separator:ab48e9f46e4fa02ca48da185e15298480"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ccbbb19dee3f329ad94a780e97cc381"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9241cda72188be719d8b14b562324174"><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"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects from WiFi. <br /></td></tr>
|
|
<tr class="separator:a9241cda72188be719d8b14b562324174"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1006551006e1c780a67d36903bf9332d"><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"><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="#a1006551006e1c780a67d36903bf9332d">More...</a><br /></td></tr>
|
|
<tr class="separator:a1006551006e1c780a67d36903bf9332d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3afb61065ef04acce431ba305e799d3e"><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"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO feed. <a href="#a3afb61065ef04acce431ba305e799d3e">More...</a><br /></td></tr>
|
|
<tr class="separator:a3afb61065ef04acce431ba305e799d3e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab81a46b288aafe74cd874fdd09e765ef"><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"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO feed. <a href="#ab81a46b288aafe74cd874fdd09e765ef">More...</a><br /></td></tr>
|
|
<tr class="separator:ab81a46b288aafe74cd874fdd09e765ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f3332cae4a31d41f364b88046f56ae2"><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"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO group. <a href="#a5f3332cae4a31d41f364b88046f56ae2">More...</a><br /></td></tr>
|
|
<tr class="separator:a5f3332cae4a31d41f364b88046f56ae2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a967c1bd7137e7328308c0dee8884ec5f"><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"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO dashboard. <a href="#a967c1bd7137e7328308c0dee8884ec5f">More...</a><br /></td></tr>
|
|
<tr class="separator:a967c1bd7137e7328308c0dee8884ec5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48acec3d0fa233369d9f493f9aee363d"><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"><td class="mdescLeft"> </td><td class="mdescRight">Create a new AIO time. <a href="#a48acec3d0fa233369d9f493f9aee363d">More...</a><br /></td></tr>
|
|
<tr class="separator:a48acec3d0fa233369d9f493f9aee363d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73b82ba6651748aa51347fe84b886e3f"><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"><td class="mdescLeft"> </td><td class="mdescRight">Provide status explanation strings. <a href="#a73b82ba6651748aa51347fe84b886e3f">More...</a><br /></td></tr>
|
|
<tr class="separator:a73b82ba6651748aa51347fe84b886e3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23f598b5f0aa7d5c85d4e400275dacc9"><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"><td class="mdescLeft"> </td><td class="mdescRight">Status check. <a href="#a23f598b5f0aa7d5c85d4e400275dacc9">More...</a><br /></td></tr>
|
|
<tr class="separator:a23f598b5f0aa7d5c85d4e400275dacc9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a80f3b21779818214d21264b8790f9c7f"><td class="memItemLeft" align="right" valign="top">virtual <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#a80f3b21779818214d21264b8790f9c7f">networkStatus</a> ()=0</td></tr>
|
|
<tr class="memdesc:a80f3b21779818214d21264b8790f9c7f"><td class="mdescLeft"> </td><td class="mdescRight">Returns network module status. <a href="#a80f3b21779818214d21264b8790f9c7f">More...</a><br /></td></tr>
|
|
<tr class="separator:a80f3b21779818214d21264b8790f9c7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86db7b788f6ef0fd9b6803d32406fc87"><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"><td class="mdescLeft"> </td><td class="mdescRight">Returns MQTT connection status. <a href="#a86db7b788f6ef0fd9b6803d32406fc87">More...</a><br /></td></tr>
|
|
<tr class="separator:a86db7b788f6ef0fd9b6803d32406fc87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5fd4a19cec76ca6af4f97e0eadfce8b"><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"><td class="mdescLeft"> </td><td class="mdescRight">Identify the board. <a href="#aa5fd4a19cec76ca6af4f97e0eadfce8b">More...</a><br /></td></tr>
|
|
<tr class="separator:aa5fd4a19cec76ca6af4f97e0eadfce8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee3d9710e0b73ad65f7891ddb4ec8dd5"><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"><td class="mdescLeft"> </td><td class="mdescRight">Identify the board type. <a href="#aee3d9710e0b73ad65f7891ddb4ec8dd5">More...</a><br /></td></tr>
|
|
<tr class="separator:aee3d9710e0b73ad65f7891ddb4ec8dd5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1851f3dfbfe7d8047fbea79f334398fc"><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"><td class="mdescLeft"> </td><td class="mdescRight">Identify the software version. <a href="#a1851f3dfbfe7d8047fbea79f334398fc">More...</a><br /></td></tr>
|
|
<tr class="separator:a1851f3dfbfe7d8047fbea79f334398fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed27c610d8942ca8f2f3794348c483ca"><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"><td class="mdescLeft"> </td><td class="mdescRight">Identify the user agent. <a href="#aed27c610d8942ca8f2f3794348c483ca">More...</a><br /></td></tr>
|
|
<tr class="separator:aed27c610d8942ca8f2f3794348c483ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03b4b191ffe4a2b585f43865121b4fc0"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a03b4b191ffe4a2b585f43865121b4fc0">connectionType</a> ()=0</td></tr>
|
|
<tr class="memdesc:a03b4b191ffe4a2b585f43865121b4fc0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the Adafruit IO network module connection type. <a href="#a03b4b191ffe4a2b585f43865121b4fc0">More...</a><br /></td></tr>
|
|
<tr class="separator:a03b4b191ffe4a2b585f43865121b4fc0"><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:a335e7adc061806aecb8c5e0280dbcf8d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a335e7adc061806aecb8c5e0280dbcf8d">_connect</a> ()=0</td></tr>
|
|
<tr class="memdesc:a335e7adc061806aecb8c5e0280dbcf8d"><td class="mdescLeft"> </td><td class="mdescRight">Establishes a connection with the Adafruit IO MQTT broker. <a href="#a335e7adc061806aecb8c5e0280dbcf8d">More...</a><br /></td></tr>
|
|
<tr class="separator:a335e7adc061806aecb8c5e0280dbcf8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a003a0d33ee2b208e6bfedf0bafa5e5ce"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#a003a0d33ee2b208e6bfedf0bafa5e5ce">_disconnect</a> ()=0</td></tr>
|
|
<tr class="memdesc:a003a0d33ee2b208e6bfedf0bafa5e5ce"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects from the Adafruit IO MQTT broker. <a href="#a003a0d33ee2b208e6bfedf0bafa5e5ce">More...</a><br /></td></tr>
|
|
<tr class="separator:a003a0d33ee2b208e6bfedf0bafa5e5ce"><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:ad93ebea2feb9f99f23e273cd8a372dc5"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d78b51b77dc3e786044726d93cff4b4"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1276ef53722ba350635f4b80819f718c"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a828dbd1fed50a027c8291dc14fc37195"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5953719b782781c1b82521087fbc600"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c2ae0c9a9fcc5ea2f43d66efad83b9f"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad96742c09949228d9ad716519162c8e9"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1be2f700dd4c358585977e45bc107e89"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c17d619328831d9698751d579cc5d8f"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a386a449b8ed6a1a3f4a794f2268ef81a"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a948f72541fc2ce369e61069eddbee770"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb1001fe93bcd52a8146fe6807c2b89a"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67e85df7be6f735ac07bbb15c0318e0d"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae15c2f177bab5b8ee6fbefd50cbe6221"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af016992f171d0640d728d2f7df979b3b"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0bbd54c82308aed36382fc8aa2e4a32c"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adab122f11082e770d81525754512b1b0"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1813d6ecea0526063bca7f47c5aec234"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:ab032c54aba2f6547fc0a57e57a5ae19d"><td class="memItemLeft" align="right" valign="top"><a id="ab032c54aba2f6547fc0a57e57a5ae19d"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit_i_o.html#ab032c54aba2f6547fc0a57e57a5ae19d">AdafruitIO_Block</a></td></tr>
|
|
<tr class="memdesc:ab032c54aba2f6547fc0a57e57a5ae19d"><td class="mdescLeft"> </td><td class="mdescRight">AdafruitIO_Block addition. <br /></td></tr>
|
|
<tr class="separator:ab032c54aba2f6547fc0a57e57a5ae19d"><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 interacting with Adafruit IO. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ad00a4c752e0e5eb1f8f0bec331c3a8b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad00a4c752e0e5eb1f8f0bec331c3a8b8">◆ </a></span>AdafruitIO()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">AdafruitIO::AdafruitIO </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>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Instantiate the AIO object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">user</td><td>A pointer to a constant AIO user name. </td></tr>
|
|
<tr><td class="paramname">key</td><td>A pointer to a constant key for the user name. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a1006551006e1c780a67d36903bf9332d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1006551006e1c780a67d36903bf9332d">◆ </a></span>run()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> AdafruitIO::run </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>busywait_ms</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>fail_fast</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">busywait_ms</td><td>The packet read timeout, optional. </td></tr>
|
|
<tr><td class="paramname">fail_fast</td><td>Set true to skip retries and return with status immediately, optional. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>AIO status value </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3afb61065ef04acce431ba305e799d3e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3afb61065ef04acce431ba305e799d3e">◆ </a></span>feed() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_adafruit_i_o___feed.html">AdafruitIO_Feed</a> * AdafruitIO::feed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new AIO feed. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The AIO name of the feed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the feed. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab81a46b288aafe74cd874fdd09e765ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab81a46b288aafe74cd874fdd09e765ef">◆ </a></span>feed() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_adafruit_i_o___feed.html">AdafruitIO_Feed</a> * AdafruitIO::feed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>owner</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new AIO feed. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The AIO name of the feed. </td></tr>
|
|
<tr><td class="paramname">owner</td><td>The AIO name of the user that owns the feed, if not the current user. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the feed. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5f3332cae4a31d41f364b88046f56ae2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5f3332cae4a31d41f364b88046f56ae2">◆ </a></span>group()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_adafruit_i_o___group.html">AdafruitIO_Group</a> * AdafruitIO::group </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new AIO group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The AIO name of the group. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the group. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a967c1bd7137e7328308c0dee8884ec5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a967c1bd7137e7328308c0dee8884ec5f">◆ </a></span>dashboard()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_adafruit_i_o___dashboard.html">AdafruitIO_Dashboard</a> * AdafruitIO::dashboard </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new AIO dashboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The AIO name of the dashboard. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the dashboard. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a48acec3d0fa233369d9f493f9aee363d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a48acec3d0fa233369d9f493f9aee363d">◆ </a></span>time()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_adafruit_i_o___time.html">AdafruitIO_Time</a> * AdafruitIO::time </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit_i_o___definitions_8h.html#af58cf71b871e96df60a5065cdc7a2062">aio_time_format_t</a> </td>
|
|
<td class="paramname"><em>format</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new AIO time. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">format</td><td>A format specifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the time. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a73b82ba6651748aa51347fe84b886e3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73b82ba6651748aa51347fe84b886e3f">◆ </a></span>statusText()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const __FlashStringHelper * AdafruitIO::statusText </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Provide status explanation strings. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the status string, _status. _status is the AIO status value </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a23f598b5f0aa7d5c85d4e400275dacc9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a23f598b5f0aa7d5c85d4e400275dacc9">◆ </a></span>status()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> AdafruitIO::status </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Status check. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An AIO status value. Lower values represent poorer connection status. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a80f3b21779818214d21264b8790f9c7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a80f3b21779818214d21264b8790f9c7f">◆ </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">virtual <a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> AdafruitIO::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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns network module status. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="class_adafruit_i_o___f_o_n_a.html#a0406bf1046b7fe99322fa5d9407d2daf">AdafruitIO_FONA</a>, and <a class="el" href="class_adafruit_i_o___ethernet.html#aad21e9b8dfc58c9d24e53b16c0f61d04">AdafruitIO_Ethernet</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a86db7b788f6ef0fd9b6803d32406fc87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86db7b788f6ef0fd9b6803d32406fc87">◆ </a></span>mqttStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit_i_o___definitions_8h.html#a2778792a8729edc34a0d45340ac45a59">aio_status_t</a> AdafruitIO::mqttStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>fail_fast</em> = <code>false</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns MQTT connection status. </p>
|
|
<p>Checks connection status with Adafruit IO's MQTT broker.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fail_fast</td><td>Set true to skip retries and return with status immediately. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if connected, otherwise False. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa5fd4a19cec76ca6af4f97e0eadfce8b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa5fd4a19cec76ca6af4f97e0eadfce8b">◆ </a></span>boardID()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char * AdafruitIO::boardID </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Identify the board. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A board ID </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee3d9710e0b73ad65f7891ddb4ec8dd5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee3d9710e0b73ad65f7891ddb4ec8dd5">◆ </a></span>boardType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char * AdafruitIO::boardType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Identify the board type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A board type </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1851f3dfbfe7d8047fbea79f334398fc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1851f3dfbfe7d8047fbea79f334398fc">◆ </a></span>version()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char * AdafruitIO::version </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Identify the software version. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to a version number string. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aed27c610d8942ca8f2f3794348c483ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aed27c610d8942ca8f2f3794348c483ca">◆ </a></span>userAgent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char * AdafruitIO::userAgent </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Identify the user agent. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to a user agent string. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03b4b191ffe4a2b585f43865121b4fc0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03b4b191ffe4a2b585f43865121b4fc0">◆ </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">virtual const char* AdafruitIO::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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the Adafruit IO network module connection type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="class_adafruit_i_o___f_o_n_a.html#a22ad93c97cfc3877e36f5934caf3f01d">AdafruitIO_FONA</a>, and <a class="el" href="class_adafruit_i_o___ethernet.html#ac338282e3e033ab9639319e3de16c07c">AdafruitIO_Ethernet</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a335e7adc061806aecb8c5e0280dbcf8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a335e7adc061806aecb8c5e0280dbcf8d">◆ </a></span>_connect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void AdafruitIO::_connect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Establishes a connection with the Adafruit IO MQTT broker. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="class_adafruit_i_o___f_o_n_a.html#a726026d0da43d348fb93fc8491d29342">AdafruitIO_FONA</a>, and <a class="el" href="class_adafruit_i_o___ethernet.html#a36d6a67a38a699b765136d0491c5ce64">AdafruitIO_Ethernet</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a003a0d33ee2b208e6bfedf0bafa5e5ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a003a0d33ee2b208e6bfedf0bafa5e5ce">◆ </a></span>_disconnect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void AdafruitIO::_disconnect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disconnects from the Adafruit IO MQTT broker. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="class_adafruit_i_o___f_o_n_a.html#a8e2fa694a93c3623fabe3833e9d478d6">AdafruitIO_FONA</a>, and <a class="el" href="class_adafruit_i_o___ethernet.html#a051677b1215824eb0505f1a711d553fb">AdafruitIO_Ethernet</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="ad93ebea2feb9f99f23e273cd8a372dc5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad93ebea2feb9f99f23e273cd8a372dc5">◆ </a></span>_status</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::_status = AIO_IDLE</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>Adafruit IO Connection Status </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d78b51b77dc3e786044726d93cff4b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d78b51b77dc3e786044726d93cff4b4">◆ </a></span>_last_ping</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t AdafruitIO::_last_ping</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">=</div><div class="line"> 0</div></div><!-- fragment --><p>Previous time when client pinged Adafruit IO, in milliseconds </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1276ef53722ba350635f4b80819f718c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1276ef53722ba350635f4b80819f718c">◆ </a></span>_last_mqtt_connect</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t AdafruitIO::_last_mqtt_connect = 0</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>Previous time when client connected to Adafruit IO, in milliseconds </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a828dbd1fed50a027c8291dc14fc37195"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a828dbd1fed50a027c8291dc14fc37195">◆ </a></span>_mqtt</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Adafruit_MQTT* AdafruitIO::_mqtt</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 Adafruit_MQTT, _mqtt. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5953719b782781c1b82521087fbc600"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5953719b782781c1b82521087fbc600">◆ </a></span>_http</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">HttpClient* AdafruitIO::_http</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 HTTPClient, _http </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c2ae0c9a9fcc5ea2f43d66efad83b9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c2ae0c9a9fcc5ea2f43d66efad83b9f">◆ </a></span>_version</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char AdafruitIO::_version[10]</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>Adafruit IO Arduino library version </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad96742c09949228d9ad716519162c8e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad96742c09949228d9ad716519162c8e9">◆ </a></span>_host</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::_host = "io.adafruit.com"</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>Adafruit IO URL </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1be2f700dd4c358585977e45bc107e89"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1be2f700dd4c358585977e45bc107e89">◆ </a></span>_mqtt_port</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t AdafruitIO::_mqtt_port = 8883</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>Adafruit IO MQTT SSL port </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6c17d619328831d9698751d579cc5d8f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c17d619328831d9698751d579cc5d8f">◆ </a></span>_mqtt_eth_port</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t AdafruitIO::_mqtt_eth_port</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">=</div><div class="line"> 1883</div></div><!-- fragment --><p>Adafruit IO MQTT insecure port, used by ethernet clients. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a386a449b8ed6a1a3f4a794f2268ef81a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a386a449b8ed6a1a3f4a794f2268ef81a">◆ </a></span>_http_port</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t AdafruitIO::_http_port = 443</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>Adafruit IO HTTP SSL port </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a948f72541fc2ce369e61069eddbee770"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a948f72541fc2ce369e61069eddbee770">◆ </a></span>_packetread_timeout</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t AdafruitIO::_packetread_timeout</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>Maximum amount of time to wait before processing packets. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb1001fe93bcd52a8146fe6807c2b89a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb1001fe93bcd52a8146fe6807c2b89a">◆ </a></span>_username</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::_username</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>Adafruit IO Username. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a67e85df7be6f735ac07bbb15c0318e0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67e85df7be6f735ac07bbb15c0318e0d">◆ </a></span>_key</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::_key</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>Adafruit IO Key. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae15c2f177bab5b8ee6fbefd50cbe6221"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae15c2f177bab5b8ee6fbefd50cbe6221">◆ </a></span>_err_topic</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char* AdafruitIO::_err_topic</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>Adafruit IO MQTT error message topic. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af016992f171d0640d728d2f7df979b3b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af016992f171d0640d728d2f7df979b3b">◆ </a></span>_throttle_topic</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char* AdafruitIO::_throttle_topic</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>Adafruit IO MQTT throttle message topic. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0bbd54c82308aed36382fc8aa2e4a32c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0bbd54c82308aed36382fc8aa2e4a32c">◆ </a></span>_user_agent</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char* AdafruitIO::_user_agent</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>Identifies the Adafruit IO client. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adab122f11082e770d81525754512b1b0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adab122f11082e770d81525754512b1b0">◆ </a></span>_err_sub</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Adafruit_MQTT_Subscribe* AdafruitIO::_err_sub</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>Subscription to Adafruit IO Error topic. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1813d6ecea0526063bca7f47c5aec234"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1813d6ecea0526063bca7f47c5aec234">◆ </a></span>_throttle_sub</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Adafruit_MQTT_Subscribe* AdafruitIO::_throttle_sub</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>Subscription to Adafruit IO Throttle topic. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/<a class="el" href="_adafruit_i_o_8h_source.html">AdafruitIO.h</a></li>
|
|
<li>src/<a class="el" href="_adafruit_i_o_8cpp.html">AdafruitIO.cpp</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>
|