battery_monitor.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020, Richard Henrichsen
3  *
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * * Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * * Neither the name of the copyright holder nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef BATTERYMONITOR_H
33 #define BATTERYMONITOR_H
34 
35 #include "analog_pin.h"
36 #include "system.h"
37 
45 {
46 public:
57  void init(const BatteryMonitorHardwareStruct &def,
59  float voltage_multiplier = 0,
60  float current_multiplier = 0);
65  float read_voltage() const;
70  float read_current() const;
82  void set_voltage_multiplier(double multiplier);
93  void set_current_multiplier(double multiplier);
99  bool has_voltage_sense() const;
105  bool has_current_sense() const;
106 
107 private:
112 };
113 
114 #endif // BATTERYMONITOR_H
A driver for the analog-digital converters available on the microcontroller.
bool has_current_sense() const
Checks if current sense is available. As there isn't hardware to detect this, this simply checks if t...
void set_voltage_multiplier(double multiplier)
Sets the voltage multiplier for the battery monitor.
bool has_voltage_sense() const
Checks if voltage sense is available. As there isn't hardware to detect this, this simply checks if t...
float read_current() const
Read the current battery current.
AnalogPin voltage_pin_
float read_voltage() const
Read the current battery voltage.
A class to represent a single pin configured for analog input.
Definition: analog_pin.h:44
AnalogPin current_pin_
void set_current_multiplier(double multiplier)
Sets the current multiplier for the battery monitor.
A driver for analog battery monitors.
void init(const BatteryMonitorHardwareStruct &def, AnalogDigitalConverter *adc, float voltage_multiplier=0, float current_multiplier=0)
Initialize the battery monitor.


rosflight_firmware
Author(s): Daniel Koch , James Jackson
autogenerated on Fri Oct 9 2020 03:17:15