Skip to content

Commit

Permalink
Issue #33
Browse files Browse the repository at this point in the history
  • Loading branch information
SV-Zanshin authored and SV-Zanshin committed Dec 28, 2018
1 parent c07ea81 commit e864b71
Show file tree
Hide file tree
Showing 55 changed files with 1,219 additions and 439 deletions.
4 changes: 2 additions & 2 deletions doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ EXTRACT_ALL = NO
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
Expand Down Expand Up @@ -849,7 +849,7 @@ EXCLUDE_SYMLINKS = NO
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*

EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS = .*

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
Expand Down
252 changes: 252 additions & 0 deletions doxygen/html/_background_read_8ino.html

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions doxygen/html/_background_read_8ino.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
var _background_read_8ino =
[
[ "ISR", "_background_read_8ino.html#aa64c6dce15e9de9105b4ae9533c9a267", null ],
[ "loop", "_background_read_8ino.html#afe461d27b9c48d5921c00d521181f12f", null ],
[ "setup", "_background_read_8ino.html#a4fc01d736fe50cf5b977f755b675f11d", null ],
[ "deviceNumber", "_background_read_8ino.html#aa288141c88c2063ca23516ce595d6a94", null ],
[ "GREEN_LED_PIN", "_background_read_8ino.html#a4cc57301563e3c5c906dbad9f19a7d94", null ],
[ "INA", "_background_read_8ino.html#a67d666137ef9b3c8b6d60b6f1dbf6970", null ],
[ "INA_ALERT_PIN", "_background_read_8ino.html#af0b8bdc479bf42af4e35a7a31b857373", null ],
[ "readings", "_background_read_8ino.html#a9ec15d11de9a04bef54462745f3aa1a8", null ],
[ "SERIAL_SPEED", "_background_read_8ino.html#adc8430dea1bce949f10d9708742cca34", null ],
[ "sumBusMicroAmps", "_background_read_8ino.html#a8fdb94b9f9a7329cf8b69ba8e81c04a4", null ],
[ "sumBusMillVolts", "_background_read_8ino.html#a6505ef3b8859931529079f24ba25054e", null ]
];
3 changes: 2 additions & 1 deletion doxygen/html/_i_n_a_8h_source.html

Large diffs are not rendered by default.

