Add battery voltage monitoring feature

Author: mdkendall

tinyGS/src/ConfigManager/ConfigManager.cpp

@@ -126,10 +126,13 @@ typedef struct
   uint8_t L_MISO;
   uint8_t L_MOSI;
   uint8_t L_SCK;
-  float L_TCXO_V;
+  float   L_TCXO_V;
   uint8_t RX_EN;
   uint8_t TX_EN;
-  String BOARD;
+  uint8_t ADC_CTL;     // GPIO pin to enable ADC reading
+  uint8_t VBAT_AIN;    // GPIO pin for VBAT monitoring
+  float   VBAT_SCALE;  // potential divider between battery and GPIO pin
+  String  BOARD;
 } board_t;
 
 const uint8_t UNUSED = -1;

tinyGS/src/ConfigManager/ConfigManager.h

@@ -71,7 +71,7 @@ const char BOARD_VALUES[][BOARD_LENGTH] PROGMEM = {"0", "1"  };
 const char BOARD_VALUES[][BOARD_LENGTH] PROGMEM = {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" , "21", "22"};
 #endif
 
-const char IOTWEBCONF_DASHBOARD_STYLE_INNER[] PROGMEM = "table{margin:20px auto;}h3{text-align:center;}.card{height:12em;margin:10px;text-align:left;font-family:Arial;border:3px groove;border-radius:0.3rem;display:inline-block;padding:10px;min-width:260px;}td{padding:0 10px;}textarea{resize:vertical;width:100%;margin:0;height:318px;padding:5px;overflow:auto;}#c1{width:98%;padding:5px;}#t1{width:98%}.console{display:inline-block;text-align:center;margin:10px 0;width:98%;max-width:1080px;}.G{color:green;}.R{color:red}";
+const char IOTWEBCONF_DASHBOARD_STYLE_INNER[] PROGMEM = "table{margin:20px auto;}h3{text-align:center;}.card{height:13em;margin:10px;text-align:left;font-family:Arial;border:3px groove;border-radius:0.3rem;display:inline-block;padding:10px;min-width:260px;}td{padding:0 10px;}textarea{resize:vertical;width:100%;margin:0;height:318px;padding:5px;overflow:auto;}#c1{width:98%;padding:5px;}#t1{width:98%}.console{display:inline-block;text-align:center;margin:10px 0;width:98%;max-width:1080px;}.G{color:green;}.R{color:red}";
 const char IOTWEBCONF_DASHBOARD_BODY_INNER[] PROGMEM   = "<div style='text-align:center;min-width:260px;'>\n";
 const char IOTWEBCONF_CONSOLE_BODY_INNER[] PROGMEM  = "<br /><div class='console'><textarea readonly='' id='t1' wrap='off' name='t1'></textarea><form method='get' onsubmit='return f(1);'><input id='c1' placeholder='Enter command' autofocus='' name='c1'><br></form></div>\n";
 const char IOTWEBCONF_CONSOLE_SCRIPT[] PROGMEM  = "var x=null,lt,to,tp,pc='';var sn=0,id=0;function f(p){var c,o='',t;clearTimeout(lt);t = document.getElementById('t1');if (p==1) {c =document.getElementById('c1');o='&c1='+encodeURIComponent(c.value);c.value='';t.scrollTop=99999;sn=t.scrollTop;}if (t.scrollTop >= sn){if (x!=null){x.abort();}x=new XMLHttpRequest();x.onreadystatechange=function() {if(x.readyState==4&&x.status==200){var z,d;var a=x.responseText;console.log(a);id=a.substr(0,a.indexOf('\\n'));z=a.substr(a.indexOf('\\n')+1);if(z.length>0){t.value+=z;}t.scrollTop=99999;sn=t.scrollTop;}};x.open('GET','cs?c2='+id+o,true);x.send();}lt=setTimeout(f,2345);return false;}window.addEventListener('load', f);";
@@ -82,5 +82,5 @@ const char ADVANCED_CONFIG_SCRIPT[] PROGMEM =
     "function tableDoneHandler(btn){var tbd=document.getElementById('current-table'); var ds=tableDictString(tbd); current_ctrl.value=ds; document.getElementById('dt-' + current_id).remove(); current_ctrl=null; current_id=null; }" 
     "function editElementDict(ed){if (current_ctrl===null){var ph=ed.getAttribute('placeholder'); var dstring = ed.value!='' ? ed.value : ph; if(dstring !== ''){ current_id=ed.id; var dict = JSON.parse(dstring); var tblhtml = '<div id=""dt-' + current_id + '"">' + dictTable(dict) + '<input type=""button"" value=""Done ' + current_id + '"" onclick=""tableDoneHandler()"" style=""height:35px;width:100px;background-color:lightblue;""></div>'; ed.insertAdjacentHTML('afterend', tblhtml); current_ctrl=ed; } } }"
     "var current_id, current_ctrl=null; window.addEventListener('load', function() {setup_click('board_template'); setup_click('modem_startup');});";
-const char IOTWEBCONF_WORLDMAP_SCRIPT[] PROGMEM  ="var wmx=null,wmt;function wmf(p){var sp,mc,gs,lp;clearTimeout(wmt);wmx=new XMLHttpRequest();wmx.onreadystatechange=function() {if(wmx.readyState==4&&x.status==200){var wma=wmx.responseText;var wmp = wma.split(',');sp=document.getElementById('wmsatpos');sp.setAttribute('cx', wmp[0]);sp.setAttribute('cy', wmp[1]);mc=document.getElementById('modemconfig');for(let r=0;r<6;r++){mc.rows[r].cells[1].innerHTML=wmp[r+2]};if(wmp[2]=='LoRa'){mc.rows[3].cells[0].innerHTML='Spreading Factor ';mc.rows[4].cells[0].innerHTML='Coding Rate ';}else{mc.rows[3].cells[0].innerHTML='Bitrate ';mc.rows[4].cells[0].innerHTML='Frequency dev ';};gs=document.getElementById('gsstatus');for(let r=0;r<6;r++){gs.rows[r].cells[1].innerHTML=wmp[r+8];};sd=document.getElementById('satdata');for(let r=0;r<6;r++){sd.rows[r].cells[1].innerHTML=wmp[r+14];};lp=document.getElementById('lastpacket');for(let r=0;r<4;r++){lp.rows[r].cells[1].innerHTML=wmp[r+20];};lp.rows[4].cells[0].innerHTML=wmp[24];}};wmx.open('GET','wm',true);wmx.send();wmt=setTimeout(wmf,5000);return false;}window.addEventListener('load', wmf);";
-const char IOTWEBCONF_CONFIG_STYLE_INNER[] PROGMEM = " fieldset[id='Board config'] div:nth-of-type(3) ~ div { display:none}";
+const char IOTWEBCONF_WORLDMAP_SCRIPT[] PROGMEM  ="var wmx=null,wmt;function wmf(p){var sp,mc,gs,lp;clearTimeout(wmt);wmx=new XMLHttpRequest();wmx.onreadystatechange=function() {if(wmx.readyState==4&&x.status==200){var wma=wmx.responseText;var wmp = wma.split(',');sp=document.getElementById('wmsatpos');sp.setAttribute('cx', wmp[0]);sp.setAttribute('cy', wmp[1]);mc=document.getElementById('modemconfig');for(let r=0;r<6;r++){mc.rows[r].cells[1].innerHTML=wmp[r+2]};if(wmp[2]=='LoRa'){mc.rows[3].cells[0].innerHTML='Spreading Factor ';mc.rows[4].cells[0].innerHTML='Coding Rate ';}else{mc.rows[3].cells[0].innerHTML='Bitrate ';mc.rows[4].cells[0].innerHTML='Frequency dev ';};gs=document.getElementById('gsstatus');for(let r=0;r<7;r++){gs.rows[r].cells[1].innerHTML=wmp[r+8];};sd=document.getElementById('satdata');for(let r=0;r<6;r++){sd.rows[r].cells[1].innerHTML=wmp[r+15];};lp=document.getElementById('lastpacket');for(let r=0;r<4;r++){lp.rows[r].cells[1].innerHTML=wmp[r+21];};lp.rows[4].cells[0].innerHTML=wmp[25];}};wmx.open('GET','wm',true);wmx.send();wmt=setTimeout(wmf,5000);return false;}window.addEventListener('load', wmf);";
+const char IOTWEBCONF_CONFIG_STYLE_INNER[] PROGMEM = " fieldset[id='Board config'] div:nth-of-type(3) ~ div { display:none}";

tinyGS/src/ConfigManager/html.h

@@ -235,6 +235,11 @@ void drawFrame3(OLEDDisplay *display, OLEDDisplayUiState* state, int16_t x, int1
     display->drawString(128 + x,  23 + y, String(status.modeminfo.freqDev)+ "/" + String(status.modeminfo.bw)+ "kHz");
     display->drawString(128 + x,  34 + y, String(status.modeminfo.bitrate)+ "kbps");
   }
+  if (status.vbat != 0.0)
+  {
+      display->setTextAlignment(TEXT_ALIGN_LEFT);
+      display->drawString(x, 45 + y, "Bat: " + String(status.vbat) + "V");
+  }
 }
 
 void drawFrame4(OLEDDisplay *display, OLEDDisplayUiState* state, int16_t x, int16_t y)

