From 40a20dba5716d2224edf56852a9c79c47581221b Mon Sep 17 00:00:00 2001
From: Luc <luc.lebosse@gmail.com>
Date: Tue, 19 Jan 2016 16:01:22 +0800
Subject: [PATCH] Code optimization / Typo fixes

use more F() macro to save space, fixe several typo issue
Thanks @treepleks
---
 esp8266/config.cpp | 177 ++++++++++++++++++++++++---------------------
 esp8266/config.h   |   2 +-
 2 files changed, 96 insertions(+), 83 deletions(-)

diff --git a/esp8266/config.cpp b/esp8266/config.cpp
index 849bafb8..0c4185cd 100644
--- a/esp8266/config.cpp
+++ b/esp8266/config.cpp
@@ -31,22 +31,21 @@ bool CONFIG::read_string(int pos, char byte_buffer[], int size_max)
   //check if parameters are acceptable
   if (size_max==0 ||  pos+size_max+1 > EEPROM_SIZE || byte_buffer== NULL)return false;
   EEPROM.begin(EEPROM_SIZE);
-  byte b=0;
+  byte b = 13; // non zero for the while loop below
   int i=0;
-  //read first byte
-  b = EEPROM.read(pos + i);
-  byte_buffer[i]=b;
-  i++;
+
   //read until max size is reached or \0 is found
-  while (i<size_max+1 && b!=0)
+  while (i < size_max && b != 0)
   {
     b = EEPROM.read(pos+i);
     byte_buffer[i]=b; 
     i++;
   } 
-  //if it is a string be sure there is an 0 at the end
+  
+  // Be sure there is a 0 at the end.
   if (b!=0)byte_buffer[i-1]=0x00; 
   EEPROM.end();
+  
   return true;
 }
 
@@ -54,22 +53,20 @@ bool CONFIG::read_string(int pos, String & sbuffer, int size_max)
 {
   //check if parameters are acceptable
   if (size_max==0 ||  pos+size_max+1 > EEPROM_SIZE )return false;
-  byte b=0;
+  byte b = 13; // non zero for the while loop below
   int i=0;
   sbuffer="";
+
   EEPROM.begin(EEPROM_SIZE);
-  //read first byte
-  b = EEPROM.read(pos + i);
-  sbuffer+=char(b);
-  i++;
   //read until max size is reached or \0 is found
-  while (i<size_max+1 && b!=0)
+  while (i < size_max && b != 0)
   {
     b = EEPROM.read(pos+i);
     sbuffer+=char(b); 
     i++;
   } 
   EEPROM.end();
+
   return true;
 }
 
