Merge pull request #200 from thooge/voltage

Improve and speedup undervoltage detection code

lib/obp60task/index.js

@@ -1,10 +1,12 @@
+// Add a new register card in web configuration interface
+// This is a Java Script! 
 (function(){
     const api=window.esp32nmea2k;
     if (! api) return;
-    const tabName="OBP60";
+    const tabName="Screen";
     api.registerListener((id, data) => {
     //    if (!data.testboard) return; //do nothing if we are not active
-        let page = api.addTabPage(tabName, "OBP60");
+        let page = api.addTabPage(tabName, "Screen");
         api.addEl('button', '', page, 'Screenshot').addEventListener('click', function (ev) {
 	window.open('/api/user/OBP60Task/screenshot', 'screenshot');
         })

lib/obp60task/obp60task.cpp

@@ -21,9 +21,6 @@
 #include <SPI.h>
 #endif
 
-// True type character sets includes
-// See OBP60ExtensionPort.cpp
-
 // Pictures
 //#include GxEPD_BitmapExamples         // Example picture
 #include "MFD_OBP60_400x300_sw.h"       // MFD with logo
@@ -189,7 +186,6 @@ class BoatValueList{
 //this way each page can easily be added here
 //needs some minor tricks for the safe static initialization
 typedef std::vector<PageDescription*> Pages;
-//the page list class
 class PageList{
     public:
         Pages pages;
@@ -273,21 +269,8 @@ void registerAllPages(PageList &list){
 }
 
 // Undervoltage detection for shutdown display
-void underVoltageDetection(GwApi *api, CommonData &common){
-    // Read settings
-    double voffset = (api->getConfig()->getConfigItem(api->getConfig()->vOffset,true)->asString()).toFloat();
-    double vslope = (api->getConfig()->getConfigItem(api->getConfig()->vSlope,true)->asString()).toFloat();
-    // Read supply voltage
-    #if defined VOLTAGE_SENSOR && defined LIPO_ACCU_1200
-    float actVoltage = (float(analogRead(OBP_ANALOG0)) * 3.3 / 4096 + 0.53) * 2;   // Vin = 1/2 for OBP40
-    float minVoltage = 3.65;  // Absolut minimum volatge for 3,7V LiPo accu
-    #else
-    float actVoltage = (float(analogRead(OBP_ANALOG0)) * 3.3 / 4096 + 0.17) * 20;   // Vin = 1/20 for OBP60
-    float minVoltage = MIN_VOLTAGE;
-    #endif
-    double calVoltage = actVoltage * vslope + voffset;  // Calibration
-    if(calVoltage < minVoltage){
-        #if defined VOLTAGE_SENSOR && defined LIPO_ACCU_1200
+void underVoltageError(CommonData &common) {
+#if defined VOLTAGE_SENSOR && defined LIPO_ACCU_1200
     // Switch off all power lines
     setPortPin(OBP_BACKLIGHT_LED, false);   // Backlight Off
     setFlashLED(false);                     // Flash LED Off
@@ -307,7 +290,7 @@ void underVoltageDetection(GwApi *api, CommonData &common){
     getdisplay().powerOff();                // Display power off
     setPortPin(OBP_POWER_EPD, false);       // Power off ePaper display
     setPortPin(OBP_POWER_SD, false);        // Power off SD card
-        #else
+#else
     // Switch off all power lines
     setPortPin(OBP_BACKLIGHT_LED, false);   // Backlight Off
     setFlashLED(false);                     // Flash LED Off
@@ -325,14 +308,27 @@ void underVoltageDetection(GwApi *api, CommonData &common){
     getdisplay().print("To wake up repower system");
     getdisplay().nextPage();                // Partial update
     getdisplay().powerOff();                // Display power off
-        #endif
+#endif
     // Stop system
-        while(true){
-            esp_deep_sleep_start();             // Deep Sleep without weakup. Weakup only after power cycle (restart).
-        }
+    while (true) {
+        esp_deep_sleep_start(); // Deep Sleep without wakeup. Wakeup only after power cycle (restart).
     }
 }
 
+inline bool underVoltageDetection(float voffset, float vslope) {
+    // Read supply voltage
+#if defined VOLTAGE_SENSOR && defined LIPO_ACCU_1200
+    float actVoltage = (float(analogRead(OBP_ANALOG0)) * 3.3 / 4096 + 0.53) * 2;   // Vin = 1/2 for OBP40
+    float minVoltage = 3.65;  // Absolut minimum volatge for 3,7V LiPo accu
+#else
+    float actVoltage = (float(analogRead(OBP_ANALOG0)) * 3.3 / 4096 + 0.17) * 20;   // Vin = 1/20 for OBP60
+    float minVoltage = MIN_VOLTAGE;
+#endif
+    // TODO Why double here?
+    float calVoltage = actVoltage * vslope + voffset;  // Calibration
+    return (calVoltage < minVoltage);
+}
+
 // Calculate true wind data and add to obp60task boat data list
 bool addTrueWind(GwApi* api, BoatValueList* boatValues) {
 
@@ -738,7 +734,9 @@ void OBP60Task(GwApi *api){
     commonData.backlight.brightness = 2.55 * uint(config->getConfigItem(config->blBrightness,true)->asInt());
     commonData.powermode = api->getConfig()->getConfigItem(api->getConfig()->powerMode,true)->asString();
 
-    bool uvoltage = api->getConfig()->getConfigItem(api->getConfig()->underVoltage,true)->asBoolean();
+    bool uvoltage = config->getConfigItem(config->underVoltage, true)->asBoolean();
+    float voffset = (config->getConfigItem(config->vOffset,true)->asString()).toFloat();
+    float vslope = (config->getConfigItem(config->vSlope,true)->asString()).toFloat();
     String cpuspeed = api->getConfig()->getConfigItem(api->getConfig()->cpuSpeed,true)->asString();
     uint hdopAccuracy = uint(api->getConfig()->getConfigItem(api->getConfig()->hdopAccuracy,true)->asInt());
 
@@ -787,8 +785,10 @@ void OBP60Task(GwApi *api){
         bool keypressed = false;
 
         // Undervoltage detection
-        if(uvoltage == true){
-            underVoltageDetection(api, commonData);
+        if (uvoltage == true) {
+            if (underVoltageDetection(voffset, vslope)) {
+                underVoltageError(commonData);
+            }
         }
 
         // Set CPU speed after boot after 1min 

lib/obp60task/obp60task.h

@@ -41,5 +41,10 @@
     #ifdef BOARD_OBP40S3
     DECLARE_CAPABILITY(obp40,true)
     #endif
-    DECLARE_STRING_CAPABILITY(HELP_URL, "https://obp60-v2-docu.readthedocs.io/de/latest/"); // Link to help pages
+    #ifdef BOARD_OBP60S3
+    DECLARE_STRING_CAPABILITY(HELP_URL, "https://obp60-v2-docu.readthedocs.io/en/latest/"); // Link to help pages
+    #endif
+    #ifdef BOARD_OBP40S3
+    DECLARE_STRING_CAPABILITY(HELP_URL, "https://obp40-v1-docu.readthedocs.io/en/latest/"); // Link to help pages
+    #endif
 #endif