Page system rework and improvements

lib/obp60task/PageSystem.cpp

@@ -38,6 +38,7 @@ private:
     String buzzer_mode;
     uint8_t buzzer_power;
     String cpuspeed;
+    String powermode;
     String rtc_module;
     String gps_module;
     String env_module;
@@ -50,7 +51,7 @@ private:
     double homelat;
     double homelon;
 
-    char mode = 'N'; // (N)ormal, (S)ettings, (D)evice list, (C)ard
+    char mode = 'N'; // (N)ormal, (S)ettings, (C)onfiguration, (D)evice list, c(A)rd
 
 #ifdef PATCH_N2K
     struct device {
@@ -63,175 +64,46 @@ private:
     std::vector<device> devicelist;
 #endif
 
-public:
+    void incMode() {
-    PageSystem(CommonData &common){
+        if (mode == 'N') {        // Normal
-        commonData = &common;
-        common.logger->logDebug(GwLog::LOG,"Instantiate PageSystem");
-        if (hasFRAM) {
-            mode = fram.read(FRAM_SYSTEM_MODE);
-            common.logger->logDebug(GwLog::DEBUG, "Loaded mode '%c' from FRAM", mode);
-        }
-        chipid = ESP.getEfuseMac();
-        simulation = common.config->getBool(common.config->useSimuData);
-#ifdef BOARD_OBP40S3
-        use_sdcard = common.config->getBool(common.config->useSDCard);
-#endif
-        buzzer_mode = common.config->getString(common.config->buzzerMode);
-        buzzer_mode.toLowerCase();
-        buzzer_power = common.config->getInt(common.config->buzzerPower);
-        cpuspeed = common.config->getString(common.config->cpuSpeed);
-        env_module = common.config->getString(common.config->useEnvSensor);
-        rtc_module = common.config->getString(common.config->useRTC);
-        gps_module = common.config->getString(common.config->useGPS);
-        batt_sensor = common.config->getString(common.config->usePowSensor1);
-        solar_sensor = common.config->getString(common.config->usePowSensor2);
-        gen_sensor = common.config->getString(common.config->usePowSensor3);
-        rot_sensor = common.config->getString(common.config->useRotSensor);
-        homelat = common.config->getString(common.config->homeLAT).toDouble();
-        homelon = common.config->getString(common.config->homeLON).toDouble();
-        flashLED = common.config->getString(common.config->flashLED);
-    }
-
-    void setupKeys() {
-        commonData->keydata[0].label = "EXIT";
-        commonData->keydata[1].label = "MODE";
-        commonData->keydata[2].label = "";
-        commonData->keydata[3].label = "RST";
-        commonData->keydata[4].label = "STBY";
-        commonData->keydata[5].label = "ILUM";
-    }
-
-    int handleKey(int key) {
-        // do *NOT* handle key #1 this handled by obp60task as exit
-        // Switch display mode
-        commonData->logger->logDebug(GwLog::LOG, "System keyboard handler");
-        if (key == 2) {
-            if (mode == 'N') {
             mode = 'S';
-            } else if (mode == 'S') {
+        } else if (mode == 'S') { // Settings
+            mode = 'C';
+        } else if (mode == 'C') { // Config
             mode = 'D';
-            } else if (mode == 'D') {
+        } else if (mode == 'D') { // Device list
-                if (hasSDCard) {
+            if (use_sdcard) {
+                mode = 'A';       // SD-Card
+            } else {
+                mode = 'N';
+            }
+        } else {
+            mode = 'N';
+        }
+    }
+
+    void decMode() {
+        if (mode == 'N') {
+            if (use_sdcard) {
+                mode = 'A';       // SD-Card
+            } else {
+                mode = 'D';       // Device list
+            }
+        } else if (mode == 'S') { // Settings
+            mode = 'N';
+        } else if (mode == 'C') { // Config
+            mode = 'S';
+        } else if (mode == 'D') { // Device list
             mode = 'C';
         } else {
-                    mode = 'N';
+            mode = 'D';
-                }
-            } else {
-                mode = 'N';
-            }
-            if (hasFRAM) fram.write(FRAM_SYSTEM_MODE, mode);
-            return 0;
-        }
-#ifdef BOARD_OBP60S3
-        // grab cursor key to disable page navigation
-        if (key == 3) {
-            return 0;
-        }
-        // soft reset
-        if (key == 4) {
-            ESP.restart();
-        }
-        // standby / deep sleep
-        if (key == 5) {
-            commonData->logger->logDebug(GwLog::LOG, "System going into deep sleep mode...");
-            deepSleep(*commonData);
-        }
-        // Code for keylock
-        if (key == 11) {
-            commonData->keylock = !commonData->keylock;
-            return 0;
-        }
-#endif
-#ifdef BOARD_OBP40S3
-        // grab cursor keys to disable page navigation
-        if (key == 9 or key == 10) {
-            return 0;
-        }
-        // standby / deep sleep
-        if (key == 12) {
-            commonData->logger->logDebug(GwLog::LOG, "System going into deep sleep mode...");
-            deepSleep(*commonData);
-        }
-#endif
-        return key;
-    }
-
-    void displayBarcode(String serialno, uint16_t x, uint16_t y, uint16_t s) {
-        // Barcode with serial number
-        // x, y is top left corner
-        // s is pixel size of a single box
-        QRCode qrcode;
-        uint8_t qrcodeData[qrcode_getBufferSize(4)];
-#ifdef BOARD_OBP40S3
-        String prefix = "OBP40:SN:";
-#endif
-#ifdef BOARD_OBP60S3
-        String prefix = "OBP60:SN:";
-#endif
-        qrcode_initText(&qrcode, qrcodeData, 4, 0, (prefix + serialno).c_str());
-        int16_t x0 = x;
-        for (uint8_t j = 0; j < qrcode.size; j++) {
-            for (uint8_t i = 0; i < qrcode.size; i++) {
-                if (qrcode_getModule(&qrcode, i, j)) {
-                    getdisplay().fillRect(x, y, s, s, commonData->fgcolor);
-                }
-                x += s;
-            }
-            y += s;
-            x = x0;
         }
     }
 
-    void displayNew(PageData &pageData) {
+    void displayModeNormal() {
-#ifdef BOARD_OBP60S3
+        // Default system page view
-        // Clear optical warning
-        if (flashLED == "Limit Violation") {
-            setBlinkingLED(false);
-            setFlashLED(false);
-        }
-#endif
 
-#ifdef PATCH_N2K
+        uint16_t y0 = 155;
-        // load current device list
-        tN2kDeviceList *pDevList = pageData.api->getN2kDeviceList();
-        // TODO check if changed
-        if (pDevList->ReadResetIsListUpdated()) {
-            // only reload if changed
-            devicelist.clear();
-            for (uint8_t i = 0; i <= 252; i++) {
-                const tNMEA2000::tDevice *d = pDevList->FindDeviceBySource(i);
-                if (d == nullptr) {
-                    continue;
-                }
-                device dev;
-                dev.id = i;
-                dev.NAME = d->GetName();
-                snprintf(dev.hex_name, sizeof(dev.hex_name), "%08X%08X", (uint32_t)(dev.NAME >> 32), (uint32_t)(dev.NAME & 0xFFFFFFFF));
-                dev.manuf_code = d->GetManufacturerCode();
-                dev.model = d->GetModelID();
-                devicelist.push_back(dev);
-            }
-        }
-#endif
-    };
-
-    int displayPage(PageData &pageData){
-        GwConfigHandler *config = commonData->config;
-        GwLog *logger = commonData->logger;
-
-        // Logging boat values
-        logger->logDebug(GwLog::LOG, "Drawing at PageSystem, Mode=%c", mode);
-
-        // Draw page
-        //***********************************************************
-
-        uint16_t x0 = 8;  // left column
-        uint16_t y0 = 48; // data table starts here
-
-        // Set display in partial refresh mode
-        getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update
-
-        if (mode == 'N') {
 
         getdisplay().setFont(&Ubuntu_Bold12pt8b);
         getdisplay().setCursor(8, 48);
@@ -240,7 +112,6 @@ public:
         getdisplay().drawXBitmap(320, 25, logo64_bits, logo64_width, logo64_height, commonData->fgcolor);
 
         getdisplay().setFont(&Ubuntu_Bold8pt8b);
-            y0 = 155;
 
         char ssid[13];
         snprintf(ssid, 13, "%04X%08X", (uint16_t)(chipid >> 32), (uint32_t)chipid);
@@ -353,16 +224,45 @@ public:
         getdisplay().setCursor(300, y0 + 32);
         getdisplay().print(String(RAM_free));
 
-        } else if (mode == 'S') {
+    }
-            // Settings
+
+    void displayModeConfig() {
+        // Configuration interface
+
+        uint16_t x0 = 16;
+        uint16_t y0 = 80;
+        uint16_t dy = 20;
+
+        getdisplay().setFont(&Ubuntu_Bold12pt8b);
+        getdisplay().setCursor(8, 48);
+        getdisplay().print("System configuration");
+
+		getdisplay().setFont(&Ubuntu_Bold8pt8b);
+
+        getdisplay().setCursor(x0, y0);
+        getdisplay().print("CPU speed: 80 | 160 | 240");
+        getdisplay().setCursor(x0, y0 + 1 * dy);
+        getdisplay().print("Power mode: Max | 5V | Min");
+        getdisplay().setCursor(x0, y0 + 2 * dy);
+        getdisplay().print("Accesspoint: On | Off");
+
+        // TODO Change NVRAM-preferences settings here
+        getdisplay().setCursor(x0, y0 + 4 * dy);
+        getdisplay().print("Simulation: On | Off");
+
+    }
+
+    void displayModeSettings() {
+        // View some of the current settings
+
+        const uint16_t x0 = 8;
+        const uint16_t y0 = 72;
 
         getdisplay().setFont(&Ubuntu_Bold12pt8b);
         getdisplay().setCursor(x0, 48);
         getdisplay().print("System settings");
 
         getdisplay().setFont(&Ubuntu_Bold8pt8b);
-            x0 = 8;
-            y0 = 72;
 
         // left column
         getdisplay().setCursor(x0, y0);
@@ -405,6 +305,12 @@ public:
         getdisplay().setCursor(120, y0 + 144);
         getdisplay().print(formatLongitude(homelon));
 
+        // Power
+        getdisplay().setCursor(x0, y0 + 176);
+        getdisplay().print("Power mode:");
+        getdisplay().setCursor(120, y0 + 176);
+        getdisplay().print(powermode);
+
         // right column
         getdisplay().setCursor(202, y0);
         getdisplay().print("Batt. sensor:");
@@ -423,18 +329,46 @@ public:
         getdisplay().setCursor(320, y0 + 32);
         getdisplay().print(gen_sensor);
 
-            // Gyro sensor
+        // TODO
+        // Gyro sensor (rotation)
+        getdisplay().setCursor(202, y0 + 48);
+        getdisplay().print("Rot. sensor:");
+        getdisplay().setCursor(320, y0 + 48);
+        getdisplay().print(rot_sensor);
+
+        // Temp.-sensor
+        // Power Mode
+
+#ifdef BOARD_OBP60S3
+        // Backlight infos
+        getdisplay().setCursor(202, y0 + 64);
+        getdisplay().print("Backlight:");
+        getdisplay().setCursor(320, y0 + 64);
+        getdisplay().printf("%d%%", commonData->backlight.brightness);
+        // TODO test function with OBP60 device
+        getdisplay().setCursor(202, y0 + 80);
+        getdisplay().print("Bl color:");
+        getdisplay().setCursor(320, y0 + 80);
+        getdisplay().print(commonData->backlight.color.toName());
+        getdisplay().setCursor(202, y0 + 96);
+        getdisplay().print("Bl mode:");
+        getdisplay().setCursor(320, y0 + 96);
+        getdisplay().print(commonData->backlight.mode);
+        // TODO Buzzer mode and power
+#endif
+	}
+
+    void displayModeSDCard() {
+
+        // SD Card info
+        uint16_t x0 = 20;
+        uint16_t y0 = 72;
 
-        } else if (mode == 'C') {
-            // Card info
         getdisplay().setFont(&Ubuntu_Bold12pt8b);
         getdisplay().setCursor(8, 48);
         getdisplay().print("SD Card info");
 
         getdisplay().setFont(&Ubuntu_Bold8pt8b);
-
-            x0 = 20;
-            y0 = 72;
         getdisplay().setCursor(x0, y0);
 #ifdef BOARD_OBP60S3
         // This mode should not be callable by devices without card hardware
@@ -461,7 +395,7 @@ public:
         // Simple test for magic file in root
         getdisplay().setCursor(x0, y0 + 32);
         String file_magic = MOUNT_POINT "/magic.dat";
-            logger->logDebug(GwLog::LOG, "Test magicfile: %s", file_magic.c_str());
+        commonData->logger->logDebug(GwLog::LOG, "Test magicfile: %s", file_magic.c_str());
         struct stat st;
         if (stat(file_magic.c_str(), &st) == 0) {
             getdisplay().printf("File %s exists", file_magic.c_str());
@@ -473,7 +407,7 @@ public:
         DIR* dir = opendir(MOUNT_POINT);
         int dy = 0;
         if (dir != NULL) {
-                logger->logDebug(GwLog::LOG, "Root directory: %s", MOUNT_POINT);
+            commonData->logger->logDebug(GwLog::LOG, "Root directory: %s", MOUNT_POINT);
             struct dirent* entry;
             while (((entry = readdir(dir)) != NULL) and (dy < 140)) {
                 getdisplay().setCursor(x0, y0 + 64 + dy);
@@ -483,16 +417,17 @@ public:
                     getdisplay().print("/");
                 }
                 dy += 20;
-                    logger->logDebug(GwLog::DEBUG, "    %s type %d", entry->d_name, entry->d_type);
+                commonData->logger->logDebug(GwLog::DEBUG, "    %s type %d", entry->d_name, entry->d_type);
             }
             closedir(dir);
         } else {
-                logger->logDebug(GwLog::LOG, "Failed to open root directory");
+            commonData->logger->logDebug(GwLog::LOG, "Failed to open root directory");
         }
 
 #endif
+    }
 
-        } else {
+    void displayModeDevicelist() {
         // NMEA2000 device list
         getdisplay().setFont(&Ubuntu_Bold12pt8b);
         getdisplay().setCursor(8, 48);
@@ -507,8 +442,8 @@ public:
         getdisplay().print(String(commonData->status.n2kTx));
 
 #ifdef PATCH_N2K
-            x0 = 20;
+        uint16_t x0 = 20;
-            y0 = 100;
+        uint16_t y0 = 100;
 
         getdisplay().setFont(&Ubuntu_Bold10pt8b);
         getdisplay().setCursor(x0, y0);
@@ -546,7 +481,179 @@ public:
         getdisplay().setCursor(20, 100);
         getdisplay().print("NMEA2000 not exposed to obp60 task");
 #endif
+    }
 
+public:
+    PageSystem(CommonData &common){
+        commonData = &common;
+        commonData->logger->logDebug(GwLog::LOG,"Instantiate PageSystem");
+        if (hasFRAM) {
+            mode = fram.read(FRAM_SYSTEM_MODE);
+            commonData->logger->logDebug(GwLog::DEBUG, "Loaded mode '%c' from FRAM", mode);
+        }
+        chipid = ESP.getEfuseMac();
+        simulation = common.config->getBool(common.config->useSimuData);
+#ifdef BOARD_OBP40S3
+        use_sdcard = common.config->getBool(common.config->useSDCard);
+#endif
+        buzzer_mode = common.config->getString(common.config->buzzerMode);
+        buzzer_mode.toLowerCase();
+        buzzer_power = common.config->getInt(common.config->buzzerPower);
+        cpuspeed = common.config->getString(common.config->cpuSpeed);
+        powermode = common.config->getString(common.config->powerMode);
+        env_module = common.config->getString(common.config->useEnvSensor);
+        rtc_module = common.config->getString(common.config->useRTC);
+        gps_module = common.config->getString(common.config->useGPS);
+        batt_sensor = common.config->getString(common.config->usePowSensor1);
+        solar_sensor = common.config->getString(common.config->usePowSensor2);
+        gen_sensor = common.config->getString(common.config->usePowSensor3);
+        rot_sensor = common.config->getString(common.config->useRotSensor);
+        homelat = common.config->getString(common.config->homeLAT).toDouble();
+        homelon = common.config->getString(common.config->homeLON).toDouble();
+        flashLED = common.config->getString(common.config->flashLED);
+    }
+
+    void setupKeys() {
+        commonData->keydata[0].label = "EXIT";
+        commonData->keydata[1].label = "MODE";
+        commonData->keydata[2].label = "";
+        commonData->keydata[3].label = "RST";
+        commonData->keydata[4].label = "STBY";
+        commonData->keydata[5].label = "ILUM";
+    }
+
+    int handleKey(int key) {
+        // do *NOT* handle key #1 this handled by obp60task as exit
+        // Switch display mode
+        commonData->logger->logDebug(GwLog::LOG, "System keyboard handler");
+        if (key == 2) {
+            incMode();
+            if (hasFRAM) fram.write(FRAM_SYSTEM_MODE, mode);
+            return 0;
+        }
+#ifdef BOARD_OBP60S3
+        // grab cursor key to disable page navigation
+        if (key == 3) {
+            return 0;
+        }
+        // soft reset
+        if (key == 4) {
+            ESP.restart();
+        }
+        // standby / deep sleep
+        if (key == 5) {
+            commonData->logger->logDebug(GwLog::LOG, "System going into deep sleep mode...");
+            deepSleep(*commonData);
+        }
+        // Code for keylock
+        if (key == 11) {
+            commonData->keylock = !commonData->keylock;
+            return 0;
+        }
+#endif
+#ifdef BOARD_OBP40S3
+        // use cursor keys for local mode navigation
+        if (key == 9) {
+            incMode();
+            return 0;
+        }
+        if (key == 10) {
+            decMode();
+            return 0;
+        }
+        // standby / deep sleep
+        if (key == 12) {
+            commonData->logger->logDebug(GwLog::LOG, "System going into deep sleep mode...");
+            deepSleep(*commonData);
+        }
+#endif
+        return key;
+    }
+
+    void displayBarcode(String serialno, uint16_t x, uint16_t y, uint16_t s) {
+        // Barcode with serial number
+        // x, y is top left corner
+        // s is pixel size of a single box
+        QRCode qrcode;
+        uint8_t qrcodeData[qrcode_getBufferSize(4)];
+#ifdef BOARD_OBP40S3
+        String prefix = "OBP40:SN:";
+#endif
+#ifdef BOARD_OBP60S3
+        String prefix = "OBP60:SN:";
+#endif
+        qrcode_initText(&qrcode, qrcodeData, 4, 0, (prefix + serialno).c_str());
+        int16_t x0 = x;
+        for (uint8_t j = 0; j < qrcode.size; j++) {
+            for (uint8_t i = 0; i < qrcode.size; i++) {
+                if (qrcode_getModule(&qrcode, i, j)) {
+                    getdisplay().fillRect(x, y, s, s, commonData->fgcolor);
+                }
+                x += s;
+            }
+            y += s;
+            x = x0;
+        }
+    }
+
+    void displayNew(PageData &pageData) {
+#ifdef BOARD_OBP60S3
+        // Clear optical warning
+        if (flashLED == "Limit Violation") {
+            setBlinkingLED(false);
+            setFlashLED(false);
+        }
+#endif
+
+#ifdef PATCH_N2K
+        // load current device list
+        tN2kDeviceList *pDevList = pageData.api->getN2kDeviceList();
+        // TODO check if changed
+        if (pDevList->ReadResetIsListUpdated()) {
+            // only reload if changed
+            devicelist.clear();
+            for (uint8_t i = 0; i <= 252; i++) {
+                const tNMEA2000::tDevice *d = pDevList->FindDeviceBySource(i);
+                if (d == nullptr) {
+                    continue;
+                }
+                device dev;
+                dev.id = i;
+                dev.NAME = d->GetName();
+                snprintf(dev.hex_name, sizeof(dev.hex_name), "%08X%08X", (uint32_t)(dev.NAME >> 32), (uint32_t)(dev.NAME & 0xFFFFFFFF));
+                dev.manuf_code = d->GetManufacturerCode();
+                dev.model = d->GetModelID();
+                devicelist.push_back(dev);
+            }
+        }
+#endif
+    };
+
+    int displayPage(PageData &pageData){
+
+        // Logging page information
+        commonData->logger->logDebug(GwLog::LOG, "Drawing at PageSystem, Mode=%c", mode);
+
+        // Set display in partial refresh mode
+        getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update
+
+        // call current system page
+        switch (mode) {
+            case 'N':
+                displayModeNormal();
+                break;
+            case 'S':
+                displayModeSettings();
+                break;
+            case 'C':
+                displayModeConfig();
+                break;
+            case 'A':
+                displayModeSDCard();
+                break;
+            case 'D':
+                displayModeDevicelist();
+                break;
         }
 
         // Update display

lib/obp60task/obp60task.cpp

@@ -432,7 +432,7 @@ void OBP60Task(GwApi *api){
 #endif
     LOG_DEBUG(GwLog::LOG,"...done");
 
-    int lastPage=-1; // initialize with an impiossible value, so we can detect wether we are during startup and no page has been displayed yet
+    int lastPage=-1; // initialize with an impossible value, so we can detect wether we are during startup and no page has been displayed yet
 
     BoatValueList boatValues; //all the boat values for the api query
     HstryBuffers hstryBufferList(1920, &boatValues, logger);  // Create empty list of boat data history buffers (1.920 values = seconds = 32 min.)
@@ -729,7 +729,7 @@ void OBP60Task(GwApi *api){
                 else{
                     getdisplay().fillScreen(commonData.fgcolor); // Clear display
                     #ifdef DISPLAY_GDEY042T81
-                        getdisplay().hibernate();                  // Set display in hybenate mode
+                        getdisplay().hibernate();                  // Set display in hibenate mode
                         getdisplay().init(115200, true, 2, false); // Init for Waveshare boards with "clever" reset circuit, 2ms reset pulse
                     #else
                         getdisplay().init(115200);               // Init for normal displays
@@ -757,7 +757,7 @@ void OBP60Task(GwApi *api){
                 else{
                     getdisplay().fillScreen(commonData.fgcolor); // Clear display
                     #ifdef DISPLAY_GDEY042T81
-                        getdisplay().hibernate();                  // Set display in hybenate mode
+                        getdisplay().hibernate();                  // Set display in hibernate mode
                         getdisplay().init(115200, true, 2, false); // Init for Waveshare boards with "clever" reset circuit, 2ms reset pulse
                     #else
                         getdisplay().init(115200);               // Init for normal displays
@@ -782,7 +782,7 @@ void OBP60Task(GwApi *api){
                 else{
                     getdisplay().fillScreen(commonData.fgcolor); // Clear display
                     #ifdef DISPLAY_GDEY042T81
-                        getdisplay().hibernate();                  // Set display in hybenate mode
+                        getdisplay().hibernate();                  // Set display in hibernate mode
                         getdisplay().init(115200, true, 2, false); // Init for Waveshare boards with "clever" reset circuit, 2ms reset pulse
                     #else
                         getdisplay().init(115200);               // Init for normal displays