tinyGS/src/Display/Display.cpp

@@ -98,7 +98,7 @@ void MQTT_Client::loop()
     else
     {
       StaticJsonDocument<128> doc;
-      doc["Vbat"] = voltage();
+      doc["Vbat"] = status.vbat;
       doc["Mem"] = ESP.getFreeHeap();
       doc["RSSI"] =WiFi.RSSI();
       doc["radio"]= status.radio_error;
@@ -208,7 +208,7 @@ void MQTT_Client::sendWelcome()
   doc["board"] = configManager.getBoard();
   doc["mac"] = clientId;
   doc["seconds"] = millis()/1000;
-  doc["Vbat"] = voltage();
+  doc["Vbat"] = status.vbat;
   doc["chip"] = ESP.getChipModel();
   doc["slot"] = esp_ota_get_running_partition ()->label;
   doc["pSize"] = esp_ota_get_running_partition ()->size;
@@ -944,37 +944,3 @@ void MQTT_Client::begin()
   setServer(configManager.getMqttServer(), configManager.getMqttPort());
   setCallback(manageMQTTDataCallback);
 }
-
-
-
-int MQTT_Client::voltage() {
-  int medianVoltage;
-  int length = 21;
-  int voltages[22];
-  
-  for (int i = 0; i < 22; i++)
-  {
-    voltages[i] = analogRead(36); 
-    }
-  
-  //    BubbleSortAsc   from https://www.luisllamas.es/arduino-bubble-sort/
-   int i, j, flag = 1;
-   int temp;
-   for (i = 1; (i <= length) && flag; i++)
-   {
-      flag = 0;
-      for (j = 0; j < (length - 1); j++)
-      {
-         if (voltages[j + 1] < voltages[j])
-         {
-            temp = voltages[j];
-            voltages[j] = voltages[j + 1];
-            voltages[j + 1] = temp;
-            flag = 1;
-         }
-      }
-   }
-  medianVoltage = voltages[10];
-  return medianVoltage;
-}
-

