<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GearBox Project</title>
<link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<!-- Google Analytics -->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3583782-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<!-- Returning you to your regular programming -->
</head><body>
<!-- Header -->
<table border="0" cellspacing="0" cellpadding="0">
<tr><!-- create row -->
<!-- spacer cell -->
<!-- #CC CC CC -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- menu cell -->
<td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE">
<p> </p>
<p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br>
<strong>INTRODUCTION</strong><br>
<strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br>
<strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br>
<!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> -->
<strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br>
<strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br>
<br>
<strong>REPOSITORY</strong><br>
<strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br>
<!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> -->
<br>
<strong>DEVELOPER</strong><br>
<!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br>
<strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>-->
<strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br>
<!--
<strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br>
-->
<strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br>
<!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br>
login/pass: orca/orca<br>-->
<br>
<strong>PEOPLE</strong><br>
<strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br>
<strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br>
<br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br>
<strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br>
<strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br>
<!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>-->
<strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p>
<p> </p>
</td><!-- /menu cell -->
<!-- one grey spacer cells -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- one white spacer cells -->
<td rowspan="1" colspan="1"> </td>
<!-- main content cell -->
<td rowspan="1" colspan="1" align="left" valign="top">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>GbxSmartBatteryAcfr<br/>
<small>
[<a class="el" href="group__gbx__libs.html">Libraries</a>, <a class="el" href="group__gbx__hardware.html">Hardware Drivers</a>, <a class="el" href="group__gbx__cpp.html">C++</a>, <a class="el" href="group__gbx__linux.html">Linux</a>]</small>
</h1>
<p>A library to read data from a smart battery system.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
</table>
<p>A library to read data from a smart battery system. </p>
<p>This library provides a set of classes and functions to read data from a Smart Battery System (SBS). SBS is a specification for determining accurate battery readings. The library also contains classes which are specialised to a battery system provided by OceanServer Technologies Inc.</p>
<p>For a full list of classes and functions, see <a class="el" href="namespacegbxsmartbatteryacfr.html">gbxsmartbatteryacfr</a>.</p>
<dl class="user"><dt><b>Header file</b></dt><dd></dd></dl>
<div class="fragment"><pre class="fragment">
#include <gbxsmartbatteryacfr/gbxsmartbatteryacfr.h>
</pre></div><dl class="user"><dt><b>Examples</b></dt><dd><ul>
<li>See 'test/shorttest.cpp' for a simple example of how to use the library. The test makes use of the 'oceanserver' class to read a few records from the oceanserver system and prints the results on the screen.</li>
<li>See 'test/longtest.cpp' for an example which continuously reads from an oceanserver system and conducts health checks according to hard-coded health thresholds.</li>
</ul>
</dd></dl>
<dl class="user"><dt><b>Style</b></dt><dd>See <a href="http://orca-robotics.sourceforge.net/orca/orca_doc_style.html">http://orca-robotics.sourceforge.net/orca/orca_doc_style.html</a></dd></dl>
<dl class="user"><dt><b>Copyright</b></dt><dd>Tobias Kaupp</dd></dl>
<dl class="user"><dt><b>Responsible Developer</b></dt><dd>Tobias Kaupp</dd></dl>
<dl class="user"><dt><b>License</b></dt><dd>LGPL</dd></dl>
<dl class="user"><dt><b>Dependencies</b></dt><dd></dd></dl>
<ul>
<li><a class="el" href="group__gbx__library__gbxutilacfr.html">GbxUtilAcfr</a></li>
<li><a class="el" href="group__gbx__library__gbxserialacfr.html">libGbxSerialAcfr</a></li>
</ul>
<dl class="user"><dt><b>Limitations</b></dt><dd></dd></dl>
<ul>
<li>This is a Linux-only implementation (due to the Linux-only serial library).</li>
<li>It works with those serial devices which <a class="el" href="group__gbx__library__gbxserialacfr.html">libGbxSerialAcfr</a> supports.</li>
<li>The library is tailored to the OceanServer battery system.</li>
<li>Has been tested with Battery Management Modules MP08SR and BB04FR and a variable number of battery modules of type BA95HC-FL (individual modules can be added and removed at runtime).</li>
<li>Has been tested with the following firmware: V2.10 (2007)</li>
</ul>
<dl class="user"><dt><b>MP08SR and BB04FR Layouts</b></dt><dd></dd></dl>
<p>The battery number reported by the driver corresponds to the following connectors on the Battery Management Module boards (the BB04FR board only has the lower level whereas the MP08SR has both levels):</p>
<div class="fragment"><pre class="fragment">
Level 1 (lower level):
==================
| |
(J22) 4 | | 2 (J21)
(J17) 3 | | 1 (J12)
==================
Level 2 (upper level):
==================
| |
(J22) 8 | | 6 (J21)
(J17) 7 | | 5 (J12)
==================
</pre></div><p>Note that the lower level needs to be powered (at least one battery module needs to be plugged in) to be able to read from the serial port.</p>
<dl class="user"><dt><b>References</b></dt><dd><ul>
<li>SmartBattery standard: <a href="http://sbs-forum.org/specs/">http://sbs-forum.org/specs/</a></li>
<li>OceanServer battery systems: <a href="http://www.ocean-server.com/overview.html">http://www.ocean-server.com/overview.html</a></li>
<li>OceanServer battery system manuals: <a href="http://www.ocean-server.com/download.html">http://www.ocean-server.com/download.html</a></li>
<li>OceanServer online store: <a href="http://www.oceanserver-store.com/">http://www.oceanserver-store.com/</a> </li>
</ul>
</dd></dl>
</div>
</td>
<td colspan="1"> </td>
</tr>
</table>
<!-- end of table -->
<hr size="1"><address style="align: right;"><small>Generated for GearBox by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
