-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_battery_8h_source.html
108 lines (106 loc) · 13.4 KB
/
_battery_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<!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.11"/>
<title>OXII: /home/pieter/CLionProjects/OXII/src/Components/Battery/Battery.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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">OXII
 <span id="projectnumber">0.0.0</span>
</div>
<div id="projectbrief">OXII, the Nuna On-Board computer</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</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_148f265b2a469352ff294886af73b94d.html">OXII</a></li><li class="navelem"><a class="el" href="dir_14d9778ac3ac6187df74d1bf79afd578.html">src</a></li><li class="navelem"><a class="el" href="dir_e6bf04979c53219c33f9f48e53f820f1.html">Components</a></li><li class="navelem"><a class="el" href="dir_80a53b28694ec5b338b9a9cf41528cac.html">Battery</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Battery.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Created by pieter on 5-11-18.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#ifndef OXII_BATTERY_H</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#define OXII_BATTERY_H</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "../NunaComponent.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "Pack/PackInterface.h"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="struct_battery_data.html"> 16</a></span> <span class="keyword">struct </span><a class="code" href="struct_battery_data.html">BatteryData</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keywordtype">int</span> min_temp = 0;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keywordtype">int</span> max_temp = 0;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordtype">int</span> avg_temp = 0;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordtype">int</span> min_volt = 0;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordtype">int</span> max_volt = 0;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">int</span> avg_volt = 0;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordtype">int</span> tot_volt = 0;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">int</span> tot_curr = 0;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordtype">int</span> bsoc = 0;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  vector<int> voltages;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  vector<int> temperatures;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  vector<unsigned> task_bytes_vector;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  vector<unsigned> problem_bytes_vector;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> };</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_battery.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="class_battery.html">Battery</a> : <span class="keyword">public</span> <a class="code" href="class_nuna_component.html">NunaComponent</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="class_battery.html">Battery</a>(<a class="code" href="class_nuna.html">Nuna</a> & nuna, <a class="code" href="class_pack_interface.html">PackInterface</a> & pack);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> ProcessCanFrame(<a class="code" href="class_can_frame.html">CanFrame</a> & frame) <span class="keyword">override</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> UpdateValues();</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">bool</span> IsValid(<a class="code" href="struct_battery_data.html">BatteryData</a> data);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> LogLine() <span class="keyword">override</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="class_pack_interface.html">PackInterface</a> & pack_;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="struct_battery_data.html">BatteryData</a> battery_data_{};</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  milliseconds time_since_calculation = <a class="code" href="class_time.html#ad96b431f8e839cc9d9fbdafe4e6541bb">Time::GetCurrentTimeInMillis</a>();</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span> Setup() <span class="keyword">override</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> Loop() <span class="keyword">override</span>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">bool</span> TimeToCalculate();</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> };</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif //OXII_BATTERY_H</span></div><div class="ttc" id="class_nuna_html"><div class="ttname"><a href="class_nuna.html">Nuna</a></div><div class="ttdef"><b>Definition:</b> Nuna.h:59</div></div>
<div class="ttc" id="class_battery_html"><div class="ttname"><a href="class_battery.html">Battery</a></div><div class="ttdoc">The Battery component is responsible for parsing the CAN messages that are produced by the REAP Batte...</div><div class="ttdef"><b>Definition:</b> Battery.h:39</div></div>
<div class="ttc" id="class_time_html_ad96b431f8e839cc9d9fbdafe4e6541bb"><div class="ttname"><a href="class_time.html#ad96b431f8e839cc9d9fbdafe4e6541bb">Time::GetCurrentTimeInMillis</a></div><div class="ttdeci">static milliseconds GetCurrentTimeInMillis()</div><div class="ttdoc">Returns the current system time in ms. </div><div class="ttdef"><b>Definition:</b> Time.cpp:29</div></div>
<div class="ttc" id="class_nuna_component_html"><div class="ttname"><a href="class_nuna_component.html">NunaComponent</a></div><div class="ttdoc">Basic functionality that applies to all Nuna components. </div><div class="ttdef"><b>Definition:</b> NunaComponent.h:26</div></div>
<div class="ttc" id="class_can_frame_html"><div class="ttname"><a href="class_can_frame.html">CanFrame</a></div><div class="ttdoc">General utility class for CAN-related operations. </div><div class="ttdef"><b>Definition:</b> CanFrame.h:22</div></div>
<div class="ttc" id="struct_battery_data_html"><div class="ttname"><a href="struct_battery_data.html">BatteryData</a></div><div class="ttdoc">Volt in mV. </div><div class="ttdef"><b>Definition:</b> Battery.h:16</div></div>
<div class="ttc" id="class_pack_interface_html"><div class="ttname"><a href="class_pack_interface.html">PackInterface</a></div><div class="ttdoc">The PackInterface exists in the case that the code must be compatible with multiple battery packs...</div><div class="ttdef"><b>Definition:</b> PackInterface.h:21</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>