Merge pull request #40 from Strooom/develop minor Minor

Merge Development into a new Release

Author: Strooom

TODO.md

@@ -1,6 +1,13 @@
 # MuMo SW V3
 ## ToDo's
 
+2. make SNR work both in devStatusReq and on display
+3. make measurementGroup a template class, so we can make large ones (for sensorDeviceCollection) and small ones (for events such as usb plugin...)
+4. make epaper display refresh faster...
+5. start adding unit test for main application. eg. all changes for cli commands
+6. implement configuring display
+7. put MCU in sleep when waiting for low power timer...
+
 ### Priority High
 
 * measurementsGroupCollection

docs/kmska.md

@@ -14,16 +14,20 @@
 #include <applicationevent.hpp>
 #include <clicommand.hpp>
 
-static constexpr bool forceInitialization{false};
-static constexpr batteryType defaultBatteryType{batteryType::alkaline_1200mAh};
-static constexpr radioType defaultRadioType{radioType::lowPower};
 static constexpr uint32_t maxNameLength{8U};        // maximum length of the node name, including the null terminator
 static constexpr char toBeName[maxNameLength + 1] = "MuMo";
 
 class mainController {
   public:
     mainController() = delete;
     static void initialize();
+    static void initializeLogging();
+    static void initializeNonVolatileStorage();
+    static void initializeName();
+    static void initializeBattery();
+    static void initializeDisplay();
+    static void initializeRadio();
+    static void initializeSensors();
     static void runUsbPowerDetection();
     static void runStateMachine();
     static void handleEvents();
@@ -33,14 +37,14 @@ class mainController {
 
     static constexpr uint32_t minNmbrAnswers{2};
     static constexpr uint32_t maxNmbrRequests{12};
-    static const uint32_t displayDeviceIndex[screen::nmbrOfMeasurementTextLines];
-    static const uint32_t displayChannelIndex[screen::nmbrOfMeasurementTextLines];
-
-#ifndef unitTesting
-
+    
+    #ifndef unitTesting
+    
     // private:
-#endif
+    #endif
     static char name[maxNameLength + 1];
+    static uint32_t displayDeviceIndex[screen::nmbrOfMeasurementTextLines];
+    static uint32_t displayChannelIndex[screen::nmbrOfMeasurementTextLines];
 
     static void goTo(mainState newState);
     static mainState state;

lib/application/maincontroller.cpp

@@ -144,5 +144,8 @@ To map the OpenGL coordinate system onto the display hardware, the following set
 
 # Partial Update
 SSD1681 has 2 update modes :
-* Mode 1 : full update. The display will cycle through all white, all black, new image, etc. to activate all pigments particles and results in a clean, high contrast image, gets rig of any ghosting. This update mode takes longer, depending on temperature, about 2500 ms
-* Mode 2 : partial update. The display needs the old (current) image in RAM2 and the new image in RAM1. It will apply an update depending on the needed pixel statechange. This typically takes less time, about 1000ms, but it requires you to write old and new displayBuffer to the display. Also this mode creates less contrast, may leave a bit of ghosting image. Mode two can also be applied to a selected area instead of the whole display. You need to set xStart, xEnd, yStart, yEnd to mark the window with changes. There is a small gain in update time when updating a region io. the whole display, typically like 800 ms for an update.
+* Mode 1 : full update. The display will cycle through all white, all black, new image, etc. to activate all pigments particles and results in a clean, high contrast image, gets rid of any ghosting. This update mode takes longer, depending on temperature, about 2500 ms
+* Mode 2 : partial update. The display needs the old (current) image in RAM2 and the new image in RAM1. It will apply an update depending on the needed pixel statechange. This typically takes less time, about 1000ms, but it requires you to write old and new displayBuffer to the display. Also this mode creates less contrast, may leave a bit of ghosting image. Mode two can also be applied to a selected area instead of the whole display. You need to set xStart, xEnd, yStart, yEnd to mark the window with changes. There is a small gain in update time when updating a region io. the whole display, typically like 800 ms for an update.
+
+# Faster update
+* The display update time depends on the temperature : when colder, the pixel pigments move slower. So a trick to make the display update faster, is to NOT use the internal temperature sensor, but rather write the temperature, and make the display believe temp is 100 degrees. The update is the really quick, with very limited ghosting. To get rid of any ghosting, you could do a 'normal' update, every x fast updates.

lib/application/maincontroller.hpp

@@ -26,24 +26,12 @@ uint32_t logging::activeDestinations{0};
 char logging::buffer[bufferLength]{};
 
 void logging::initialize() {
-#ifndef generic
-    if ((CoreDebug->DHCSR & CoreDebug_DHCSR_C_DEBUGEN_Msk) == 0x0001) {        // is a SWD debugprobe connected ?
-#ifndef platformio                                                             // SWO TRACE is not working on PlatformIO
-        logging::enable(logging::destination::swo);
-#endif
-        LL_DBGMCU_EnableDBGStopMode();
-    } else {
-        LL_DBGMCU_DisableDBGStopMode();
-    }
-#endif
-    if (power::hasUsbPower()) {
-        logging::enable(logging::destination::uart2);
-    }
-    if (!logging::isActive(logging::destination::swo)) {
-        gpio::disableGpio(gpio::group::debugPort);
-    }
+    enable(logging::destination::uart1);
+    enable(logging::source::error);
+    enable(logging::source::criticalError);
 }
 
+
 uint32_t logging::snprintf(const char *format, ...) {
     uint32_t length{0};
     if (activeDestinations != 00) {
@@ -113,27 +101,6 @@ void logging::write(const uint32_t dataLength) {
     }
 }
 
-void logging::dump() {
-    logging::snprintf("logging : \n");
-    if (activeSources == 0) {
-        logging::snprintf("  no active sources\n");
-    } else {
-        logging::snprintf("  sources      : ");
-        for (uint32_t index = 0; index < 32; index++) {
-            if ((activeSources & (0x01 << index)) != 0) {
-                logging::snprintf("%s ", toString(static_cast<source>(index)));
-            }
-        }
-        logging::snprintf("\n");
-    }
-    logging::snprintf("  destinations : ");
-    for (uint32_t index = 0; index < 32; index++) {
-        if ((activeDestinations & (0x01 << index)) != 0) {
-            logging::snprintf("%s ", toString(static_cast<destination>(index)));
-        }
-    }
-    logging::snprintf("\n");
-}
 const char *toString(const logging::source aSource) {
     switch (aSource) {
         case logging::source::applicationEvents:

lib/display/display.md

@@ -40,9 +40,10 @@ class logging {
         activeSources      = 0;
         activeDestinations = 0;
     }
-    static uint32_t snprintf(const char *format, ...);                                  // logs always, to all active destinations
-    static uint32_t snprintf(const source aSource, const char *format, ...);                  // logs to all active destinations, but only if the source is active
-    static uint32_t snprintf(const destination aDestination, const char *format, ...);        // logs to a specific destination
+    static uint32_t snprintf(const char *format, ...);
+    static uint32_t snprintf(const source aSource, const char *format, ...);
+    static uint32_t snprintf(const destination aDestination, const char *format, ...);
+
     static void enable(const source aSource) { activeSources = activeSources | (0x01 << static_cast<uint32_t>(aSource)); }
     static void disable(const source aSource) { activeSources = activeSources & ~(0x01 << static_cast<uint32_t>(aSource)); }
     static void enable(const destination aDestination) { activeDestinations = activeDestinations | (0x01 << static_cast<uint32_t>(aDestination)); }
@@ -63,7 +64,6 @@ class logging {
     static uint32_t getActiveDestinations() { return activeDestinations; }
     static void setActiveDestinations(const uint32_t aDestinations) { activeDestinations = aDestinations; }
 
-    static void dump();
 #ifndef unitTesting
 
   private:

lib/logging/logging.cpp

@@ -812,7 +812,7 @@ class gf256 {
             z = (z << 1) ^ ((z >> 7) * 0x11D);
             z ^= ((y >> i) & 1) * x;
         }
-        return z;
+        return static_cast<uint8_t>(z);
     }
 
     static uint8_t inv(uint8_t a) {

lib/logging/logging.hpp

@@ -905,14 +905,13 @@ void qrCode::selectMask() {
 
 #pragma endregion
 
-// ?????
-
 uint32_t qrCode::payloadLengthInBits(uint32_t dataLengthInBytes, uint32_t someVersion, encodingFormat someEncodingFormat) {
     uint32_t modeIndicatorLength{4U};
     switch (someEncodingFormat) {
         case encodingFormat::numeric:
             uint32_t remainderLength;
             switch (dataLengthInBytes % 3) {
+                default:        // intentional fallthrough
                 case 0:
                     remainderLength = 0;
                     break;

lib/qrcode/gf256.hpp

@@ -12,6 +12,7 @@
 
 class battery {
   public:
+    static constexpr batteryType defaultBatteryType{batteryType::liFePO4_700mAh};
     static void setType(uint8_t index);
     static bool isValidType(batteryType newBatteryType);
     static void initialize(batteryType newBatteryType);