Deploy ahpohl/libabbaurora to github.com/ahpohl/libabbaurora.git:gh-p…

…ages

annotated.html

@@ -98,9 +98,9 @@
 <div class="textblock">Here are the data structures 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 class="icona"><span class="icon">C</span></span><a class="el" href="class_a_b_b_aurora.html" target="_self">ABBAurora</a></td><td class="desc">Communication protocol between host and supervisor microprocessor </td></tr>
-<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_b_b_aurora_1_1_firmware_release.html" target="_self">FirmwareRelease</a></td><td class="desc">Data structure for the read firmware release command </td></tr>
+<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_b_b_aurora_1_1_firmware_release.html" target="_self">FirmwareRelease</a></td><td class="desc"></td></tr>
 <tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_b_b_aurora_1_1_last_four_alarms.html" target="_self">LastFourAlarms</a></td><td class="desc">Data structure for last four alarms command </td></tr>
-<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_b_b_aurora_1_1_manufacturing_date.html" target="_self">ManufacturingDate</a></td><td class="desc">Data structure for the read manufacturing date command </td></tr>
+<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_b_b_aurora_1_1_manufacturing_date.html" target="_self">ManufacturingDate</a></td><td class="desc"></td></tr>
 <tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_b_b_aurora_1_1_state.html" target="_self">State</a></td><td class="desc">Data structure for <a class="el" href="class_a_b_b_aurora.html#aab92a4cbcb00e3482e52fdf7af2df571" title="Read system state. ">ReadState()</a> </td></tr>
 <tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_b_b_aurora_1_1_time_date.html" target="_self">TimeDate</a></td><td class="desc">Data structure for time/date reading command </td></tr>
 <tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_b_b_aurora_1_1_version.html" target="_self">Version</a></td><td class="desc">Data structure for version reading command </td></tr>

class_a_b_b_aurora.html

@@ -110,13 +110,11 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 Data Structures</h2></td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_b_b_aurora_1_1_firmware_release.html">FirmwareRelease</a></td></tr>
-<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure for the read firmware release command.  <a href="struct_a_b_b_aurora_1_1_firmware_release.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_b_b_aurora_1_1_last_four_alarms.html">LastFourAlarms</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure for last four alarms command.  <a href="struct_a_b_b_aurora_1_1_last_four_alarms.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_b_b_aurora_1_1_manufacturing_date.html">ManufacturingDate</a></td></tr>
-<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure for the read manufacturing date command.  <a href="struct_a_b_b_aurora_1_1_manufacturing_date.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_b_b_aurora_1_1_state.html">State</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure for <a class="el" href="class_a_b_b_aurora.html#aab92a4cbcb00e3482e52fdf7af2df571" title="Read system state. ">ReadState()</a>  <a href="struct_a_b_b_aurora_1_1_state.html#details">More...</a><br /></td></tr>

example_alarms_8cpp-example.html

@@ -96,7 +96,7 @@
 </div><!--header-->
 <div class="contents">
 <p>This example reads the last four alarms. </p><div class="fragment"><div class="line">Global state: Run</div><div class="line">Alarm 1: No Alarm</div><div class="line">Alarm 2: No Alarm</div><div class="line">Alarm 3: No Alarm</div><div class="line">Alarm 4: No Alarm</div></div><!-- fragment --><p> The output is equivalent to "aurora -a 2 -A /dev/ttyUSB0"</p>