46 changes: 23 additions & 23 deletions doxygen/html/class_i_n_a___class.html

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions doxygen/html/dir_bbb27c2ef2aa6cd43804f9e42f285558.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,13 @@
<div class="title">BackgroundRead Directory Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:_background_read_8ino"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_background_read_8ino.html">BackgroundRead.ino</a></td></tr>
<tr class="memdesc:_background_read_8ino"><td class="mdescLeft">&#160;</td><td class="mdescRight">Example program for the INA Library demonstrating background reads. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion doxygen/html/dir_bbb27c2ef2aa6cd43804f9e42f285558.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var dir_bbb27c2ef2aa6cd43804f9e42f285558 =
[
[ "__vm", "dir_b64c63f9b977cae7d9aac8d963750534.html", "dir_b64c63f9b977cae7d9aac8d963750534" ]
[ "BackgroundRead.ino", "_background_read_8ino.html", "_background_read_8ino" ]
];
4 changes: 1 addition & 3 deletions doxygen/html/dir_d28a4824dc47e487b107a5db32ef43c4.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
var dir_d28a4824dc47e487b107a5db32ef43c4 =
[
[ "BackgroundRead", "dir_bbb27c2ef2aa6cd43804f9e42f285558.html", "dir_bbb27c2ef2aa6cd43804f9e42f285558" ],
[ "DataLogger", "dir_3a86fa53a7af35fdeea377fe5e908f57.html", "dir_3a86fa53a7af35fdeea377fe5e908f57" ],
[ "DisplayReadings", "dir_a82ff50500b12b6a7f9997259499714f.html", "dir_a82ff50500b12b6a7f9997259499714f" ]
[ "BackgroundRead", "dir_bbb27c2ef2aa6cd43804f9e42f285558.html", "dir_bbb27c2ef2aa6cd43804f9e42f285558" ]
];
11 changes: 7 additions & 4 deletions doxygen/html/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,13 @@
</div><!--header-->
<div class="contents">
<div class="textblock">Here is a list of all documented files with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span id="img_0_" class="iconfopen" onclick="toggleFolder('0_')">&#160;</span><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html" target="_self">src</a></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="_i_n_a_8cpp.html" target="_self">INA.cpp</a></td><td class="desc">INA Class library definitions file </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="_i_n_a_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_i_n_a_8h.html" target="_self">INA.h</a></td><td class="desc">INA Class library header file </td></tr>
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span id="img_0_" class="iconfopen" onclick="toggleFolder('0_')">&#160;</span><a class="el" href="dir_d28a4824dc47e487b107a5db32ef43c4.html" target="_self">examples</a></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span id="img_0_0_" class="iconfopen" onclick="toggleFolder('0_0_')">&#160;</span><a class="el" href="dir_bbb27c2ef2aa6cd43804f9e42f285558.html" target="_self">BackgroundRead</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="_background_read_8ino.html" target="_self">BackgroundRead.ino</a></td><td class="desc">Example program for the INA Library demonstrating background reads </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span id="img_1_" class="iconfopen" onclick="toggleFolder('1_')">&#160;</span><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html" target="_self">src</a></td><td class="desc"></td></tr>
<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="_i_n_a_8cpp.html" target="_self">INA.cpp</a></td><td class="desc">INA Class library definitions file </td></tr>
<tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="_i_n_a_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_i_n_a_8h.html" target="_self">INA.h</a></td><td class="desc">INA Class library header file </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
1 change: 1 addition & 0 deletions doxygen/html/files_dup.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
var files_dup =
[
[ "examples", "dir_d28a4824dc47e487b107a5db32ef43c4.html", "dir_d28a4824dc47e487b107a5db32ef43c4" ],
[ "src", "dir_68267d1309a1af8e8297ef4c3efbcdba.html", "dir_68267d1309a1af8e8297ef4c3efbcdba" ]
];
53 changes: 53 additions & 0 deletions doxygen/html/globals.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,27 @@
<div class="contents">
<div class="textblock">Here is a list of all documented file members with links to the documentation:</div>

<h3><a id="index_d"></a>- d -</h3><ul>
<li>deviceNumber
: <a class="el" href="_background_read_8ino.html#aa288141c88c2063ca23516ce595d6a94">BackgroundRead.ino</a>
</li>
</ul>


<h3><a id="index_g"></a>- g -</h3><ul>
<li>GREEN_LED_PIN
: <a class="el" href="_background_read_8ino.html#a4cc57301563e3c5c906dbad9f19a7d94">BackgroundRead.ino</a>
</li>
</ul>


<h3><a id="index_i"></a>- i -</h3><ul>
<li>I2C_DELAY
: <a class="el" href="_i_n_a_8h.html#a8d9ae857556fa838283459b089bedef9">INA.h</a>
</li>
<li>INA
: <a class="el" href="_background_read_8ino.html#a67d666137ef9b3c8b6d60b6f1dbf6970">BackgroundRead.ino</a>
</li>
<li>INA219_BRNG_BIT
: <a class="el" href="_i_n_a_8h.html#aa017545006066ec0868060daf994a1e5">INA.h</a>
</li>
Expand Down Expand Up @@ -192,6 +209,9 @@ <h3><a id="index_i"></a>- i -</h3><ul>
<li>INA_ALERT_MASK
: <a class="el" href="_i_n_a_8h.html#a4c07319ad308f1b8e4b36a62ab1be46d">INA.h</a>
</li>
<li>INA_ALERT_PIN
: <a class="el" href="_background_read_8ino.html#af0b8bdc479bf42af4e35a7a31b857373">BackgroundRead.ino</a>
</li>
<li>INA_ALERT_POWER_OVER_WATT_BIT
: <a class="el" href="_i_n_a_8h.html#a4f6397744737e4995d6929182f60a02b">INA.h</a>
</li>
Expand Down Expand Up @@ -279,6 +299,39 @@ <h3><a id="index_i"></a>- i -</h3><ul>
<li>inaDet
: <a class="el" href="_i_n_a_8h.html#ab2deadb66c4e51402becbdc62b752d28">INA.h</a>
</li>
<li>ISR()
: <a class="el" href="_background_read_8ino.html#aa64c6dce15e9de9105b4ae9533c9a267">BackgroundRead.ino</a>
</li>
</ul>