@@ -182,161 +179,177 @@ bool CONFIG::reset_config()
 
 void CONFIG::print_config()
 {
- //use bigest size for buffer
+  //use biggest size for buffer
   char sbuf[MAX_PASSWORD_LENGTH+1];
   byte bbuf=0;
   int ibuf=0;
   if (CONFIG::read_byte(EP_WIFI_MODE, &bbuf ))
 	{
-	 if (byte(bbuf)==CLIENT_MODE) Serial.println("Mode: Station");
-	 else  if (byte(bbuf)==AP_MODE) Serial.println("Mode: Access Point");
-	 else Serial.println("Mode: ???");
+      Serial.print(F("Mode: "));
+      if (byte(bbuf) == CLIENT_MODE) Serial.println(F("Station"));
+      else if (byte(bbuf)==AP_MODE) Serial.println(F("Access Point"));
+      else Serial.println("???");
 	}
-  else Serial.println("Error reading mode");
+  else Serial.println(F("Error reading mode"));
+  
   if (CONFIG::read_string(EP_SSID, sbuf , MAX_SSID_LENGTH))
   {
-   Serial.print("SSID: ");
+      Serial.print(F("SSID: "));
   Serial.println(sbuf);
   }
-  else  Serial.println("Error reading SSID");
+  else  Serial.println(F("Error reading SSID"));
   //if (CONFIG::read_string(EP_PASSWORD, sbuf , MAX_PASSWORD_LENGTH))Serial.println(sbuf);
   
   if (CONFIG::read_byte(EP_IP_MODE, &bbuf ))
   {
-	 if (byte(bbuf)==STATIC_IP_MODE) Serial.println("IP Mode: Static");
-	 else  if (byte(bbuf)==DHCP_MODE) Serial.println("IP Mode: DHCP");
-	 else Serial.println("IP mode: ???");
+      Serial.print(F("IP Mode: "));
+      if (byte(bbuf)==STATIC_IP_MODE) Serial.println(F("Static"));
+      else  if (byte(bbuf)==DHCP_MODE) Serial.println(F("DHCP"));
+      else Serial.println(F("???"));
   }
-  else  Serial.println("Error reading IP mode");
+  else  Serial.println(F("Error reading IP mode"));
+  
   if (CONFIG::read_buffer(EP_IP_VALUE,(byte *)sbuf , IP_LENGTH))
   {
-	Serial.print("IP: ");
+      Serial.print(F("IP: "));
 	Serial.println(wifi_config.ip2str((byte *)sbuf));
 	}
-  else Serial.println("Error reading IP");
+  else Serial.println(F("Error reading IP"));
+  
   if (CONFIG::read_buffer(EP_MASK_VALUE, (byte *)sbuf  , IP_LENGTH))
   {
-	Serial.print("Subnet: ");
+      Serial.print(F("Subnet: "));
 	Serial.println(wifi_config.ip2str((byte *)sbuf));
    }
-  else Serial.println("Error reading subnet");
+  else Serial.println(F("Error reading subnet"));
+  
   if (CONFIG::read_buffer(EP_GATEWAY_VALUE, (byte *)sbuf  , IP_LENGTH))
   {
-	Serial.print("Gateway : ");
+      Serial.print(F("Gateway: "));
    Serial.println(wifi_config.ip2str((byte *)sbuf));
     }
-  else Serial.println("Error reading gateway");
+  else Serial.println(F("Error reading gateway"));
+  
   if (CONFIG::read_buffer(EP_BAUD_RATE,  (byte *)&ibuf , INTEGER_LENGTH))
   {
-	Serial.print("Baud rate : ");
+      Serial.print(F("Baud rate: "));
   Serial.println(ibuf);
   }
-  else Serial.println("Error reading baud rate");
+  else Serial.println(F("Error reading baud rate"));
+  
   if (CONFIG::read_byte(EP_PHY_MODE, &bbuf ))
   {
-	  Serial.print("Phy mode : ");
-	  if (byte(bbuf)==PHY_MODE_11B)Serial.println("11b");
-	  else if (byte(bbuf)==PHY_MODE_11G)Serial.println("11g");
-	  else if (byte(bbuf)==PHY_MODE_11N)Serial.println("11n");
-	  else Serial.println("???");
+      Serial.print(F("Phy mode: "));
+      if (byte(bbuf)==PHY_MODE_11B) Serial.println(F("11b"));
+      else if (byte(bbuf)==PHY_MODE_11G) Serial.println(F("11g"));
+      else if (byte(bbuf)==PHY_MODE_11N) Serial.println(F("11n"));
+      else Serial.println(F("???"));
     }
-  else Serial.println("Error reading phy mode");
+  else Serial.println(F("Error reading phy mode"));
+  
   if (CONFIG::read_byte(EP_SLEEP_MODE, &bbuf ))
   {
-	Serial.print("Sleep mode : ");
-	  if (byte(bbuf)==NONE_SLEEP_T)Serial.println("None");
-	  else if (byte(bbuf)==LIGHT_SLEEP_T)Serial.println("Light");
-	  else if (byte(bbuf)==MODEM_SLEEP_T)Serial.println("Modem");
-	  else Serial.println("???");
+      Serial.print(F("Sleep mode: "));
+      if (byte(bbuf)==NONE_SLEEP_T) Serial.println(F("None"));
+      else if (byte(bbuf)==LIGHT_SLEEP_T) Serial.println(F("Light"));
+      else if (byte(bbuf)==MODEM_SLEEP_T) Serial.println(F("Modem"));
+      else Serial.println(F("???"));
   }
-  else Serial.println("Error reading sleep mode");
+  else Serial.println(F("Error reading sleep mode"));
+  
   if (CONFIG::read_byte(EP_CHANNEL, &bbuf ))
   {
-	 Serial.print("Channel : ");
+      Serial.print(F("Channel: "));
 	Serial.println(byte(bbuf));
    }
-  else Serial.println("Error reading channel");
+  else Serial.println(F("Error reading channel"));
   
   if (CONFIG::read_byte(EP_AUTH_TYPE, &bbuf ))
   {
-	Serial.print("Authentification : ");
-	if (byte(bbuf)==AUTH_OPEN)Serial.println("None");
-	else if (byte(bbuf)==AUTH_WEP)Serial.println("WEP");
-	else if (byte(bbuf)==AUTH_WPA_PSK)Serial.println("WPA");
-	else if (byte(bbuf)==AUTH_WPA2_PSK)Serial.println("WPA2");
-	else if (byte(bbuf)==AUTH_WPA_WPA2_PSK)Serial.println("WPA/WPA2");
-	else if (byte(bbuf)==AUTH_MAX)Serial.println("Max");
-	else Serial.println("???");
+      Serial.print(F("Authentification: "));
+      if (byte(bbuf)==AUTH_OPEN) Serial.println(F("None"));
+      else if (byte(bbuf)==AUTH_WEP) Serial.println(F("WEP"));
+      else if (byte(bbuf)==AUTH_WPA_PSK) Serial.println(F("WPA"));
+      else if (byte(bbuf)==AUTH_WPA2_PSK) Serial.println(F("WPA2"));
+      else if (byte(bbuf)==AUTH_WPA_WPA2_PSK) Serial.println(F("WPA/WPA2"));
+      else Serial.println(F("???"));
   }
-  else Serial.println("Error reading authentification");
+  else Serial.println(F("Error reading authentification"));
+  
   if (CONFIG::read_byte(EP_SSID_VISIBLE, &bbuf ))
   {
-	  Serial.print("SSID visibility: ");
-	  if (bbuf==0)Serial.println("Hidden");
-	  else if (bbuf==1)Serial.println("Visible");
+      Serial.print(F("SSID visibility: "));
+      if (bbuf==0) Serial.println(F("Hidden"));
+      else if (bbuf==1) Serial.println(F("Visible"));
 	  else Serial.println(bbuf);
       }
-  else Serial.println("Error reading SSID visibility");
+  else Serial.println(F("Error reading SSID visibility"));
+  
   if (CONFIG::read_buffer(EP_WEB_PORT,  (byte *)&ibuf , INTEGER_LENGTH))
   {
-	  Serial.print("Web port: ");
+      Serial.print(F("Web port: "));
 	  Serial.println(ibuf);
        }
-  else Serial.println("Error reading web port");
+  else Serial.println(F("Error reading web port"));
+  
   if (CONFIG::read_buffer(EP_DATA_PORT,  (byte *)&ibuf , INTEGER_LENGTH))
   {
-  Serial.print("Data port: ");
+      Serial.print(F("Data port: "));
 	  Serial.println(ibuf);
   }
-  else Serial.println("Error reading data port");
+  else Serial.println(F("Error reading data port"));
+  
   if (CONFIG::read_byte(EP_REFRESH_PAGE_TIME, &bbuf ))
   {
-	Serial.print("Web page refresh time: ");
+      Serial.print(F("Web page refresh time: "));
 	  Serial.println(byte(bbuf));
 	    }
-  else Serial.println("Error reading refesh page");
+  else Serial.println(F("Error reading refresh page"));
+  
   if (CONFIG::read_string(EP_HOSTNAME, sbuf , MAX_HOSTNAME_LENGTH))
   {
-	  Serial.print("Hostname : ");
+      Serial.print(F("Hostname: "));
 	  Serial.println(sbuf);
    }
-  else Serial.println("Error reading hostname");
+  else Serial.println(F("Error reading hostname"));
   
   if (CONFIG::read_buffer(EP_XY_FEEDRATE,  (byte *)&ibuf , INTEGER_LENGTH))
   {
-   Serial.print("XY feed rate: ");
+      Serial.print(F("XY feed rate: "));
    Serial.println(ibuf);
      }
-  else Serial.println("Error reading XY feed rate");
+  else Serial.println(F("Error reading XY feed rate"));
+  
   if (CONFIG::read_buffer(EP_Z_FEEDRATE,  (byte *)&ibuf , INTEGER_LENGTH))
   {
-	Serial.print("Z feed rate: ");
+      Serial.print(F("Z feed rate: "));
    Serial.println(ibuf);
   }
-  else Serial.println("Error reading Z feed rate");
+  else Serial.println(F("Error reading Z feed rate"));
+  
   if (CONFIG::read_buffer(EP_E_FEEDRATE,  (byte *)&ibuf , INTEGER_LENGTH))
   {
-   Serial.print("E feed rate: ");
+      Serial.print(F("E feed rate: "));
     Serial.println(ibuf);
       }
-  else Serial.println("Error reading E feed rate");
+  else Serial.println(F("Error reading E feed rate"));
   
-Serial.print("Captive portal : ");
+  Serial.print(F("Captive portal: "));
  #ifdef CAPTIVE_PORTAL_FEATURE
-    Serial.println("Enabled");
+  Serial.println(F("Enabled"));
  #else
-	Serial.println("Disabled");
+  Serial.println(F("Disabled"));
 #endif
-Serial.print("SSDP : ");
+  Serial.print(F("SSDP: "));
 #ifdef SSDP_FEATURE
-    Serial.println("Enabled");
+  Serial.println(F("Enabled"));
  #else
-	Serial.println("Disabled");
+  Serial.println(F("Disabled"));
 #endif
-Serial.print("mDNS : ");
+  Serial.print(F("mDNS: "));
 #ifdef MDNS_FEATURE
-    Serial.println("Enabled");
+  Serial.println(F("Enabled"));
  #else
-	Serial.println("Disabled");
+  Serial.println(F("Disabled"));
 #endif
 } 
diff --git a/esp8266/config.h b/esp8266/config.h
index 678965dd..8904b0db 100644
--- a/esp8266/config.h
+++ b/esp8266/config.h
@@ -20,7 +20,7 @@
 
 //comment to disable
 //MDNS_FEATURE: this feature allow  type the name defined
-//in web browser by default : http:\\esp8266.local and connect 
+//in web browser by default: http:\\esp8266.local and connect 
 #define MDNS_FEATURE
 
 //SSDD_FEATURE: this feature is a discovery protocol, supported on Windows out of the box