-<div class="fragment"><div class="line"></div><div class="line"><span class="preprocessor">#include &lt;iostream&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><span class="preprocessor">#include &quot;ABBAurora.h&quot;</span></div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[])</div><div class="line">{</div><div class="line">  <span class="keyword">const</span> std::string device = <span class="stringliteral">&quot;/dev/ttyUSB0&quot;</span>;</div><div class="line">  </div><div class="line">  std::unique_ptr&lt;ABBAurora&gt; inverter(<span class="keyword">new</span> <a name="_a0"></a><a class="code" href="class_a_b_b_aurora.html">ABBAurora</a>());</div><div class="line"></div><div class="line">  <span class="keywordflow">if</span> (!inverter-&gt;Setup(device))</div><div class="line">  {</div><div class="line">    std::cout &lt;&lt; inverter-&gt;GetErrorMessage() &lt;&lt; std::endl;</div><div class="line">    <span class="keywordflow">return</span> EXIT_FAILURE;</div><div class="line">  }</div><div class="line"></div><div class="line">  <a name="_a1"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html">ABBAurora::LastFourAlarms</a> alarms;</div><div class="line">  <span class="keywordflow">if</span> (!inverter-&gt;ReadLastFourAlarms(alarms))</div><div class="line">  {</div><div class="line">    std::cout &lt;&lt; inverter-&gt;GetErrorMessage() &lt;&lt; std::endl;</div><div class="line">    <span class="keywordflow">return</span> EXIT_FAILURE;</div><div class="line">  }</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Global state: &quot;</span> &lt;&lt; alarms.<a name="a2"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#a422884e7901011b1168bfe0404750bb6">GlobalState</a> &lt;&lt; std::endl;</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Alarm 1: &quot;</span> &lt;&lt; alarms.<a name="a3"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#ae3221dab6c2fd52b32a97cfaaa84127a">Alarm1</a> &lt;&lt; std::endl;</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Alarm 2: &quot;</span> &lt;&lt; alarms.<a name="a4"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#ae7f4b949038a918e04c1adcd012008ff">Alarm2</a> &lt;&lt; std::endl;</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Alarm 3: &quot;</span> &lt;&lt; alarms.<a name="a5"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#a1abeee7cb788a47d2cb4e55f1717390f">Alarm3</a> &lt;&lt; std::endl;</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Alarm 4: &quot;</span> &lt;&lt; alarms.<a name="a6"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#a3baa03992806a4caba3b5bc5fba54ad6">Alarm4</a> &lt;&lt; std::endl;</div><div class="line"></div><div class="line">  <span class="keywordflow">return</span> EXIT_SUCCESS;</div><div class="line">}</div></div><!-- fragment --> </div><!-- contents -->
+<div class="fragment"><div class="line"></div><div class="line"><span class="preprocessor">#include &quot;ABBAurora.h&quot;</span></div><div class="line"><span class="preprocessor">#include &lt;iostream&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[]) {</div><div class="line">  <span class="keyword">const</span> std::string device = <span class="stringliteral">&quot;/dev/ttyUSB0&quot;</span>;</div><div class="line"></div><div class="line">  std::unique_ptr&lt;ABBAurora&gt; inverter(<span class="keyword">new</span> <a name="_a0"></a><a class="code" href="class_a_b_b_aurora.html">ABBAurora</a>());</div><div class="line"></div><div class="line">  <span class="keywordflow">if</span> (!inverter-&gt;Setup(device)) {</div><div class="line">    std::cout &lt;&lt; inverter-&gt;GetErrorMessage() &lt;&lt; std::endl;</div><div class="line">    <span class="keywordflow">return</span> EXIT_FAILURE;</div><div class="line">  }</div><div class="line"></div><div class="line">  <a name="_a1"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html">ABBAurora::LastFourAlarms</a> alarms;</div><div class="line">  <span class="keywordflow">if</span> (!inverter-&gt;ReadLastFourAlarms(alarms)) {</div><div class="line">    std::cout &lt;&lt; inverter-&gt;GetErrorMessage() &lt;&lt; std::endl;</div><div class="line">    <span class="keywordflow">return</span> EXIT_FAILURE;</div><div class="line">  }</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Global state: &quot;</span> &lt;&lt; alarms.<a name="a2"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#a422884e7901011b1168bfe0404750bb6">GlobalState</a> &lt;&lt; std::endl;</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Alarm 1: &quot;</span> &lt;&lt; alarms.<a name="a3"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#ae3221dab6c2fd52b32a97cfaaa84127a">Alarm1</a> &lt;&lt; std::endl;</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Alarm 2: &quot;</span> &lt;&lt; alarms.<a name="a4"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#ae7f4b949038a918e04c1adcd012008ff">Alarm2</a> &lt;&lt; std::endl;</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Alarm 3: &quot;</span> &lt;&lt; alarms.<a name="a5"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#a1abeee7cb788a47d2cb4e55f1717390f">Alarm3</a> &lt;&lt; std::endl;</div><div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;Alarm 4: &quot;</span> &lt;&lt; alarms.<a name="a6"></a><a class="code" href="struct_a_b_b_aurora_1_1_last_four_alarms.html#a3baa03992806a4caba3b5bc5fba54ad6">Alarm4</a> &lt;&lt; std::endl;</div><div class="line"></div><div class="line">  <span class="keywordflow">return</span> EXIT_SUCCESS;</div><div class="line">}</div></div><!-- fragment --> </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->