tinyGS/src/Mqtt/MQTT_Client.cpp

@@ -0,0 +1,43 @@
+#include "Battery.h"
+#include "../ConfigManager/ConfigManager.h"
+#include "../Logger/Logger.h"
+
+void initBatteryMonitoring(void)
+{
+    board_t board;
+    if (ConfigManager::getInstance().getBoardConfig(board)) {
+        Log::console (PSTR ("Setting up battery monitoring pin"));
+        if (board.ADC_CTL != UNUSED)
+            pinMode(board.ADC_CTL, OUTPUT); // Enable pin for ADC reading
+        if (board.VBAT_AIN != UNUSED) {
+            pinMode(board.VBAT_AIN, INPUT); // VBAT monitoring pin
+            adcAttachPin(board.VBAT_AIN);
+            analogReadResolution(12);
+            analogSetAttenuation(ADC_11db);
+        }
+    }
+}
+
+void checkBattery(void)
+{
+  static unsigned long lastReadTime = 0;
+  board_t board;
+
+  // Throttle the battery check interval
+  if (millis() - lastReadTime > BATTERY_CHECK_INTERVAL) {
+    lastReadTime = millis();
+    if (ConfigManager::getInstance().getBoardConfig(board)) {
+      if (board.VBAT_AIN != UNUSED && board.VBAT_SCALE != UNUSED) {
+        digitalWrite(board.ADC_CTL, HIGH); // Enable ADC reading
+        delay(100); // Allow voltage to stabilize
+        uint16_t temp = analogRead(board.VBAT_AIN);
+        digitalWrite(board.ADC_CTL, LOW); // Disable ADC reading to save power
+        if (status.vbat == 0.0) {
+            status.vbat = board.VBAT_SCALE * temp;
+        } else {
+            status.vbat = (status.vbat + (board.VBAT_SCALE * temp))/2;
+        }      
+      }
+    }
+  }
+}

tinyGS/src/Power/Battery.cpp

@@ -0,0 +1,15 @@
+#ifndef BATTERY_H
+#define BATTERY_H
+#include "Arduino.h"
+#include <Wire.h>
+#include "../Status.h"
+#include "../ConfigManager/ConfigManager.h"
+
+#define BATTERY_CHECK_INTERVAL 10000
+
+extern Status status;
+
+void initBatteryMonitoring(void);
+void checkBattery(void);
+
+#endif

tinyGS/src/Power/Battery.h

@@ -100,6 +100,7 @@ struct Status {
   bool mqtt_connected = false;
   bool radio_ready = false;
   int16_t radio_error = 0;
+  float vbat = 0.0;
   PacketInfo lastPacketInfo;
   ModemInfo modeminfo;
   ModemInfo modeminfolastpckt;

tinyGS/src/Status.h

@@ -80,6 +80,7 @@
 #include "time.h"
 #include "src/Mqtt/MQTT_credentials.h"
 #include "src/Improv/tinygs_improv.h"
+#include "src/Power/Battery.h"
 
 
 #if  RADIOLIB_VERSION_MAJOR != (0x07) || RADIOLIB_VERSION_MINOR != (0x04) || RADIOLIB_VERSION_PATCH != (0x00) || RADIOLIB_VERSION_EXTRA != (0x00)
@@ -162,8 +163,10 @@ void setup()
   // make sure to call doLoop at least once before starting to use the configManager
   configManager.doLoop();
   board_t board;
-  if(configManager.getBoardConfig(board))
+  if(configManager.getBoardConfig(board)) {
     pinMode (board.PROG__BUTTON, INPUT_PULLUP);
+    initBatteryMonitoring();
+  }
   displayInit();
   displayShowInitialCredits();
   configManager.delay(1000);
@@ -317,6 +320,8 @@ void loop() {
     return;
   }
 
+  checkBattery();
+
   // connected
 
   mqtt.loop();