nicla-system: Replace defines with enum for battery level.

Author: sebromero

libraries/Nicla_System/examples/NiclaSenseME_BatteryStatus/NiclaSenseME_BatteryStatus.ino

@@ -33,7 +33,7 @@ bool updateBatteryLevel(bool enforceNewReading = false) {
     if (batteryPercentage != percentage) {
       batteryPercentage = percentage;
       batteryVoltage = nicla::getCurrentBatteryVoltage();
-      batteryChargeLevel = nicla::getBatteryChargeLevel();
+      batteryChargeLevel = static_cast<int8_t>(nicla::getBatteryChargeLevel());
 
       Serial.print("New battery level: ");
       Serial.println(batteryPercentage);
@@ -60,17 +60,17 @@ String getBatteryTemperatureDescription(int status) {
   }
 }
 
-String getBatteryChargeLevelDescription(int status) {
+String getBatteryChargeLevelDescription(BatteryChargeLevel status) {
   switch (status) {
-    case BATTERY_EMPTY:
+    case BatteryChargeLevel::Empty:
       return "Empty";
-    case BATTERY_ALMOST_EMPTY:
+    case BatteryChargeLevel::AlmostEmpty:
       return "Almost Empty";
-    case BATTERY_HALF:
+    case BatteryChargeLevel::HalfFull:
       return "Half Full";
-    case BATTERY_ALMOST_FULL:
+    case BatteryChargeLevel::AlmostFull:
       return "Almost Full";
-    case BATTERY_FULL:
+    case BatteryChargeLevel::Full:
       return "Full";
     default:
       return "Unknown";

libraries/Nicla_System/src/Nicla_System.cpp

@@ -264,23 +264,23 @@ int8_t nicla::getBatteryPercentage(bool useLatchedValue) {
  return percentageTens + percentageOnes;
 }
 
-uint8_t nicla::getBatteryChargeLevel() {
+BatteryChargeLevel nicla::getBatteryChargeLevel() {
   auto percent = getBatteryPercentage();
 
   if (percent >= 98) {
-    return BATTERY_FULL;
+    return BatteryChargeLevel::Full;
   } else if (percent >= 94){
-    return BATTERY_ALMOST_FULL;
+    return BatteryChargeLevel::AlmostFull;
   } else if (percent >= 90){
-    return BATTERY_HALF;
+    return BatteryChargeLevel::HalfFull;
   } else if (percent >= 86){
-    return BATTERY_ALMOST_EMPTY;
+    return BatteryChargeLevel::AlmostEmpty;
   } else if(percent < 86 && percent > 0)  {
     // < 84% is considered empty
-    return BATTERY_EMPTY;
+    return BatteryChargeLevel::Empty;
   } else {
     // Battery status could not be read
-    return BATTERY_UNKNOWN;
+    return BatteryChargeLevel::Unknown;
   }
 }
 

libraries/Nicla_System/src/Nicla_System.h

@@ -18,14 +18,6 @@ enum class OperatingStatus {
 };
 
 // 3 bits are used to indicate the battery charge level
-#define BATTERY_CHARGE_MASK     0b00000111
-#define BATTERY_FULL            5 // Bit pattern: 101
-#define BATTERY_ALMOST_FULL     4 // Bit pattern: 100
-#define BATTERY_HALF            3 // Bit pattern: 011
-#define BATTERY_ALMOST_EMPTY    2 // Bit pattern: 010
-#define BATTERY_EMPTY           1 // Bit pattern: 001
-#define BATTERY_UNKNOWN         0 // Bit pattern: 000
-
 enum class BatteryChargeLevel {
   Unknown = 0b000,
   Empty = 0b001,
@@ -104,10 +96,11 @@ class nicla {
    * @brief Get the Battery Charge level encoded as a number (0-5). The following values are possible:
    * "Unknown", "Empty", "Almost Empty", "Half Full", "Almost Full", "Full"
    * 
-   * @return uint8_t The battery charge level represented by one of the following constants:
-   * BATTERY_UNKNOWN, BATTERY_FULL, BATTERY_ALMOST_FULL, BATTERY_HALF, BATTERY_ALMOST_EMPTY, BATTERY_EMPTY
+   * @return BatteryChargeLevel The battery charge level represented by one of the following values:
+   * BatteryChargeLevel::Unknown, BatteryChargeLevel::Empty, BatteryChargeLevel::AlmostEmpty, 
+   * BatteryChargeLevel::HalfFull, BatteryChargeLevel::AlmostFull, BatteryChargeLevel::Full
    */
-  static uint8_t getBatteryChargeLevel();
+  static BatteryChargeLevel getBatteryChargeLevel();
 
   /**
    * @brief Get the Battery Temperature. The following values are possible: