Skip to content

Commit

Permalink
Deploying to gh-pages from @ f03b4ca 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
FredM67 committed Feb 12, 2024
1 parent c8807c0 commit 657cb37
Show file tree
Hide file tree
Showing 205 changed files with 1,356 additions and 964 deletions.
89 changes: 45 additions & 44 deletions annotated.html

Large diffs are not rendered by default.

79 changes: 79 additions & 0 deletions classEWMA__average-members.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>3-phase PV router: Member List</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">3-phase PV router
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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="headertitle">
<div class="title">EWMA_average&lt; A &gt; Member List</div> </div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classEWMA__average.html">EWMA_average&lt; A &gt;</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classEWMA__average.html#a208b9b3d82809466b4d90aedb3c7e4db">addValue</a>(int32_t input)</td><td class="entry"><a class="el" href="classEWMA__average.html">EWMA_average&lt; A &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classEWMA__average.html#a6fbbe5221e07dccf5bb8af302c9c59f1">getAverage</a>() const</td><td class="entry"><a class="el" href="classEWMA__average.html">EWMA_average&lt; A &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
184 changes: 184 additions & 0 deletions classEWMA__average.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>3-phase PV router: EWMA_average&lt; A &gt; Class Template 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">3-phase PV router
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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="classEWMA__average-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">EWMA_average&lt; A &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">

<p>Exponentially Weighted Moving Average.
<a href="classEWMA__average.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>&gt;</code></p>
<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:a208b9b3d82809466b4d90aedb3c7e4db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEWMA__average.html#a208b9b3d82809466b4d90aedb3c7e4db">addValue</a> (int32_t input)</td></tr>
<tr class="separator:a208b9b3d82809466b4d90aedb3c7e4db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fbbe5221e07dccf5bb8af302c9c59f1"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEWMA__average.html#a6fbbe5221e07dccf5bb8af302c9c59f1">getAverage</a> () const</td></tr>
<tr class="separator:a6fbbe5221e07dccf5bb8af302c9c59f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;uint8_t A = 10&gt;<br />
class EWMA_average&lt; A &gt;</h3>

<p>Exponentially Weighted Moving Average. </p>
<p>The smoothing factor is the approximate amount of values taken to calculate the average. Since the Arduino is very slow and does not provide any dedicated math co-processor, the smoothing factor will be rounded to the previous power of 2. Ie 120 will be rounded to 64. This allows to perform all the calculations with integer math, which is much faster !</p>
<dl class="section note"><dt>Note</dt><dd>Because of the 'sign extension', the sign is copied into lower bits.</dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">A</td><td>Smoothing factor </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>Input value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>long Output value </dd></dl>

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00055">55</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a208b9b3d82809466b4d90aedb3c7e4db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a208b9b3d82809466b4d90aedb3c7e4db">&#9670;&nbsp;</a></span>addValue()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint8_t A = 10&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classEWMA__average.html">EWMA_average</a>&lt; A &gt;::addValue </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>input</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00058">58</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classEWMA__average_a208b9b3d82809466b4d90aedb3c7e4db_cgraph.png" border="0" usemap="#aclassEWMA__average_a208b9b3d82809466b4d90aedb3c7e4db_cgraph" alt=""/></div>
<map name="aclassEWMA__average_a208b9b3d82809466b4d90aedb3c7e4db_cgraph" id="aclassEWMA__average_a208b9b3d82809466b4d90aedb3c7e4db_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,197,32"/>
<area shape="rect" href="movingAvg_8h.html#ab2d65d6104cd09368e1b72bb4342cae5" title="Helper compile&#45;time function to retrieve the previous power of 2 of the given number (120 =&gt; 64 =&gt; 6)" alt="" coords="245,5,429,32"/>
</map>
</div>

