adafruit-mirror/Adafruit_IO_Arduino
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Deploy docs to GitHub Pages from commit a2b63fcca9

Browse source 
Commit: a2b63fcca9
GitHub Actions run: 2835775020
This commit is contained in:
Doxygen CI 2022-08-10 21:25:02 +00:00
parent 41c4de78a1
commit e474838677
3 changed files with 16 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
html/_adafruit_i_o___data_8h_source.html
View file

@ -77,7 +77,7 @@ $(function() {
<div class="ttc" id="class_adafruit_i_o___data_html_ad20529a014a258f3f33df8e3651fb0f2"><div class="ttname"><a href="class_adafruit_i_o___data.html#ad20529a014a258f3f33df8e3651fb0f2">AdafruitIO_Data::toUnsignedInt</a></div><div class="ttdeci">unsigned int toUnsignedInt()</div><div class="ttdoc">Converts value to to an Unsigned Integer value. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:524</div></div>
<div class="ttc" id="class_adafruit_i_o___data_html_a3e1cd7babc2efce847805ed4f0453925"><div class="ttname"><a href="class_adafruit_i_o___data.html#a3e1cd7babc2efce847805ed4f0453925">AdafruitIO_Data::toString</a></div><div class="ttdeci">String toString()</div><div class="ttdoc">Converts value to string. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:451</div></div>
<div class="ttc" id="class_adafruit_i_o___feed_html"><div class="ttname"><a href="class_adafruit_i_o___feed.html">AdafruitIO_Feed</a></div><div class="ttdoc">Class that provides methods for interfacing with Adafruit IO feed topics. https://io.adafruit.com/api/docs/mqtt.html#mqtt-topics. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Feed.h:34</div></div>
<div class="ttc" id="_adafruit_i_o___definitions_8h_html_a00c71a214e64699d5457163d99d3de2e"><div class="ttname"><a href="_adafruit_i_o___definitions_8h.html#a00c71a214e64699d5457163d99d3de2e">AIO_CSV_LENGTH</a></div><div class="ttdeci">#define AIO_CSV_LENGTH</div><div class="ttdoc">Adafruit IO. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Definitions.h:137</div></div>
<div class="ttc" id="_adafruit_i_o___definitions_8h_html_a00c71a214e64699d5457163d99d3de2e"><div class="ttname"><a href="_adafruit_i_o___definitions_8h.html#a00c71a214e64699d5457163d99d3de2e">AIO_CSV_LENGTH</a></div><div class="ttdeci">#define AIO_CSV_LENGTH</div><div class="ttdoc">Maximum comma-separated-value length from Adafruit IO. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Definitions.h:137</div></div>
<div class="ttc" id="class_adafruit_i_o___data_html_aeae990760ee592b01d8ed89ac8e8345b"><div class="ttname"><a href="class_adafruit_i_o___data.html#aeae990760ee592b01d8ed89ac8e8345b">AdafruitIO_Data::toUnsignedLong</a></div><div class="ttdeci">unsigned long toUnsignedLong()</div><div class="ttdoc">Converts value to to an unsigned long value. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:586</div></div>
<div class="ttc" id="class_adafruit_i_o___data_html_af2ae58fda00ca0d775dd1baf5ff39716"><div class="ttname"><a href="class_adafruit_i_o___data.html#af2ae58fda00ca0d775dd1baf5ff39716">AdafruitIO_Data::toNeoPixel</a></div><div class="ttdeci">long toNeoPixel()</div><div class="ttdoc">Creates a RGB Tuple usable by Adafruit_NeoPixel&amp;#39;s setPixelColor method. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:661</div></div>
<div class="ttc" id="class_adafruit_i_o___data_html_aa452bb3b17b931f3756b96029d55c58d"><div class="ttname"><a href="class_adafruit_i_o___data.html#aa452bb3b17b931f3756b96029d55c58d">AdafruitIO_Data::toBool</a></div><div class="ttdeci">bool toBool()</div><div class="ttdoc">Converts value to Boolean. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:464</div></div>
@ -92,7 +92,7 @@ $(function() {
<div class="ttc" id="class_adafruit_i_o___data_html_acb9b45f17384ff3f84d7cc8848247ffc"><div class="ttname"><a href="class_adafruit_i_o___data.html#acb9b45f17384ff3f84d7cc8848247ffc">AdafruitIO_Data::charFromDouble</a></div><div class="ttdeci">char * charFromDouble(double d, int precision=6)</div><div class="ttdoc">Converts from a character to a double. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:732</div></div>
<div class="ttc" id="class_adafruit_i_o___data_html"><div class="ttname"><a href="class_adafruit_i_o___data.html">AdafruitIO_Data</a></div><div class="ttdoc">Class for interacting with Adafruit IO Data Records. https://io.adafruit.com/api/docs/#data. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.h:30</div></div>
<div class="ttc" id="class_adafruit_i_o___data_html_a4e18a462e1878115f9e47dc73e274e2a"><div class="ttname"><a href="class_adafruit_i_o___data.html#a4e18a462e1878115f9e47dc73e274e2a">AdafruitIO_Data::lon</a></div><div class="ttdeci">double lon()</div><div class="ttdoc">Returns a data record&amp;#39;s longitude value. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:710</div></div>
<div class="ttc" id="_adafruit_i_o___definitions_8h_html_ac605596c0fee20cbc0ddc4a406485851"><div class="ttname"><a href="_adafruit_i_o___definitions_8h.html#ac605596c0fee20cbc0ddc4a406485851">AIO_FEED_NAME_LENGTH</a></div><div class="ttdeci">#define AIO_FEED_NAME_LENGTH</div><div class="ttdef"><b>Definition:</b> AdafruitIO_Definitions.h:131</div></div>
<div class="ttc" id="_adafruit_i_o___definitions_8h_html_ac605596c0fee20cbc0ddc4a406485851"><div class="ttname"><a href="_adafruit_i_o___definitions_8h.html#ac605596c0fee20cbc0ddc4a406485851">AIO_FEED_NAME_LENGTH</a></div><div class="ttdeci">#define AIO_FEED_NAME_LENGTH</div><div class="ttdoc">group, a dot, and actual feed name. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Definitions.h:131</div></div>
<div class="ttc" id="class_adafruit_i_o___data_html_a6cd4cf05b1da38d92729ea3eb4761841"><div class="ttname"><a href="class_adafruit_i_o___data.html#a6cd4cf05b1da38d92729ea3eb4761841">AdafruitIO_Data::toBlue</a></div><div class="ttdeci">int toBlue()</div><div class="ttdoc">Returns BB from 0xRRGGBB value. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:642</div></div>
<div class="ttc" id="class_adafruit_i_o___data_html_a5282337a2701265187fb1336688caaa1"><div class="ttname"><a href="class_adafruit_i_o___data.html#a5282337a2701265187fb1336688caaa1">AdafruitIO_Data::value</a></div><div class="ttdeci">char * value()</div><div class="ttdoc">Converts provided value to char. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:435</div></div>
<div class="ttc" id="class_adafruit_i_o___data_html_adddce7fc5e038a772885c67f51374c00"><div class="ttname"><a href="class_adafruit_i_o___data.html#adddce7fc5e038a772885c67f51374c00">AdafruitIO_Data::toPinLevel</a></div><div class="ttdeci">int toPinLevel()</div><div class="ttdoc">Checks digital pin level. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Data.cpp:511</div></div>

23
html/_adafruit_i_o___definitions_8h.html
View file

@ -83,15 +83,15 @@ Classes</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a4d470d58246c0194ff6e0a7837dc06f2"><td class="memItemLeft" align="right" valign="top"><a id="a4d470d58246c0194ff6e0a7837dc06f2"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a4d470d58246c0194ff6e0a7837dc06f2">ADAFRUITIO_VERSION_MAJOR</a>&#160;&#160;&#160;3</td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a4d470d58246c0194ff6e0a7837dc06f2">ADAFRUITIO_VERSION_MAJOR</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:a4d470d58246c0194ff6e0a7837dc06f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adafruit IO Arduino Major Semvar. <br /></td></tr>
<tr class="separator:a4d470d58246c0194ff6e0a7837dc06f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a696fefb486914e941d63e8206b4c9e99"><td class="memItemLeft" align="right" valign="top"><a id="a696fefb486914e941d63e8206b4c9e99"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a696fefb486914e941d63e8206b4c9e99">ADAFRUITIO_VERSION_MINOR</a>&#160;&#160;&#160;5</td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a696fefb486914e941d63e8206b4c9e99">ADAFRUITIO_VERSION_MINOR</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:a696fefb486914e941d63e8206b4c9e99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adafruit IO Arduino Minor Semvar. <br /></td></tr>
<tr class="separator:a696fefb486914e941d63e8206b4c9e99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56e4275dff387b4c5793357ec38316ff"><td class="memItemLeft" align="right" valign="top"><a id="a56e4275dff387b4c5793357ec38316ff"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a56e4275dff387b4c5793357ec38316ff">ADAFRUITIO_VERSION_PATCH</a>&#160;&#160;&#160;0</td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a56e4275dff387b4c5793357ec38316ff">ADAFRUITIO_VERSION_PATCH</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a56e4275dff387b4c5793357ec38316ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adafruit IO Arduino Patch Semvar. <br /></td></tr>
<tr class="separator:a56e4275dff387b4c5793357ec38316ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a134faf99717094e02193d0b54f4298e4"><td class="memItemLeft" align="right" valign="top"><a id="a134faf99717094e02193d0b54f4298e4"></a>
@ -145,13 +145,14 @@ Macros</h2></td></tr>
<tr class="memitem:a5f598c9f7ee60bd5fbe6ee8a5753bc7d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a5f598c9f7ee60bd5fbe6ee8a5753bc7d">AIO_SSL_FINGERPRINT</a>&#160;&#160;&#160;&quot;59 3C 48 0A B1 8B 39 4E 0D 58 50 47 9A 13 55 60 CC A0 1D AF&quot;</td></tr>
<tr class="separator:a5f598c9f7ee60bd5fbe6ee8a5753bc7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac605596c0fee20cbc0ddc4a406485851"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#ac605596c0fee20cbc0ddc4a406485851">AIO_FEED_NAME_LENGTH</a>&#160;&#160;&#160;258</td></tr>
<tr class="memdesc:ac605596c0fee20cbc0ddc4a406485851"><td class="mdescLeft">&#160;</td><td class="mdescRight">group, a dot, and actual feed name. <a href="#ac605596c0fee20cbc0ddc4a406485851">More...</a><br /></td></tr>
<tr class="separator:ac605596c0fee20cbc0ddc4a406485851"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f56c74bee48e5d1a0c60a04bd25d85e"><td class="memItemLeft" align="right" valign="top"><a id="a8f56c74bee48e5d1a0c60a04bd25d85e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a8f56c74bee48e5d1a0c60a04bd25d85e">AIO_DATA_LENGTH</a>&#160;&#160;&#160;45</td></tr>
<tr class="memdesc:a8f56c74bee48e5d1a0c60a04bd25d85e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum length of data sent/recieved from Adafruit IO. <br /></td></tr>
<tr class="separator:a8f56c74bee48e5d1a0c60a04bd25d85e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00c71a214e64699d5457163d99d3de2e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a00c71a214e64699d5457163d99d3de2e">AIO_CSV_LENGTH</a>&#160;&#160;&#160;<a class="el" href="_adafruit_i_o___definitions_8h.html#ac605596c0fee20cbc0ddc4a406485851">AIO_FEED_NAME_LENGTH</a> + 4</td></tr>
<tr class="memdesc:a00c71a214e64699d5457163d99d3de2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adafruit IO. <a href="#a00c71a214e64699d5457163d99d3de2e">More...</a><br /></td></tr>
<tr class="memitem:a00c71a214e64699d5457163d99d3de2e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit_i_o___definitions_8h.html#a00c71a214e64699d5457163d99d3de2e">AIO_CSV_LENGTH</a></td></tr>
<tr class="memdesc:a00c71a214e64699d5457163d99d3de2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum comma-separated-value length from Adafruit IO. <a href="#a00c71a214e64699d5457163d99d3de2e">More...</a><br /></td></tr>
<tr class="separator:a00c71a214e64699d5457163d99d3de2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
@ -220,7 +221,9 @@ Enumerations</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum length of an Adafruit IO Feed \ Name; 128 + 1 + 128 for the group, a dot \ , and actual feed name. </p>
<p>group, a dot, and actual feed name. </p>
<p>Maximum length of an Adafruit IO Feed: Name; 128 + 1 + 128 for the </p>
</div>
</div>
@ -231,13 +234,13 @@ Enumerations</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AIO_CSV_LENGTH&#160;&#160;&#160;<a class="el" href="_adafruit_i_o___definitions_8h.html#ac605596c0fee20cbc0ddc4a406485851">AIO_FEED_NAME_LENGTH</a> + 4</td>
<td class="memname">#define AIO_CSV_LENGTH</td>
</tr>
</table>
</div><div class="memdoc">
<p>Adafruit IO. </p>
<p>Maximum comma-separated-value length from \ </p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="_adafruit_i_o___definitions_8h.html#ac605596c0fee20cbc0ddc4a406485851">AIO_FEED_NAME_LENGTH</a> + \</div><div class="line"> 4</div><div class="ttc" id="_adafruit_i_o___definitions_8h_html_ac605596c0fee20cbc0ddc4a406485851"><div class="ttname"><a href="_adafruit_i_o___definitions_8h.html#ac605596c0fee20cbc0ddc4a406485851">AIO_FEED_NAME_LENGTH</a></div><div class="ttdeci">#define AIO_FEED_NAME_LENGTH</div><div class="ttdoc">group, a dot, and actual feed name. </div><div class="ttdef"><b>Definition:</b> AdafruitIO_Definitions.h:131</div></div>
</div><!-- fragment -->
<p>Maximum comma-separated-value length from Adafruit IO. </p>
</div>
</div>

2
html/_adafruit_i_o___definitions_8h_source.html
View file

File diff suppressed because one or more lines are too long