<h3><a id="index_l"></a>- l -</h3><ul>
<li>loop()
: <a class="el" href="_background_read_8ino.html#afe461d27b9c48d5921c00d521181f12f">BackgroundRead.ino</a>
</li>
</ul>


<h3><a id="index_r"></a>- r -</h3><ul>
<li>readings
: <a class="el" href="_background_read_8ino.html#a9ec15d11de9a04bef54462745f3aa1a8">BackgroundRead.ino</a>
</li>
</ul>


<h3><a id="index_s"></a>- s -</h3><ul>
<li>SERIAL_SPEED
: <a class="el" href="_background_read_8ino.html#adc8430dea1bce949f10d9708742cca34">BackgroundRead.ino</a>
</li>
<li>setup()
: <a class="el" href="_background_read_8ino.html#a4fc01d736fe50cf5b977f755b675f11d">BackgroundRead.ino</a>
</li>
<li>sumBusMicroAmps
: <a class="el" href="_background_read_8ino.html#a8fdb94b9f9a7329cf8b69ba8e81c04a4">BackgroundRead.ino</a>
</li>
<li>sumBusMillVolts
: <a class="el" href="_background_read_8ino.html#a6505ef3b8859931529079f24ba25054e">BackgroundRead.ino</a>
</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
Expand Down
112 changes: 112 additions & 0 deletions doxygen/html/globals_func.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>INA: File Members</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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">INA
&#160;<span id="projectnumber">1.0.7</span>
</div>
<div id="projectbrief">Arduino Library for various INAxxx devices</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('globals_func.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="contents">
&#160;<ul>
<li>ISR()
: <a class="el" href="_background_read_8ino.html#aa64c6dce15e9de9105b4ae9533c9a267">BackgroundRead.ino</a>
</li>
<li>loop()
: <a class="el" href="_background_read_8ino.html#afe461d27b9c48d5921c00d521181f12f">BackgroundRead.ino</a>
</li>
<li>setup()
: <a class="el" href="_background_read_8ino.html#a4fc01d736fe50cf5b977f755b675f11d">BackgroundRead.ino</a>
</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
40 changes: 40 additions & 0 deletions doxygen/html/globals_vars.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,27 @@
<div class="contents">
&#160;

<h3><a id="index_d"></a>- d -</h3><ul>
<li>deviceNumber
: <a class="el" href="_background_read_8ino.html#aa288141c88c2063ca23516ce595d6a94">BackgroundRead.ino</a>
</li>
</ul>


<h3><a id="index_g"></a>- g -</h3><ul>
<li>GREEN_LED_PIN
: <a class="el" href="_background_read_8ino.html#a4cc57301563e3c5c906dbad9f19a7d94">BackgroundRead.ino</a>
</li>
</ul>


<h3><a id="index_i"></a>- i -</h3><ul>
<li>I2C_DELAY
: <a class="el" href="_i_n_a_8h.html#a8d9ae857556fa838283459b089bedef9">INA.h</a>
</li>
<li>INA
: <a class="el" href="_background_read_8ino.html#a67d666137ef9b3c8b6d60b6f1dbf6970">BackgroundRead.ino</a>
</li>
<li>INA219_BRNG_BIT
: <a class="el" href="_i_n_a_8h.html#aa017545006066ec0868060daf994a1e5">INA.h</a>
</li>
Expand Down Expand Up @@ -192,6 +209,9 @@ <h3><a id="index_i"></a>- i -</h3><ul>
<li>INA_ALERT_MASK
: <a class="el" href="_i_n_a_8h.html#a4c07319ad308f1b8e4b36a62ab1be46d">INA.h</a>
</li>
<li>INA_ALERT_PIN
: <a class="el" href="_background_read_8ino.html#af0b8bdc479bf42af4e35a7a31b857373">BackgroundRead.ino</a>
</li>
<li>INA_ALERT_POWER_OVER_WATT_BIT
: <a class="el" href="_i_n_a_8h.html#a4f6397744737e4995d6929182f60a02b">INA.h</a>
</li>
Expand Down Expand Up @@ -247,6 +267,26 @@ <h3><a id="index_i"></a>- i -</h3><ul>
: <a class="el" href="_i_n_a_8h.html#a72fbdc796e1d561ba632d28620bbe039">INA.h</a>
</li>
</ul>


<h3><a id="index_r"></a>- r -</h3><ul>
<li>readings
: <a class="el" href="_background_read_8ino.html#a9ec15d11de9a04bef54462745f3aa1a8">BackgroundRead.ino</a>
</li>
</ul>


<h3><a id="index_s"></a>- s -</h3><ul>
<li>SERIAL_SPEED
: <a class="el" href="_background_read_8ino.html#adc8430dea1bce949f10d9708742cca34">BackgroundRead.ino</a>
</li>
<li>sumBusMicroAmps
: <a class="el" href="_background_read_8ino.html#a8fdb94b9f9a7329cf8b69ba8e81c04a4">BackgroundRead.ino</a>
</li>
<li>sumBusMillVolts
: <a class="el" href="_background_read_8ino.html#a6505ef3b8859931529079f24ba25054e">BackgroundRead.ino</a>
</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
14 changes: 12 additions & 2 deletions doxygen/html/menudata.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,19 @@ var menudata={children:[
{text:"File List",url:"files.html"},
{text:"File Members",url:"globals.html",children:[
{text:"All",url:"globals.html",children:[
{text:"i",url:"globals.html#index_i"}]},
{text:"d",url:"globals.html#index_d"},
{text:"g",url:"globals.html#index_g"},
{text:"i",url:"globals.html#index_i"},
{text:"l",url:"globals.html#index_l"},
{text:"r",url:"globals.html#index_r"},
{text:"s",url:"globals.html#index_s"}]},
{text:"Functions",url:"globals_func.html"},
{text:"Variables",url:"globals_vars.html",children:[
{text:"i",url:"globals_vars.html#index_i"}]},
{text:"d",url:"globals_vars.html#index_d"},
{text:"g",url:"globals_vars.html#index_g"},
{text:"i",url:"globals_vars.html#index_i"},
{text:"r",url:"globals_vars.html#index_r"},
{text:"s",url:"globals_vars.html#index_s"}]},
{text:"Typedefs",url:"globals_type.html"},
{text:"Enumerations",url:"globals_enum.html"},
{text:"Enumerator",url:"globals_eval.html"}]}]}]}
3 changes: 2 additions & 1 deletion doxygen/html/navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ var NAVTREE =
[ "File List", "files.html", "files_dup" ],
[ "File Members", "globals.html", [
[ "All", "globals.html", null ],
[ "Functions", "globals_func.html", null ],
[ "Variables", "globals_vars.html", null ],
[ "Typedefs", "globals_type.html", null ],
[ "Enumerations", "globals_enum.html", null ],
Expand All @@ -55,7 +56,7 @@ var NAVTREE =

var NAVTREEINDEX =
[
"_i_n_a_8cpp.html"
"_background_read_8ino.html"
];

var SYNCONMSG = 'click to disable panel synchronisation';
Expand Down
Loading

0 comments on commit e864b71

Please sign in to comment.