📄 struct_battery_state.html
字号:
<!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>BlueLab: BatteryState Struct Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.8 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>BatteryState Struct Reference</h1>The internal state of each instance of the battery library. <a href="#_details">More...</a><p><h2>Data Fields</h2><ul><li><a class="el" href="struct_task_data.html">TaskData</a> <a class="el" href="struct_battery_state.html#o0">task</a><li><a class="el" href="struct_task_data.html">Task</a> <a class="el" href="struct_battery_state.html#o1">client</a><li><a class="el" href="csrtypes_8h.html#a4">uint16</a> <a class="el" href="struct_battery_state.html#o2">period</a><li><a class="el" href="battery_8h.html#a8">battery_reading_source</a> <a class="el" href="struct_battery_state.html#o3">source</a>:3<li>int <a class="el" href="struct_battery_state.html#o4">readings_taken</a>:13<li><a class="el" href="csrtypes_8h.html#a4">uint16</a> <a class="el" href="struct_battery_state.html#o5">vdd_reading</a><li><a class="el" href="csrtypes_8h.html#a4">uint16</a> <a class="el" href="struct_battery_state.html#o6">mv_running_total</a></ul><hr><a name="_details"></a><h2>Detailed Description</h2>The internal state of each instance of the battery library. <p><hr><h2>Field Documentation</h2><a class="anchor" name="o0" doxytag="BatteryState::task" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="struct_task_data.html">TaskData</a> <a class="el" href="struct_battery_state.html#o0">BatteryState::task</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>This task (receives the raw messages from the ADC.) </td> </tr></table><a class="anchor" name="o1" doxytag="BatteryState::client" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="struct_task_data.html">Task</a> <a class="el" href="struct_battery_state.html#o1">BatteryState::client</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The client task (receives readings in mV.) </td> </tr></table><a class="anchor" name="o2" doxytag="BatteryState::period" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a4">uint16</a> <a class="el" href="struct_battery_state.html#o2">BatteryState::period</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The time between requests to the ADC in millseconds </td> </tr></table><a class="anchor" name="o3" doxytag="BatteryState::source" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="battery_8h.html#a8">battery_reading_source</a> <a class="el" href="struct_battery_state.html#o3">BatteryState::source</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The source from which we wish to take voltage readings. </td> </tr></table><a class="anchor" name="o4" doxytag="BatteryState::readings_taken" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int <a class="el" href="struct_battery_state.html#o4">BatteryState::readings_taken</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The number of readings we have taken so far. </td> </tr></table><a class="anchor" name="o5" doxytag="BatteryState::vdd_reading" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a4">uint16</a> <a class="el" href="struct_battery_state.html#o5">BatteryState::vdd_reading</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The estimated supply voltage. </td> </tr></table><a class="anchor" name="o6" doxytag="BatteryState::mv_running_total" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a4">uint16</a> <a class="el" href="struct_battery_state.html#o6">BatteryState::mv_running_total</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The running total of all our readings so far. </td> </tr></table><hr>The documentation for this struct was generated from the following file:<ul><li><a class="el" href="battery_8h.html">battery.h</a></ul></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -