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
@@ -159,7 +156,7 @@ class BoatValueList{
     //additionally we put the necessary values into the paga data - see below
     GwApi::BoatValue *allBoatValues[MAXVALUES];
     int numValues=0;
-    
+
     bool addValueToList(GwApi::BoatValue *v){
         for (int i=0;i<numValues;i++){
             if (allBoatValues[i] == v){
@@ -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,64 +269,64 @@ void registerAllPages(PageList &list){
 }
 
 // Undervoltage detection for shutdown display
-void underVoltageDetection(GwApi *api, CommonData &common){
+void underVoltageError(CommonData &common) {
-    // Read settings
+#if defined VOLTAGE_SENSOR && defined LIPO_ACCU_1200
-    double voffset = (api->getConfig()->getConfigItem(api->getConfig()->vOffset,true)->asString()).toFloat();
+    // Switch off all power lines
-    double vslope = (api->getConfig()->getConfigItem(api->getConfig()->vSlope,true)->asString()).toFloat();
+    setPortPin(OBP_BACKLIGHT_LED, false);   // Backlight Off
+    setFlashLED(false);                     // Flash LED Off
+    buzzer(TONE4, 20);                      // Buzzer tone 4kHz 20ms
+    // Shutdown EInk display
+    getdisplay().setFullWindow();           // Set full Refresh
+    //getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update
+    getdisplay().fillScreen(common.bgcolor);// Clear screen
+    getdisplay().setTextColor(common.fgcolor);
+    getdisplay().setFont(&Ubuntu_Bold20pt8b);
+    getdisplay().setCursor(65, 150);
+    getdisplay().print("Undervoltage");
+    getdisplay().setFont(&Ubuntu_Bold8pt8b);
+    getdisplay().setCursor(65, 175);
+    getdisplay().print("Charge battery and restart system");
+    getdisplay().nextPage();                // Partial update
+    getdisplay().powerOff();                // Display power off
+    setPortPin(OBP_POWER_EPD, false);       // Power off ePaper display
+    setPortPin(OBP_POWER_SD, false);        // Power off SD card
+#else
+    // Switch off all power lines
+    setPortPin(OBP_BACKLIGHT_LED, false);   // Backlight Off
+    setFlashLED(false);                     // Flash LED Off
+    buzzer(TONE4, 20);                      // Buzzer tone 4kHz 20ms
+    setPortPin(OBP_POWER_50, false);        // Power rail 5.0V Off
+    // Shutdown EInk display
+    getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update
+    getdisplay().fillScreen(common.bgcolor);// Clear screen
+    getdisplay().setTextColor(common.fgcolor);
+    getdisplay().setFont(&Ubuntu_Bold20pt8b);
+    getdisplay().setCursor(65, 150);
+    getdisplay().print("Undervoltage");
+    getdisplay().setFont(&Ubuntu_Bold8pt8b);
+    getdisplay().setCursor(65, 175);
+    getdisplay().print("To wake up repower system");
+    getdisplay().nextPage();                // Partial update
+    getdisplay().powerOff();                // Display power off
+#endif
+    // Stop system
+    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
+#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
+#else
     float actVoltage = (float(analogRead(OBP_ANALOG0)) * 3.3 / 4096 + 0.17) * 20;   // Vin = 1/20 for OBP60
     float minVoltage = MIN_VOLTAGE;
-    #endif
+#endif
-    double calVoltage = actVoltage * vslope + voffset;  // Calibration
+    // TODO Why double here?
-    if(calVoltage < minVoltage){
+    float calVoltage = actVoltage * vslope + voffset;  // Calibration
-        #if defined VOLTAGE_SENSOR && defined LIPO_ACCU_1200
+    return (calVoltage < minVoltage);
-        // Switch off all power lines
-        setPortPin(OBP_BACKLIGHT_LED, false);   // Backlight Off
-        setFlashLED(false);                     // Flash LED Off            
-        buzzer(TONE4, 20);                      // Buzzer tone 4kHz 20ms
-        // Shutdown EInk display
-        getdisplay().setFullWindow();           // Set full Refresh
-        //getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update
-        getdisplay().fillScreen(common.bgcolor);// Clear screen
-        getdisplay().setTextColor(common.fgcolor);
-        getdisplay().setFont(&Ubuntu_Bold20pt8b);
-        getdisplay().setCursor(65, 150);
-        getdisplay().print("Undervoltage");
-        getdisplay().setFont(&Ubuntu_Bold8pt8b);
-        getdisplay().setCursor(65, 175);
-        getdisplay().print("Charge battery and restart system");
-        getdisplay().nextPage();                // Partial update
-        getdisplay().powerOff();                // Display power off
-        setPortPin(OBP_POWER_EPD, false);       // Power off ePaper display
-        setPortPin(OBP_POWER_SD, false);        // Power off SD card
-        #else
-        // Switch off all power lines
-        setPortPin(OBP_BACKLIGHT_LED, false);   // Backlight Off
-        setFlashLED(false);                     // Flash LED Off            
-        buzzer(TONE4, 20);                      // Buzzer tone 4kHz 20ms
-        setPortPin(OBP_POWER_50, false);        // Power rail 5.0V Off
-        // Shutdown EInk display
-        getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update
-        getdisplay().fillScreen(common.bgcolor);// Clear screen
-        getdisplay().setTextColor(common.fgcolor);
-        getdisplay().setFont(&Ubuntu_Bold20pt8b);
-        getdisplay().setCursor(65, 150);
-        getdisplay().print("Undervoltage");
-        getdisplay().setFont(&Ubuntu_Bold8pt8b);
-        getdisplay().setCursor(65, 175);
-        getdisplay().print("To wake up repower system");
-        getdisplay().nextPage();                // Partial update
-        getdisplay().powerOff();                // Display power off
-        #endif
-        // Stop system
-        while(true){
-            esp_deep_sleep_start();             // Deep Sleep without weakup. Weakup only after power cycle (restart).
-        }
-    }
 }
 
 // Calculate true wind data and add to obp60task boat data list
@@ -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){
+        if (uvoltage == true) {
-            underVoltageDetection(api, commonData);
+            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