</div>
</div>
<a id="a6fbbe5221e07dccf5bb8af302c9c59f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fbbe5221e07dccf5bb8af302c9c59f1">&#9670;&nbsp;</a></span>getAverage()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint8_t A = 10&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="classEWMA__average.html">EWMA_average</a>&lt; A &gt;::getAverage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00064">64</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Mk2_3phase_RFdatalog_temp/<a class="el" href="movingAvg_8h_source.html">movingAvg.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<map id="EWMA_average::addValue" name="EWMA_average::addValue">
<area shape="rect" id="node1" title=" " alt="" coords="5,5,197,32"/>
<area shape="rect" id="node2" href="$movingAvg_8h.html#ab2d65d6104cd09368e1b72bb4342cae5" title="Helper compile&#45;time function to retrieve the previous power of 2 of the given number (120 =&gt; 64 =&gt; 6)" alt="" coords="245,5,429,32"/>
</map>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ac8d6991aa144f2b873ce2ccef59f989
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
<dd><a class="el" href="structconditional.html">conditional</a></dd><dd><a class="el" href="structconditional_3_01false_00_01TrueType_00_01FalseType_01_4.html">conditional&lt; false, TrueType, FalseType &gt;</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_E">E</a></dt>
<dd><a class="el" href="structenable__if.html">enable_if</a></dd><dd><a class="el" href="structenable__if_3_01true_00_01T_01_4.html">enable_if&lt; true, T &gt;</a></dd></dl>
<dd><a class="el" href="structenable__if.html">enable_if</a></dd><dd><a class="el" href="structenable__if_3_01true_00_01T_01_4.html">enable_if&lt; true, T &gt;</a></dd><dd><a class="el" href="classEWMA__average.html">EWMA_average</a></dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_I">I</a></dt>
<dd><a class="el" href="structintegral__constant.html">integral_constant</a></dd><dd><a class="el" href="structis__array.html">is_array</a></dd><dd><a class="el" href="structis__array_3_01T_0f_0e_01_4.html">is_array&lt; T[] &gt;</a></dd><dd><a class="el" href="structis__array_3_01T_0fN_0e_01_4.html">is_array&lt; T[N] &gt;</a></dd><dd><a class="el" href="classis__base__of.html">is_base_of</a></dd><dd><a class="el" href="structis__class.html">is_class</a></dd><dd><a class="el" href="structis__const.html">is_const</a></dd><dd><a class="el" href="structis__const_3_01const_01T_01_4.html">is_const&lt; const T &gt;</a></dd><dd><a class="el" href="structis__convertible.html">is_convertible</a></dd><dd><a class="el" href="structis__enum.html">is_enum</a></dd><dd><a class="el" href="structis__floating__point.html">is_floating_point</a></dd><dd><a class="el" href="structis__integral.html">is_integral</a></dd><dd><a class="el" href="structis__pointer.html">is_pointer</a></dd><dd><a class="el" href="structis__pointer_3_01T_01_5_01_4.html">is_pointer&lt; T * &gt;</a></dd><dd><a class="el" href="structis__same.html">is_same</a></dd><dd><a class="el" href="structis__same_3_01T_00_01T_01_4.html">is_same&lt; T, T &gt;</a></dd><dd><a class="el" href="structis__signed.html">is_signed</a></dd><dd><a class="el" href="structis__unsigned.html">is_unsigned</a></dd></dl>
Expand Down
14 changes: 7 additions & 7 deletions classmovingAvg.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
</dd></dl>
<p>Drawback of this method: the average is updated only every minutes ! </p>

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00040">40</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00095">95</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa0d0d8ba97b9d3fdfdbcf3a0b8d8f0f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0d0d8ba97b9d3fdfdbcf3a0b8d8f0f5">&#9670;&nbsp;</a></span>addValue()</h2>
Expand Down Expand Up @@ -149,7 +149,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa0d0d8ba97b9d3fdfdbcf3a0
</dd>
</dl>

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00084">84</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00136">136</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -180,7 +180,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#adc157cfdb883805b88f3979c

<p>Reset everything. </p>

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00047">47</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00102">102</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -210,7 +210,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aac85cf80e40b547a203818d1
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00098">98</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00150">150</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -243,7 +243,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1dcbea2038fad2497a67aecb
<dl class="section return"><dt>Returns</dt><dd>auto The sliding average</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This value is updated every minute, except for the special case of a duration of ONE minute. In this case, it is updated for each new input value. </dd></dl>

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00118">118</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00170">170</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -273,7 +273,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#afaea648c9898a00cdbf89919
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00136">136</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00188">188</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -302,7 +302,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a588664a30754acc54ac30962
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00149">149</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="movingAvg_8h_source.html#l00201">201</a> of file <a class="el" href="movingAvg_8h_source.html">movingAvg.h</a>.</p>

</div>
</div>
Expand Down
6 changes: 4 additions & 2 deletions functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ <h3><a id="index__5F"></a>- _ -</h3><ul>

<h3><a id="index_a"></a>- a -</h3><ul>
<li>addValue()
: <a class="el" href="classmovingAvg.html#aa0d0d8ba97b9d3fdfdbcf3a0b8d8f0f5">movingAvg&lt; T, DURATION_IN_MINUTES, VALUES_PER_MINUTE &gt;</a>
: <a class="el" href="classEWMA__average.html#a208b9b3d82809466b4d90aedb3c7e4db">EWMA_average&lt; A &gt;</a>
, <a class="el" href="classmovingAvg.html#aa0d0d8ba97b9d3fdfdbcf3a0b8d8f0f5">movingAvg&lt; T, DURATION_IN_MINUTES, VALUES_PER_MINUTE &gt;</a>
</li>
</ul>

Expand Down Expand Up @@ -114,7 +115,8 @@ <h3><a id="index_g"></a>- g -</h3><ul>
: <a class="el" href="classrelayOutput.html#a65b71555314d24f62e1f6576f0836796">relayOutput&lt; T &gt;</a>
</li>
<li>getAverage()
: <a class="el" href="classmovingAvg.html#a1dcbea2038fad2497a67aecbf8605aae">movingAvg&lt; T, DURATION_IN_MINUTES, VALUES_PER_MINUTE &gt;</a>
: <a class="el" href="classEWMA__average.html#a6fbbe5221e07dccf5bb8af302c9c59f1">EWMA_average&lt; A &gt;</a>
, <a class="el" href="classmovingAvg.html#a1dcbea2038fad2497a67aecbf8605aae">movingAvg&lt; T, DURATION_IN_MINUTES, VALUES_PER_MINUTE &gt;</a>
</li>
<li>getDuration()
: <a class="el" href="classpairForceLoad.html#a0b4b18f7af62c643c8672d77c365b0d2">pairForceLoad</a>
Expand Down
Loading

0 comments on commit 657cb37

Please sign in to comment.