Early at power up warning, if battery voltage is low (#210)

Fixes #209

Author: amandel

.idea/OpenBikeSensorFirmware.iml

@@ -138,24 +138,36 @@ void setup() {
   switch_wire_speed_to_SSD1306();
 
   displayTest->showLogo(true);
-  displayTest->showTextOnGrid(2, 0, OBSVersion,DEFAULT_FONT);
+  displayTest->showTextOnGrid(2, displayTest->startLine(), OBSVersion);
+
+  voltageMeter = new VoltageMeter; // takes a moment, so do it here
+  if (voltageMeter->hasReadings()) {
+    displayTest->showTextOnGrid(2, displayTest->newLine(),
+                                "Battery: " + String(voltageMeter->read(), 1) + "V");
+    delay(333); // Added for user experience
+  }
+  if (voltageMeter->isWarningLevel()) {
+    displayTest->showTextOnGrid(2, displayTest->newLine(), "LOW BAT");
+    displayTest->showTextOnGrid(2, displayTest->newLine(), "WARNING!");
+    delay(5000);
+  }
 
   //##############################################################
   // Load, print and save config
   //##############################################################
 
-  displayTest->showTextOnGrid(2, 1, "Config... ",DEFAULT_FONT);
+  displayTest->showTextOnGrid(2, displayTest->newLine(), "Config... ");
 
   if (!SPIFFS.begin(true)) {
     Serial.println("An Error has occurred while mounting SPIFFS");
-    displayTest->showTextOnGrid(2, 1, "Config... error ",DEFAULT_FONT);
+    displayTest->showTextOnGrid(2, displayTest->currentLine(), "Config... error ");
     return;
   }
 
   Serial.println(F("Load config"));
   ObsConfig cfg; // this one is valid in setup!
   if (!cfg.loadConfig()) {
-    displayTest->showTextOnGrid(2, 1, "Config...RESET",DEFAULT_FONT);
+    displayTest->showTextOnGrid(2, displayTest->currentLine(), "Config...RESET");
     delay(1000); // resetting config once, wait a moment
   }
 
@@ -182,37 +194,32 @@ void setup() {
 
   delay(333); // Added for user experience
   char buffer[32];
-  snprintf(buffer, sizeof(buffer), "<%02d| |%02d>",
+  snprintf(buffer, sizeof(buffer), "<%02d| - |%02d>",
     config.sensorOffsets[LEFT_SENSOR_ID],
     config.sensorOffsets[RIGHT_SENSOR_ID]);
-  displayTest->showTextOnGrid(2, 1, buffer,DEFAULT_FONT);
+  displayTest->showTextOnGrid(2, displayTest->currentLine(), buffer);
 
   gps.begin();
 
   //##############################################################
   // Handle SD
   //##############################################################
-  // Counter, how often the SD card will be read before writing an error on the display
-  int8_t sdCount = 5;
-
-  displayTest->showTextOnGrid(2, 2, "SD...",DEFAULT_FONT);
+  int8_t sdCount = 0;
+  displayTest->showTextOnGrid(2, displayTest->newLine(), "SD...");
   while (!SD.begin()) {
-    if(sdCount > 0) {
-      sdCount--;
-    } else {
-      displayTest->showTextOnGrid(2, 2, "SD... error",DEFAULT_FONT);
-      if (config.simRaMode || digitalRead(PushButton_PIN) == HIGH) {
-        break;
-      }  // FIXME: Stop trying!!?
+    sdCount++;
+    displayTest->showTextOnGrid(2,
+      displayTest->currentLine(), "SD... error " + String(sdCount));
+    if (config.simRaMode || digitalRead(PushButton_PIN) == HIGH || sdCount > 10) {
+      break;
     }
-    Serial.println("Card Mount Failed");
-    //delay(100);
+    delay(200);
   }
-  delay(333); // Added for user experience
+
   if (SD.begin()) {
-    Serial.println("Card Mount Succeeded");
-    displayTest->showTextOnGrid(2, 2, "SD... ok",DEFAULT_FONT);
+    displayTest->showTextOnGrid(2, displayTest->currentLine(), "SD... ok");
   }
+  delay(333); // Added for user experience
 
   //##############################################################
   // Init HCSR04
@@ -243,7 +250,7 @@ void setup() {
 
   buttonState = digitalRead(PushButton_PIN);
   if (buttonState == HIGH || (!config.simRaMode && displayError != 0)) {
-    displayTest->showTextOnGrid(2, 2, "Start Server",DEFAULT_FONT);
+    displayTest->showTextOnGrid(2, displayTest->newLine(), "Start Server");
     ESP_ERROR_CHECK_WITHOUT_ABORT(
       esp_bt_mem_release(ESP_BT_MODE_BTDM)); // no bluetooth at all here.
 
@@ -264,29 +271,19 @@ void setup() {
   // Prepare CSV file
   //##############################################################
 
-  displayTest->showTextOnGrid(2, 3, "CSV file...",DEFAULT_FONT);
+  displayTest->showTextOnGrid(2, displayTest->newLine(), "CSV file...");
 
   const String trackUniqueIdentifier = ObsUtils::createTrackUuid();
 
   if (SD.begin()) {
     writer = new CSVFileWriter;
     writer->setFileName();
     writer->writeHeader(trackUniqueIdentifier);
-    displayTest->showTextOnGrid(2, 3, "CSV file... ok",DEFAULT_FONT);
-    Serial.println("File initialised");
+    displayTest->showTextOnGrid(2, displayTest->currentLine(), "CSV file... ok");
   } else {
-    displayTest->showTextOnGrid(2, 3, "CSV. skipped",DEFAULT_FONT);
+    displayTest->showTextOnGrid(2, displayTest->currentLine(), "CSV. skipped");
   }
 
-  //##############################################################
-  // GPS
-  //##############################################################
-
-  displayTest->showTextOnGrid(2, 4, "Wait for GPS",DEFAULT_FONT);
-  gps.handle();
-  voltageMeter = new VoltageMeter; // takes a moment, so do it here
-  gps.handle();
-
   //##############################################################
   // Temperatur Sensor BMP280
   //##############################################################
@@ -299,6 +296,7 @@ void setup() {
   // Bluetooth
   //##############################################################
   if (cfg.getProperty<bool>(ObsConfig::PROPERTY_BLUETOOTH)) {
+    displayTest->showTextOnGrid(2, displayTest->newLine(), "Bluetooth ..");
     bluetoothManager = new BluetoothManager;
     bluetoothManager->init(
       cfg.getProperty<String>(ObsConfig::PROPERTY_OBS_NAME),
@@ -307,13 +305,15 @@ void setup() {
       batteryPercentage,
       trackUniqueIdentifier);
     bluetoothManager->activateBluetooth();
+    displayTest->showTextOnGrid(2, displayTest->currentLine(), "Bluetooth up");
   } else {
     bluetoothManager = nullptr;
     ESP_ERROR_CHECK_WITHOUT_ABORT(
       esp_bt_mem_release(ESP_BT_MODE_BTDM)); // no bluetooth at all here.
   }
 
-  Serial.println("Waiting for GPS fix...");
+  displayTest->showTextOnGrid(2, displayTest->newLine(), "Wait for GPS");
+  displayTest->newLine();
   gps.handle();
   int gpsWaitFor = cfg.getProperty<int>(ObsConfig::PROPERTY_GPS_FIX);
   while (!gps.hasState(gpsWaitFor, displayTest)) {
@@ -329,10 +329,10 @@ void setup() {
 
     buttonState = digitalRead(PushButton_PIN);
     if (buttonState == HIGH
-      || (config.simRaMode && !gps.moduleIsAlive()) // no module && simRaMode
-    ) {
+        || (config.simRaMode && !gps.moduleIsAlive()) // no module && simRaMode
+      ) {
       log_d("Skipped get GPS...");
-      displayTest->showTextOnGrid(2, 5, "...skipped",DEFAULT_FONT);
+      displayTest->showTextOnGrid(2, displayTest->currentLine(), "...skipped");
       break;
     }
   }
@@ -516,6 +516,14 @@ void loop() {
   memcpy(&(currentSet->startOffsetMilliseconds),
     &(sensorManager->startOffsetMilliseconds), currentSet->measurements * sizeof(uint16_t));
 
+#ifdef DEVELOP
+  Serial.write("min. distance: ");
+  Serial.print(currentSet->sensorValues[confirmationSensorID]) ;
+  Serial.write(" cm,");
+  Serial.print(measurements);
+  Serial.write(" measurements  \n");
+#endif
+
   // if nothing was detected, write the dataset to file, otherwise write it to the buffer for confirmation
   if (!transmitConfirmedData
     && currentSet->sensorValues[confirmationSensorID] == MAX_SENSOR_VALUE
@@ -529,13 +537,6 @@ void loop() {
     dataBuffer.push(currentSet);
   }
 
-#ifdef DEVELOP
-  Serial.write("min. distance: ");
-  Serial.print(currentSet->sensorValues[confirmationSensorID]) ;
-  Serial.write(" cm,");
-  Serial.print(measurements);
-  Serial.write(" measurements  \n");
-#endif
 
   lastMeasurements = measurements;
 

src/OpenBikeSensorFirmware.cpp

@@ -57,6 +57,14 @@ VoltageMeter::VoltageMeter() {
 #endif
 }
 
+bool VoltageMeter::isWarningLevel() {
+  return hasReadings() && (read() < VoltageMeter::BATTERY_WARNING_LEVEL);
+}
+
+bool VoltageMeter::hasReadings() {
+  return read() > VoltageMeter::BATTERY_NO_READ_LEVEL;
+}
+
 double VoltageMeter::read() {
   return esp_adc_cal_raw_to_voltage(readSmoothed(), &adc_chars)
     * 3.0 / 2000.0; // voltage divider @ OSB PCB

src/VoltageMeter.cpp

@@ -10,6 +10,8 @@ class VoltageMeter {
     /* Returns the (smoothed) value in Volts. */
     double read();
     uint8_t readPercentage();
+    bool hasReadings();
+    bool isWarningLevel();
 
   private:
     /* This one is typically NOT used, our ESP32 dos have
@@ -20,6 +22,12 @@ class VoltageMeter {
 //  const uint8_t REFERENCE_PIN = 35;
     const int16_t MINIMUM_SAMPLES = 64;
     const int16_t SAMPLES_DIVIDE = 128;
+
+    /* Below this value a warning will be printed during startup. */
+    const double BATTERY_WARNING_LEVEL = 3.47;
+    /* Below this value it is assumed there is no voltage reading at all. */
+    const double BATTERY_NO_READ_LEVEL = 3.00;
+
     esp_adc_cal_characteristics_t adc_chars;
     int16_t lastSmoothedReading;
     int readSmoothed();

src/VoltageMeter.h

@@ -211,3 +211,26 @@ void SSD1306DisplayDevice::showSpeed(double velocity) {
   this->prepareTextOnGrid(0, 4, buffer, Dialog_plain_20);
   this->prepareTextOnGrid(1, 5, "km/h",DEFAULT_FONT);
 }
+
+uint8_t SSD1306DisplayDevice::currentLine() const {
+  return mCurrentLine;
+}
+
+uint8_t SSD1306DisplayDevice::newLine() {
+  if (mCurrentLine >= 5) {
+    scrollUp();
+  }
+  return ++mCurrentLine;
+}
+
+uint8_t SSD1306DisplayDevice::scrollUp() {
+  for (uint8_t i = 0; i < 5; i++) {
+    prepareTextOnGrid(2, i, displayTest->get_gridTextofCell(2, i + 1));
+  }
+  m_display->display();
+  return mCurrentLine--;
+}
+
+uint8_t SSD1306DisplayDevice::startLine() {
+  return mCurrentLine = 0;
+}

src/displays.cpp

@@ -59,6 +59,7 @@ class SSD1306DisplayDevice : public DisplayDevice {
     SSD1306* m_display;
     String gridText[ 4 ][ 6 ];
     uint8_t mLastProgress = 255;
+    uint8_t mCurrentLine = 0;
 
   public:
     SSD1306DisplayDevice() : DisplayDevice() {
@@ -73,6 +74,11 @@ class SSD1306DisplayDevice : public DisplayDevice {
       delete m_display;
     }
 
+    uint8_t currentLine() const;
+    uint8_t newLine();
+    uint8_t scrollUp();
+    uint8_t startLine();
+
     //##############################################################
     // Basic display configuration
     //##############################################################

src/displays.h

@@ -291,17 +291,14 @@ void Gps::showWaitStatus(SSD1306DisplayDevice *display) {
   if (gps.passedChecksum() != 0    //only do this if a communication is there and a valid time is there
       && gps.time.isValid()
       && !(gps.time.second() == 00 && gps.time.minute() == 00 && gps.time.hour() == 00)) {
-    // This is a hack :) if still the version is displayed in the 1st line we scroll up
-    if (displayTest->get_gridTextofCell(2, 0).startsWith("v")) {
-      //This should implement scrolling and only scroll up on the first time, should be a display feature
-      for (uint8_t i = 0; i < 4; i++) {
-        displayTest->showTextOnGrid(2, i, displayTest->get_gridTextofCell(2, i + 1), DEFAULT_FONT);
-      }
+    // This is a hack :) if still the "Wait for GPS" version is displayed original line
+    if (displayTest->get_gridTextofCell(2, 4).startsWith("Wait")) {
+      display->newLine();
     }
-    displayTest->showTextOnGrid(2, 4, satellitesString[0], DEFAULT_FONT);
-    displayTest->showTextOnGrid(2, 5, satellitesString[1], DEFAULT_FONT);
+    displayTest->showTextOnGrid(2, display->currentLine() - 1, satellitesString[0]);
+    displayTest->showTextOnGrid(2, display->currentLine(), satellitesString[1]);
   } else { //if no gps comm or no time is there, just write in the last row
-    displayTest->showTextOnGrid(2, 5, satellitesString[0]);
+    displayTest->showTextOnGrid(2, display->currentLine(), satellitesString[0]);
   }
 }