andry/lighthub
1
0
Fork 0
mirror of https://github.com/anklimov/lighthub synced 2025-12-06 03:39:49 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
7bfe7ed330afd49baf110ce48bf4135dc960dc16
lighthub/docs/html/class_streamlog.html
Andrey Klimov 7bfe7ed330 Refactored beta 
+Doxigen autogenerated docs
2020-11-19 23:47:35 +03:00

299 lines
13 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LightHub: Streamlog 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="projectlogo"><img alt="Logo" src="lh.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">LightHub
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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> &#124;
<a href="class_streamlog-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Streamlog Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="streamlog_8h_source.html">streamlog.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Streamlog:</div>
<div class="dyncontent">
<div class="center">
<img src="class_streamlog.png" alt=""/>
</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:a51cd1bbe03b32ad2d4235b4ef7945d37"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#a51cd1bbe03b32ad2d4235b4ef7945d37">Streamlog</a> (HardwareSerial *_serialPort, int _severity=<a class="el" href="streamlog_8h.html#a6ff63e8955665c4a58b1598f2b07c51a">LOG_DEBUG</a>, uint8_t _ledPattern=0)</td></tr>
<tr class="separator:a51cd1bbe03b32ad2d4235b4ef7945d37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9c1022fccf6b585b738f30f8577d613"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#ab9c1022fccf6b585b738f30f8577d613">begin</a> (unsigned long speed)</td></tr>
<tr class="separator:ab9c1022fccf6b585b738f30f8577d613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace6e3e265ae590b7f3b14b926bc3e60b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#ace6e3e265ae590b7f3b14b926bc3e60b">end</a> ()</td></tr>
<tr class="separator:ace6e3e265ae590b7f3b14b926bc3e60b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7a165675188ecb1bf305b025efbf47b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#ae7a165675188ecb1bf305b025efbf47b">available</a> (void)</td></tr>
<tr class="separator:ae7a165675188ecb1bf305b025efbf47b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a246066803cd501ca4f1f5c94823db0e0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#a246066803cd501ca4f1f5c94823db0e0">peek</a> (void)</td></tr>
<tr class="separator:a246066803cd501ca4f1f5c94823db0e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbea1e8e890180c66757bd7647703d54"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#acbea1e8e890180c66757bd7647703d54">read</a> (void)</td></tr>
<tr class="separator:acbea1e8e890180c66757bd7647703d54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec3522140e0c8f95039e62747f841987"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#aec3522140e0c8f95039e62747f841987">flush</a> (void)</td></tr>
<tr class="separator:aec3522140e0c8f95039e62747f841987"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a944486d544c3677410e1505b9cd6858b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#a944486d544c3677410e1505b9cd6858b">write</a> (uint8_t ch)</td></tr>
<tr class="separator:a944486d544c3677410e1505b9cd6858b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcd1dcab71fd1e1c9da5bc9c18ac3d1d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_streamlog.html#adcd1dcab71fd1e1c9da5bc9c18ac3d1d">operator bool</a> ()</td></tr>
<tr class="separator:adcd1dcab71fd1e1c9da5bc9c18ac3d1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a51cd1bbe03b32ad2d4235b4ef7945d37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51cd1bbe03b32ad2d4235b4ef7945d37">&#9670;&nbsp;</a></span>Streamlog()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Streamlog::Streamlog </td>
<td>(</td>
<td class="paramtype">HardwareSerial *&#160;</td>
<td class="paramname"><em>_serialPort</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>_severity</em> = <code><a class="el" href="streamlog_8h.html#a6ff63e8955665c4a58b1598f2b07c51a">LOG_DEBUG</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>_ledPattern</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae7a165675188ecb1bf305b025efbf47b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7a165675188ecb1bf305b025efbf47b">&#9670;&nbsp;</a></span>available()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Streamlog::available </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab9c1022fccf6b585b738f30f8577d613"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9c1022fccf6b585b738f30f8577d613">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Streamlog::begin </td>
<td>(</td>
<td class="paramtype">unsigned long&#160;</td>
<td class="paramname"><em>speed</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ace6e3e265ae590b7f3b14b926bc3e60b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace6e3e265ae590b7f3b14b926bc3e60b">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Streamlog::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aec3522140e0c8f95039e62747f841987"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec3522140e0c8f95039e62747f841987">&#9670;&nbsp;</a></span>flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Streamlog::flush </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adcd1dcab71fd1e1c9da5bc9c18ac3d1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcd1dcab71fd1e1c9da5bc9c18ac3d1d">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Streamlog::operator bool </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> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a246066803cd501ca4f1f5c94823db0e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a246066803cd501ca4f1f5c94823db0e0">&#9670;&nbsp;</a></span>peek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Streamlog::peek </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acbea1e8e890180c66757bd7647703d54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbea1e8e890180c66757bd7647703d54">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Streamlog::read </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a944486d544c3677410e1505b9cd6858b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a944486d544c3677410e1505b9cd6858b">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t Streamlog::write </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>ch</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/Users/andrey/Documents/Arduino/lighthub/lighthub/<a class="el" href="streamlog_8h_source.html">streamlog.h</a></li>
<li>/Users/andrey/Documents/Arduino/lighthub/lighthub/<a class="el" href="streamlog_8cpp.html">streamlog.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink