feat: Configurable battery capacity (#502)

This closes #498

Author: zehnm

hardware-schema.json

@@ -124,6 +124,11 @@
       "title": "Battery fuel gauge",
       "properties": {
         "enabled": { "$ref": "#/definitions/enabled" },
+        "capacity": {
+            "type": "integer",
+            "minimum": 1000,
+            "default": 2500
+        },
         "i2c":  { "$ref": "#/definitions/i2c" }
       }
     },

hardware.json

@@ -35,6 +35,7 @@
     },
     "batteryFuelGauge": {
         "enabled": true,
+        "capacity": 2500,
         "i2c": {
             "device": "/dev/i2c-3",
             "id": 85

sources/hardware/batteryfuelgauge.h

@@ -71,7 +71,10 @@ class BatteryFuelGauge : public Device {
     void chargingDone();
 
  protected:
-    explicit BatteryFuelGauge(QString name, QObject *parent = nullptr) : Device(name, parent) {}
+    explicit BatteryFuelGauge(QString name, int capacity, QObject *parent = nullptr)
+        : Device(name, parent), m_capacity(capacity) {
+        Q_ASSERT(capacity);
+    }
 
-    int m_capacity = 2500;
+    int m_capacity;
 };

sources/hardware/hw_config.h

@@ -37,6 +37,7 @@
 #define HW_CFG_BTN_INTR_HANDLER   "buttonInterruptHandler"
 #define HW_CFG_BATTERY_CHARGER    "batteryCharger"
 #define HW_CFG_BATTERY_FUEL_GAUGE "batteryFuelGauge"
+#define HW_CFG_BATTERY_CAPACITY   "capacity"
 #define HW_CFG_HAPTIC_MOTOR       "hapticMotor"
 #define HW_CFG_GESTURE            "gesture"
 #define HW_CFG_LIGHT              "light"

sources/hardware/linux/arm/bq27441.cpp

@@ -34,14 +34,15 @@
 
 static Q_LOGGING_CATEGORY(CLASS_LC, "hw.dev.BQ27441");
 
-BQ27441::BQ27441(InterruptHandler *interruptHandler, const QString &i2cDevice, int i2cDeviceId, QObject *parent)
-    : BatteryFuelGauge("BQ27441 battery fuel gauge", parent),
+BQ27441::BQ27441(InterruptHandler *interruptHandler, int capacity, const QString &i2cDevice, int i2cDeviceId,
+                 QObject *parent)
+    : BatteryFuelGauge("BQ27441 battery fuel gauge", capacity, parent),
       m_i2cDevice(i2cDevice),
       m_i2cDeviceId(i2cDeviceId),
       m_i2cFd(0) {
     Q_ASSERT(interruptHandler);
     Q_ASSERT(!i2cDevice.isEmpty());
-    qCDebug(CLASS_LC()) << name() << i2cDevice << "with id:" << i2cDeviceId;
+    qCDebug(CLASS_LC()) << name() << i2cDevice << "with id:" << i2cDeviceId << ", capacity:" << capacity;
 
     connect(interruptHandler, &InterruptHandler::interruptEvent, this, [&](int event) {
         if (event == InterruptHandler::BATTERY) {
@@ -63,7 +64,7 @@ bool BQ27441::open() {
 
     /* Initialize I2C */
     bool initialized = false;
-    m_i2cFd          = wiringPiI2CSetupInterface(qPrintable(m_i2cDevice), m_i2cDeviceId);
+    m_i2cFd = wiringPiI2CSetupInterface(qPrintable(m_i2cDevice), m_i2cDeviceId);
     if (m_i2cFd == -1) {
         qCCritical(CLASS_LC) << "Unable to open or select I2C device" << m_i2cDeviceId << "on" << m_i2cDevice;
     } else {
@@ -96,23 +97,23 @@ const QLoggingCategory &BQ27441::logCategory() const { return CLASS_LC(); }
 
 void BQ27441::updateBatteryValues() {
     if (getDesignCapacity() != m_capacity) {
-        qCDebug(CLASS_LC) << "Design capacity does not match.";
-
         // calibrate the gauge
-        qCDebug(CLASS_LC) << "Fuel gauge calibration. Setting charge capacity to:" << m_capacity;
+        qCDebug(CLASS_LC) << "Design capacity does not match. Fuel gauge calibration. Setting charge capacity to:"
+                          << m_capacity;
         changeCapacity(m_capacity);
     }
 
     m_level = getStateOfCharge();
     emit levelChanged();
-    qCDebug(CLASS_LC()) << "Battery level:" << m_level;
 
     m_voltage = wiringPiI2CReadReg16(m_i2cFd, BQ27441_COMMAND_VOLTAGE);  // getVoltage();
-    qCDebug(CLASS_LC()) << "Battery voltage:" << m_voltage;
 
     m_health = getStateOfHealth();
+    if (CLASS_LC().isDebugEnabled()) {
+        qCDebug(CLASS_LC()) << "Battery level:" << m_level << "%, battery voltage:" << m_voltage
+                            << "mV, battery health:" << m_health;
+    }
     emit healthChanged();
-    qCDebug(CLASS_LC()) << "Battery health:" << m_health;
 
     m_averagePower = static_cast<int>(
         static_cast<int16_t>(wiringPiI2CReadReg16(m_i2cFd, BQ27441_COMMAND_AVG_POWER)));  // getAveragePower();
@@ -154,12 +155,13 @@ void BQ27441::updateBatteryValues() {
 
     // calculate remaining battery life
     float remainingLife = static_cast<float>(getRemainingCapacity()) / static_cast<float>(abs(getAverageCurrent()));
-    m_remainingLife     = (m_remainingLife + remainingLife) / 2;
+    m_remainingLife = (m_remainingLife + remainingLife) / 2;
     emit remainingLifeChanged();
 
-    qCDebug(CLASS_LC()) << "Average power" << m_averagePower << "mW";
-    qCDebug(CLASS_LC()) << "Average current" << getAverageCurrent() << "mA";
-    qCDebug(CLASS_LC()) << "Remaining battery life" << m_remainingLife << "h";
+    if (CLASS_LC().isDebugEnabled()) {
+        qCDebug(CLASS_LC()) << "Average power" << m_averagePower << "mW, average current" << getAverageCurrent()
+                            << "mA, remaining battery life" << m_remainingLife << "h";
+    }
 }
 
 void BQ27441::begin() {

sources/hardware/linux/arm/bq27441.h

@@ -81,7 +81,7 @@ class BQ27441 : public BatteryFuelGauge {
     Q_OBJECT
 
  public:
-    explicit BQ27441(InterruptHandler *interruptHandler, const QString &i2cDevice,
+    explicit BQ27441(InterruptHandler *interruptHandler, int capacity, const QString &i2cDevice,
                      int i2cDeviceId = BQ27441_I2C_ADDRESS, QObject *parent = nullptr);
     ~BQ27441() override;
 

sources/hardware/linux/arm/hw_factory_yio.cpp

@@ -42,6 +42,7 @@
 #include "mcp23017_interrupt.h"
 
 const QString HardwareFactoryYio::DEF_I2C_DEVICE = "/dev/i2c-3";
+const int HardwareFactoryYio::DEF_BATTERY_CAPACITY = 2500;
 
 static Q_LOGGING_CATEGORY(CLASS_LC, "hw.factory.yio");
 
@@ -187,10 +188,11 @@ BatteryCharger *HardwareFactoryYio::buildBatteryCharger(const QVariantMap &confi
 }
 
 BatteryFuelGauge *HardwareFactoryYio::buildBatteryFuelGauge(const QVariantMap &config) {
+    auto capacity = ConfigUtil::getValue(config, HW_CFG_BATTERY_CAPACITY, DEF_BATTERY_CAPACITY).toInt();
     auto dev = ConfigUtil::getValue(config, HW_CFG_PATH_I2C_DEV, DEF_I2C_DEVICE).toString();
     auto id = ConfigUtil::getValue(config, HW_CFG_PATH_I2C_ID, BQ27441_I2C_ADDRESS).toInt();
 
-    BatteryFuelGauge *device = new BQ27441(getInterruptHandler(), dev, id, this);
+    BatteryFuelGauge *device = new BQ27441(getInterruptHandler(), capacity, dev, id, this);
     connect(device, &Device::error, this, &HardwareFactoryYio::onError);
 
     return device;

sources/hardware/linux/arm/hw_factory_yio.h

@@ -60,4 +60,5 @@ class HardwareFactoryYio : public HardwareFactoryLinux {
 
     // default values for YIO
     static const QString DEF_I2C_DEVICE;
+    static const int     DEF_BATTERY_CAPACITY;
 };

sources/hardware/mock/batteryfuelgauge_mock.h

@@ -28,9 +28,7 @@ class BatteryFuelGaugeMock : public BatteryFuelGauge {
     Q_OBJECT
 
  public:
-    explicit BatteryFuelGaugeMock(QObject* parent = nullptr) : BatteryFuelGauge("BatteryFuelGaugeMock", parent) {
-        setCapacity(2500);
-    }
+    explicit BatteryFuelGaugeMock(QObject* parent = nullptr) : BatteryFuelGauge("BatteryFuelGaugeMock", 2500, parent) {}
 
     ~BatteryFuelGaugeMock() override {}