Utils.h

Go to the documentation of this file.

/*
   Copyright (C) 2018 SFini

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
class SerialOut
{
protected:
   String message; 

public:
   SerialOut(String msg)
      : message(msg)
   {
      String m = ":" + String(millis()) + "[" + message;
      Serial.println(m.c_str());
   }
   ~SerialOut()
   {
      String m = message + ":" + String(millis()) + "]";
      Serial.println(m.c_str());
   }
};

long secondsSincePowerOn();

bool secondsElapsed(long &lastCheckSec, const long &intervalSec)
{
   long currentSec = secondsSincePowerOn();

   if (lastCheckSec == 0 || (currentSec - lastCheckSec > intervalSec)) {
      return true;
   }
   return false;
}

bool secondsElapsedAndUpdate(long &lastCheckSec, const long &intervalSec)
{
   long currentSec = secondsSincePowerOn();

   if (lastCheckSec == 0 || (currentSec - lastCheckSec > intervalSec)) {
      lastCheckSec = currentSec;
      return true;
   }
   return false;
}

#define POLY 0xedb88320 


long crc32(long crc, unsigned char *buf, size_t len)
{
   crc = ~crc;
   while (len--) {
      crc ^= *buf++;
      for (int k = 0; k < 8; k++)
         crc = crc & 1 ? (crc >> 1) ^ POLY : crc >> 1;
   }
   return ~crc;
}

void myDebugInfo(String info, bool isWebServer, bool newline);

void MyDbg(String info, bool fromWebServer = false, bool newline = true)
{
   myDebugInfo(info, fromWebServer, newline);
}


void myDelayLoop();

void MyDelay(long millisDelay)
{
   long m = millis();

   while (millis() - m < millisDelay) {
      myDelayLoop();
      yield();
      delay(1);
   }
}


String WifiGetRssiAsQuality(int rssi)
{
   int quality = 0;

   if (rssi <= -100) {
      quality = 0;
   } else if (rssi >= -50) {
      quality = 100;
   } else {
      quality = 2 * (rssi + 100);
   }
   return String(quality);
}

String TextToUrl(String data)
{
   data.replace(F("%"), F("%25"));
   data.replace(F("&"), F("%26"));
   data.replace(F("<"), F("%3C"));
   data.replace(F(">"), F("%3E"));

   for (int i = 0; i < data.length(); i++) {
      bool validChar = (data[i] == 0x09 || data[i] == 0x0A || data[i] == 0x0D || (data[i] >= 0x20 && data[i] <= 0xFF));

      if (!validChar) {
         data[i] = '?';
      }
   }
   return data;
}

String TextToXml(String data)
{
   data.replace(F("&"),  F("&amp;"));
   data.replace(F("<"),  F("&lt;"));
   data.replace(F(">"),  F("&gt;"));
   data.replace(F("\""), F("&quot;"));
   return data;
}

String Trim(const String &data, const String &chars)
{
   String ret = data;
   
   for (int i = 0; i < ret.length(); i++) {
      if (chars.indexOf(ret[i]) != -1) {
         ret.remove(i, 1);
         i--;
         continue;
      }
      break;
   }
   for (int i = data.length() - 1; i >= 0; i--) {
      if (chars.indexOf(ret[i]) != -1) {
         ret.remove(i, 1);
         continue;
      }
      break;
   }
   return ret;
}

String formatInterval(long secs)
{
   char buff[255];

   int days    =  secs / 60 / 60 / 24;
   int hours   = (secs / 60 / 60) % 24;
   int minutes = (secs / 60) % 60;
   int seconds =  secs % 60;

   buff[0] = '\0';
   if (days <= 0) {
      sprintf(buff, "%02d:%02d:%02d", hours, minutes, seconds);
   } else {
      sprintf(buff, "%d %02d:%02d:%02d", days, hours, minutes, seconds);
   }
   return buff;
}

bool scanInterval(String interval, long &secs)
{
   int first = -1;

   interval = Trim(interval, F(" "));
   first    = interval.indexOf(F(":"));
   if (first != -1) {
      String daysString;
      String hoursString;
      String minutesString;
      String secondsString;
      long   days    = 0;
      long   hours   = 0;
      long   minutes = 0;
      long   seconds = 0;

      int second = interval.indexOf(F(":"), first + 1);

      if (second != -1) {
         int space = interval.indexOf(F(" "));

         if (space != -1 && space < first) {
            daysString  = interval.substring(0, space);
            hoursString = interval.substring(space + 1, first);
         } else {
            hoursString = interval.substring(0, first);
         }
         minutesString = interval.substring(first + 1, second);
         secondsString = interval.substring(second + 1);

         days    = atol(daysString.c_str());
         hours   = atol(hoursString.c_str());
         minutes = atol(minutesString.c_str());
         seconds = atol(secondsString.c_str());

         if (days    >= 0 && 
             hours   >= 0 && hours   <= 23 && 
             minutes >= 0 && minutes <= 59 && 
             seconds >= 0 && seconds <= 59) {
            secs = 0;
            secs += days    * 24 * 60 * 60;
            secs += hours   * 60 * 60;
            secs += minutes * 60;
            secs += seconds;
            return true;
         }
      }
   }
   return false;
}

void SetupOTA()
{
   MyDbg(F("StartOTA"));
      
   ArduinoOTA.setHostname("SnorkTracker");

   ArduinoOTA.setPort(8266);

   ArduinoOTA.onStart([]() {
      MyDbg(F("OTA Start"));
   });
   ArduinoOTA.onEnd([]() {
      MyDbg(F("\nOTA End"));
   });
   ArduinoOTA.onProgress([](unsigned int progress, unsigned int total) {
      MyDbg("OTA Progress: " + String(progress / (total / 100)));
   });   
   ArduinoOTA.onError([](ota_error_t error) {
      MyDbg("OTA Error[%u]: " + error);
      if (error == OTA_AUTH_ERROR)         MyDbg(F("OTA Auth Failed"));
      else if (error == OTA_BEGIN_ERROR)   MyDbg(F("OTA Begin Failed"));
      else if (error == OTA_CONNECT_ERROR) MyDbg(F("OTA Connect Failed"));
      else if (error == OTA_RECEIVE_ERROR) MyDbg(F("OTA Receive Failed"));
      else if (error == OTA_END_ERROR)     MyDbg(F("OTA End Failed"));
   });
}