-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3003 from itCarl/usermod-battery-update2023
Usermod Battery 🔋 Added Support for different battery types, Optimized file structure
- Loading branch information
Showing
7 changed files
with
576 additions
and
233 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| #ifndef UMBBattery_h | ||
| #define UMBBattery_h | ||
|
|
||
| #include "battery_defaults.h" | ||
|
|
||
| /** | ||
| * Battery base class | ||
| * all other battery classes should inherit from this | ||
| */ | ||
| class UMBattery | ||
| { | ||
| private: | ||
|
|
||
| protected: | ||
| float minVoltage; | ||
| float maxVoltage; | ||
| float voltage; | ||
| int8_t level = 100; | ||
| float calibration; // offset or calibration value to fine tune the calculated voltage | ||
| float voltageMultiplier; // ratio for the voltage divider | ||
|
|
||
| float linearMapping(float v, float min, float max, float oMin = 0.0f, float oMax = 100.0f) | ||
| { | ||
| return (v-min) * (oMax-oMin) / (max-min) + oMin; | ||
| } | ||
|
|
||
| public: | ||
| UMBattery() | ||
| { | ||
| this->setVoltageMultiplier(USERMOD_BATTERY_VOLTAGE_MULTIPLIER); | ||
| this->setCalibration(USERMOD_BATTERY_CALIBRATION); | ||
| } | ||
|
|
||
| virtual void update(batteryConfig cfg) | ||
| { | ||
| if(cfg.minVoltage) this->setMinVoltage(cfg.minVoltage); | ||
| if(cfg.maxVoltage) this->setMaxVoltage(cfg.maxVoltage); | ||
| if(cfg.level) this->setLevel(cfg.level); | ||
| if(cfg.calibration) this->setCalibration(cfg.calibration); | ||
| if(cfg.voltageMultiplier) this->setVoltageMultiplier(cfg.voltageMultiplier); | ||
| } | ||
|
|
||
| /** | ||
| * Corresponding battery curves | ||
| * calculates the level in % (0-100) with given voltage and possible voltage range | ||
| */ | ||
| virtual float mapVoltage(float v, float min, float max) = 0; | ||
| // { | ||
| // example implementation, linear mapping | ||
| // return (v-min) * 100 / (max-min); | ||
| // }; | ||
|
|
||
| virtual void calculateAndSetLevel(float voltage) = 0; | ||
|
|
||
|
|
||
|
|
||
| /* | ||
| * | ||
| * Getter and Setter | ||
| * | ||
| */ | ||
|
|
||
| /* | ||
| * Get lowest configured battery voltage | ||
| */ | ||
| virtual float getMinVoltage() | ||
| { | ||
| return this->minVoltage; | ||
| } | ||
|
|
||
| /* | ||
| * Set lowest battery voltage | ||
| * can't be below 0 volt | ||
| */ | ||
| virtual void setMinVoltage(float voltage) | ||
| { | ||
| this->minVoltage = max(0.0f, voltage); | ||
| } | ||
|
|
||
| /* | ||
| * Get highest configured battery voltage | ||
| */ | ||
| virtual float getMaxVoltage() | ||
| { | ||
| return this->maxVoltage; | ||
| } | ||
|
|
||
| /* | ||
| * Set highest battery voltage | ||
| * can't be below minVoltage | ||
| */ | ||
| virtual void setMaxVoltage(float voltage) | ||
| { | ||
| this->maxVoltage = max(getMinVoltage()+.5f, voltage); | ||
| } | ||
|
|
||
| float getVoltage() | ||
| { | ||
| return this->voltage; | ||
| } | ||
|
|
||
| /** | ||
| * check if voltage is within specified voltage range, allow 10% over/under voltage | ||
| */ | ||
| void setVoltage(float voltage) | ||
| { | ||
| // this->voltage = ( (voltage < this->getMinVoltage() * 0.85f) || (voltage > this->getMaxVoltage() * 1.1f) ) | ||
| // ? -1.0f | ||
| // : voltage; | ||
| this->voltage = voltage; | ||
| } | ||
|
|
||
| float getLevel() | ||
| { | ||
| return this->level; | ||
| } | ||
|
|
||
| void setLevel(float level) | ||
| { | ||
| this->level = constrain(level, 0.0f, 110.0f); | ||
| } | ||
|
|
||
| /* | ||
| * Get the configured calibration value | ||
| * a offset value to fine-tune the calculated voltage. | ||
| */ | ||
| virtual float getCalibration() | ||
| { | ||
| return calibration; | ||
| } | ||
|
|
||
| /* | ||
| * Set the voltage calibration offset value | ||
| * a offset value to fine-tune the calculated voltage. | ||
| */ | ||
| virtual void setCalibration(float offset) | ||
| { | ||
| calibration = offset; | ||
| } | ||
|
|
||
| /* | ||
| * Get the configured calibration value | ||
| * a value to set the voltage divider ratio | ||
| */ | ||
| virtual float getVoltageMultiplier() | ||
| { | ||
| return voltageMultiplier; | ||
| } | ||
|
|
||
| /* | ||
| * Set the voltage multiplier value | ||
| * a value to set the voltage divider ratio. | ||
| */ | ||
| virtual void setVoltageMultiplier(float multiplier) | ||
| { | ||
| voltageMultiplier = multiplier; | ||
| } | ||
| }; | ||
|
|
||
| #endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| #ifndef UMBLion_h | ||
| #define UMBLion_h | ||
|
|
||
| #include "../battery_defaults.h" | ||
| #include "../UMBattery.h" | ||
|
|
||
| /** | ||
| * LiOn Battery | ||
| * | ||
| */ | ||
| class LionUMBattery : public UMBattery | ||
| { | ||
| private: | ||
|
|
||
| public: | ||
| LionUMBattery() : UMBattery() | ||
| { | ||
| this->setMinVoltage(USERMOD_BATTERY_LION_MIN_VOLTAGE); | ||
| this->setMaxVoltage(USERMOD_BATTERY_LION_MAX_VOLTAGE); | ||
| } | ||
|
|
||
| float mapVoltage(float v, float min, float max) override | ||
| { | ||
| return this->linearMapping(v, min, max); // basic mapping | ||
| }; | ||
|
|
||
| void calculateAndSetLevel(float voltage) override | ||
| { | ||
| this->setLevel(this->mapVoltage(voltage, this->getMinVoltage(), this->getMaxVoltage())); | ||
| }; | ||
|
|
||
| virtual void setMaxVoltage(float voltage) override | ||
| { | ||
| this->maxVoltage = max(getMinVoltage()+1.0f, voltage); | ||
| } | ||
| }; | ||
|
|
||
| #endif |
Oops, something went wrong.