andry/lighthub
1
0
Fork 0
mirror of https://github.com/anklimov/lighthub synced 2025-12-06 11:49:51 +03:00
Code Issues Packages Projects Releases Wiki Activity

Refactored beta

Browse Source 
+Doxigen autogenerated docs
This commit is contained in:
Andrey Klimov
2020-11-19 23:47:35 +03:00
parent 9fa9e0f481
commit 7bfe7ed330
601 changed files with 70469 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
docs/html/streamlog_8h_source.html Normal file
View File

@@ -0,0 +1,138 @@
<!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: /Users/andrey/Documents/Arduino/lighthub/lighthub/streamlog.h Source File</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_82d7c1f210290ade9e0671f857ad27e3.html">lighthub</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">streamlog.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="streamlog_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#include &lt;Print.h&gt;</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &lt;HardwareSerial.h&gt;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;inttypes.h&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#ifndef LOGBUFFER_SIZE</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="streamlog_8h.html#a2e75de3d470df65326791691c3039c70"> 6</a></span>&#160;<span class="preprocessor">#define LOGBUFFER_SIZE 80</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#ifdef SYSLOG_ENABLE</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;Syslog.h&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">static</span> <span class="keywordtype">char</span> logBuffer[<a class="code" href="streamlog_8h.html#a2e75de3d470df65326791691c3039c70">LOGBUFFER_SIZE</a>];</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">static</span> <span class="keywordtype">int</span> logBufferPos=0;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="streamlog_8h.html#a6ff63e8955665c4a58b1598f2b07c51a"> 15</a></span>&#160;<span class="preprocessor">#define LOG_DEBUG 7</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="streamlog_8h.html#aeb4f36db01bd128c7afeac5889dac311"> 16</a></span>&#160;<span class="preprocessor">#define LOG_INFO 6</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="streamlog_8h.html#aced66975c154ea0e2a8ec3bc818b4e08"> 17</a></span>&#160;<span class="preprocessor">#define LOG_ERROR 3</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">static</span> uint8_t serialDebugLevel = 7;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">static</span> uint8_t udpDebugLevel =7;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="class_streamlog.html"> 22</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_streamlog.html">Streamlog</a> : <span class="keyword">public</span> Print</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"> #ifdef SYSLOG_ENABLE</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="class_streamlog.html#a51cd1bbe03b32ad2d4235b4ef7945d37">Streamlog</a> (HardwareSerial * _serialPort, <span class="keywordtype">int</span> _severity = <a class="code" href="streamlog_8h.html#a6ff63e8955665c4a58b1598f2b07c51a">LOG_DEBUG</a>, Syslog * _syslog = NULL, uint8_t _ledPattern = 0);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor"> #else</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="class_streamlog.html#a51cd1bbe03b32ad2d4235b4ef7945d37">Streamlog</a> (HardwareSerial * _serialPort, <span class="keywordtype">int</span> _severity = <a class="code" href="streamlog_8h.html#a6ff63e8955665c4a58b1598f2b07c51a">LOG_DEBUG</a>, uint8_t _ledPattern = 0);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="comment">// {serialPort=_serialPort;severity=_severity; syslog=_syslog; }</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_streamlog.html#ab9c1022fccf6b585b738f30f8577d613">begin</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> speed);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_streamlog.html#ace6e3e265ae590b7f3b14b926bc3e60b">end</a>() ;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_streamlog.html#ae7a165675188ecb1bf305b025efbf47b">available</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_streamlog.html#a246066803cd501ca4f1f5c94823db0e0">peek</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_streamlog.html#acbea1e8e890180c66757bd7647703d54">read</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_streamlog.html#aec3522140e0c8f95039e62747f841987">flush</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_streamlog.html#a944486d544c3677410e1505b9cd6858b">write</a>(uint8_t ch);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">using</span> Print::write; <span class="comment">// pull in write(str) and write(buf, size) from Print</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="class_streamlog.html#adcd1dcab71fd1e1c9da5bc9c18ac3d1d"> 40</a></span>&#160; <span class="keyword">operator</span> bool() {<span class="keywordflow">return</span> <span class="keyword">true</span>;};</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; uint16_t severity;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; HardwareSerial *serialPort;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor"> #ifdef SYSLOG_ENABLE</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; Syslog * syslog;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; uint8_t ledPattern;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;};</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_streamlog_html_ace6e3e265ae590b7f3b14b926bc3e60b"><div class="ttname"><a href="class_streamlog.html#ace6e3e265ae590b7f3b14b926bc3e60b">Streamlog::end</a></div><div class="ttdeci">void end()</div><div class="ttdef"><b>Definition:</b> streamlog.cpp:31</div></div>
<div class="ttc" id="aclass_streamlog_html_ae7a165675188ecb1bf305b025efbf47b"><div class="ttname"><a href="class_streamlog.html#ae7a165675188ecb1bf305b025efbf47b">Streamlog::available</a></div><div class="ttdeci">int available(void)</div><div class="ttdef"><b>Definition:</b> streamlog.cpp:36</div></div>
<div class="ttc" id="astreamlog_8h_html_a2e75de3d470df65326791691c3039c70"><div class="ttname"><a href="streamlog_8h.html#a2e75de3d470df65326791691c3039c70">LOGBUFFER_SIZE</a></div><div class="ttdeci">#define LOGBUFFER_SIZE</div><div class="ttdef"><b>Definition:</b> streamlog.h:6</div></div>
<div class="ttc" id="aclass_streamlog_html_a944486d544c3677410e1505b9cd6858b"><div class="ttname"><a href="class_streamlog.html#a944486d544c3677410e1505b9cd6858b">Streamlog::write</a></div><div class="ttdeci">size_t write(uint8_t ch)</div><div class="ttdef"><b>Definition:</b> streamlog.cpp:61</div></div>
<div class="ttc" id="aclass_streamlog_html_aec3522140e0c8f95039e62747f841987"><div class="ttname"><a href="class_streamlog.html#aec3522140e0c8f95039e62747f841987">Streamlog::flush</a></div><div class="ttdeci">void flush(void)</div><div class="ttdef"><b>Definition:</b> streamlog.cpp:55</div></div>
<div class="ttc" id="aclass_streamlog_html_a246066803cd501ca4f1f5c94823db0e0"><div class="ttname"><a href="class_streamlog.html#a246066803cd501ca4f1f5c94823db0e0">Streamlog::peek</a></div><div class="ttdeci">int peek(void)</div><div class="ttdef"><b>Definition:</b> streamlog.cpp:42</div></div>
<div class="ttc" id="aclass_streamlog_html_ab9c1022fccf6b585b738f30f8577d613"><div class="ttname"><a href="class_streamlog.html#ab9c1022fccf6b585b738f30f8577d613">Streamlog::begin</a></div><div class="ttdeci">void begin(unsigned long speed)</div><div class="ttdef"><b>Definition:</b> streamlog.cpp:26</div></div>
<div class="ttc" id="aclass_streamlog_html"><div class="ttname"><a href="class_streamlog.html">Streamlog</a></div><div class="ttdef"><b>Definition:</b> streamlog.h:23</div></div>
<div class="ttc" id="aclass_streamlog_html_acbea1e8e890180c66757bd7647703d54"><div class="ttname"><a href="class_streamlog.html#acbea1e8e890180c66757bd7647703d54">Streamlog::read</a></div><div class="ttdeci">int read(void)</div><div class="ttdef"><b>Definition:</b> streamlog.cpp:48</div></div>
<div class="ttc" id="aclass_streamlog_html_a51cd1bbe03b32ad2d4235b4ef7945d37"><div class="ttname"><a href="class_streamlog.html#a51cd1bbe03b32ad2d4235b4ef7945d37">Streamlog::Streamlog</a></div><div class="ttdeci">Streamlog(HardwareSerial *_serialPort, int _severity=LOG_DEBUG, uint8_t _ledPattern=0)</div><div class="ttdef"><b>Definition:</b> streamlog.cpp:19</div></div>
<div class="ttc" id="astreamlog_8h_html_a6ff63e8955665c4a58b1598f2b07c51a"><div class="ttname"><a href="streamlog_8h.html#a6ff63e8955665c4a58b1598f2b07c51a">LOG_DEBUG</a></div><div class="ttdeci">#define LOG_DEBUG</div><div class="ttdef"><b>Definition:</b> streamlog.h:15</div></div>
<!-- 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>