wifi updates

- Consolidate WiFi stream classes into single class
- Remove unused WiFi stream classes
- Fix ESP8266 serial output (needed flush)
- Fix ESP8266 connection status issue
- Automatically include WiFi lib for MKR1000 and ESP8266
- Simplify config error checking
- Update instructions in wifiConfig.h
- Do not ignore MKR1000 pins

Author: soundanalogous

examples/StandardFirmataWiFi/StandardFirmataWiFi.ino

@@ -13,6 +13,7 @@
   Copyright (C) 2009 Shigeru Kobayashi.  All rights reserved.
   Copyright (C) 2009-2016 Jeff Hoefs.  All rights reserved.
   Copyright (C) 2015-2016 Jesse Frush. All rights reserved.
+  Copyright (C) 2016 Jens B. All rights reserved.
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
@@ -21,7 +22,7 @@
 
   See file LICENSE.txt for further informations on licensing terms.
 
-  Last updated by Jeff Hoefs: January 10th, 2016
+  Last updated by Jeff Hoefs: April 10th, 2016
 */
 
 /*
@@ -36,7 +37,7 @@
   - Arduino WiFi Shield (or clone)
   - Arduino WiFi Shield 101
   - Arduino MKR1000 board (built-in WiFi 101)
-  - Adafruit HUZZAH CC3000 WiFi Shield (support coming soon)
+  - ESP8266 WiFi board compatible with ESP8266 Arduino core
 
   Follow the instructions in the wifiConfig.h file (wifiConfig.h tab in Arduino IDE) to
   configure your particular hardware.
@@ -45,6 +46,8 @@
   - WiFi Shield 101 requires version 0.7.0 or higher of the WiFi101 library (available in Arduino
     1.6.8 or higher, or update the library via the Arduino Library Manager or clone from source:
     https://github.com/arduino-libraries/WiFi101)
+  - ESP8266 requires the Arduino ESP8266 core which can be obtained here:
+    https://github.com/esp8266/Arduino
 
   In order to use the WiFi Shield 101 with Firmata you will need a board with at least
   35k of Flash memory. This means you cannot use the WiFi Shield 101 with an Arduino Uno
@@ -74,11 +77,6 @@
 #include <Wire.h>
 #include <Firmata.h>
 
-// I dont understand either
-void disableI2CPins();
-void enableI2CPins();
-void reportAnalogCallback(byte analogPin, int value);
-
 /*
  * Uncomment the #define SERIAL_DEBUG line below to receive serial output messages relating to your
  * connection that may help in the event of connection issues. If defined, some boards may not begin
@@ -127,13 +125,9 @@ IPAddress local_ip(STATIC_IP_ADDRESS);
 #endif
 #ifdef SUBNET_MASK
 IPAddress subnet(SUBNET_MASK);
-#else
-IPAddress subnet(0,0,0,0);
 #endif
 #ifdef GATEWAY_IP_ADDRESS
 IPAddress gateway(GATEWAY_IP_ADDRESS);
-#else
-IPAddress gateway(0,0,0,0);
 #endif
 
 int wifiConnectionAttemptCounter = 0;
@@ -896,13 +890,13 @@ void setup()
 #ifdef STATIC_IP_ADDRESS
   DEBUG_PRINT( "Using static IP: " );
   DEBUG_PRINTLN( local_ip );
-  //you can also provide a static IP in the begin() functions, but this simplifies
-  //ifdef logic in this sketch due to support for all different encryption types.
-#ifdef ESP8266_WIFI  
+#ifdef ESP8266_WIFI
   stream.config( local_ip , gateway, subnet );
-#else  
+#else
+  // you can also provide a static IP in the begin() functions, but this simplifies
+  // ifdef logic in this sketch due to support for all different encryption types.
   stream.config( local_ip );
-#endif  
+#endif
 #else
   DEBUG_PRINTLN( "IP will be requested from DHCP ..." );
 #endif
@@ -968,7 +962,8 @@ void setup()
         || 28 == i
   #endif  //defined(__AVR_ATmega32U4__)
        ) {
-#elif defined (WIFI_101)
+// don't ignore pins when using Wi-Fi 101 library with the MKR1000
+#elif defined (WIFI_101) && !defined(ARDUINO_SAMD_MKR1000)
     if (IS_IGNORE_WIFI101_SHIELD(i)) {
 #elif defined (HUZZAH_WIFI)
     // TODO

examples/StandardFirmataWiFi/wifiConfig.h

@@ -3,53 +3,67 @@
  *
  * You must configure your particular hardware. Follow the steps below.
  *
- * Currently StandardFirmataWiFi is configured as a server. An option to
- * configure as a client may be added in the future.
+ * Currently StandardFirmataWiFi is configured as a Wi-Fi server. An option to
+ * configure as a Wi-Fi client will be added in the future.
  *============================================================================*/
 
 // STEP 1 [REQUIRED]
 // Uncomment / comment the appropriate set of includes for your hardware (OPTION A, B or C)
 // Option A is enabled by default.
 
 /*
- * OPTION A: Configure for Arduino WiFi shield
+ * OPTION A: Configure for Arduino MKR1000 or Arduino WiFi Shield 101
  *
- * This will configure StandardFirmataWiFi to use the original WiFi library (deprecated) provided
- * with the Arduino IDE. It is supported by the Arduino WiFi shield (a discontinued product) and
- * is compatible with 802.11 B/G networks.
+ * This will configure StandardFirmataWiFi to use the WiFi101 library, which works with the
+ * Arduino WiFi101 shield and devices that have the WiFi101 chip built in (such as the MKR1000).
+ * It is compatible with 802.11 B/G/N networks.
+ *
+ * If you are using the MKR1000 board, continue on to STEP 2. If you are using the WiFi 101 shield,
+ * follow the instructions below.
  *
- * To configure StandardFirmataWiFi to use the Arduino WiFi shield
- * leave the #define below uncommented.
+ * To enable for the WiFi 101 shield, uncomment the #define WIFI_101 below and verify the
+ * #define ARDUINO_WIFI_SHIELD is commented out for OPTION B.
+ *
+ * IMPORTANT: You must have the WiFI 101 library installed. To easily install this library, open
+ * the library manager via: Arduino IDE Menus: Sketch > Include Library > Manage Libraries > filter
+ * search for "WiFi101" > Select the result and click 'install'
  */
-#define ARDUINO_WIFI_SHIELD
+//#define WIFI_101
 
-//do not modify these next 5 lines
-#ifdef ARDUINO_WIFI_SHIELD
-#include <WiFi.h>
+//do not modify the following 10 lines
+#if defined(ARDUINO_SAMD_MKR1000) && !defined(WIFI_101)
+// automatically include if compiling for MRK1000
+#define WIFI_101
+#endif
+#ifdef WIFI_101
+#include <WiFi101.h>
 #include "utility/WiFiStream.h"
 WiFiStream stream;
+#define WIFI_LIB_INCLUDED
 #endif
 
 /*
- * OPTION B: Configure for WiFi 101
- *
- * This will configure StandardFirmataWiFi to use the WiFi101 library, which works with the Arduino WiFi101
- * shield and devices that have the WiFi101 chip built in (such as the MKR1000). It is compatible
- * with 802.11 B/G/N networks.
+ * OPTION B: Configure for legacy Arduino WiFi shield
  *
- * To enable, uncomment the #define WIFI_101 below and verify the #define values under
- * options A and C are commented out.
+ * This will configure StandardFirmataWiFi to use the original WiFi library (deprecated) provided
+ * with the Arduino IDE. It is supported by the Arduino WiFi shield (a discontinued product) and
+ * is compatible with 802.11 B/G networks.
  *
- * IMPORTANT: You must have the WiFI 101 library installed. To easily install this library, opent the library manager via:
- * Arduino IDE Menus: Sketch > Include Library > Manage Libraries > filter search for "WiFi101" > Select the result and click 'install'
+ * To configure StandardFirmataWiFi to use the legacy Arduino WiFi shield
+ * leave the #define below uncommented and ensure #define WIFI_101 is commented out for OPTION A.
  */
-//#define WIFI_101
+//#define ARDUINO_WIFI_SHIELD
 
-//do not modify these next 5 lines
-#ifdef WIFI_101
-#include <WiFi101.h>
-#include "utility/WiFi101Stream.h"
+//do not modify the following 10 lines
+#ifdef ARDUINO_WIFI_SHIELD
+#include <WiFi.h>
+#include "utility/WiFiStream.h"
 WiFiStream stream;
+  #ifdef WIFI_LIB_INCLUDED
+  #define MULTIPLE_WIFI_LIB_INCLUDES
+  #else
+  #define WIFI_LIB_INCLUDED
+  #endif
 #endif
 
 /*
@@ -58,25 +72,33 @@ WiFiStream stream;
  * This will configure StandardFirmataWiFi to use the ESP8266WiFi library for boards
  * with an ESP8266 chip. It is compatible with 802.11 B/G/N networks.
  *
- * To enable, uncomment the #define ESP8266_WIFI below and verify the #define values under
- * options A and B are commented out.
+ * The appropriate libraries are included automatically when compiling for the ESP8266 so
+ * continue on to STEP 2.
  *
- * IMPORTANT: You must have the esp8266 board support installed. To easily install this board, open the board manager via:
- * Arduino IDE Menus: Tools > Board > Manage Boards > filter search for "esp8266" > Select the result and click 'install'
+ * IMPORTANT: You must have the esp8266 board support installed. To easily install this board, open
+ * see the instructions here: https://github.com/esp8266/Arduino#installing-with-boards-manager.
  */
-//#define ESP8266_WIFI
-
-//do not modify these next 5 lines
+//do not modify the following 14 lines
+#ifdef ESP8266
+// automatically include if compiling for ESP8266
+#define ESP8266_WIFI
+#endif
 #ifdef ESP8266_WIFI
 #include <ESP8266WiFi.h>
 #include "utility/WiFiStream.h"
 WiFiStream stream;
+  #ifdef WIFI_LIB_INCLUDED
+  #define MULTIPLE_WIFI_LIB_INCLUDES
+  #else
+  #define WIFI_LIB_INCLUDED
+  #endif
 #endif
 
 /*
  * OPTION D: Configure for HUZZAH
  *
- * HUZZAH with CC3000 is not yet supported, this will be added in a later revision to StandardFirmataWiFi.
+ * HUZZAH with CC3000 is not yet supported, this will be added in a later revision to
+ * StandardFirmataWiFi.
  * For HUZZAH with ESP8266 use ESP8266_WIFI.
  */
 
@@ -90,28 +112,32 @@ WiFiStream stream;
 // replace this with your wireless network SSID
 char ssid[] = "your_network_name";
 
+
 // STEP 3 [OPTIONAL for all boards and shields]
-// if you want to use a static IP (v4) address, uncomment the line below. You can also change the IP.
-// if the first line is commented out, the WiFi shield will attempt to get an IP from the DHCP server
-#define STATIC_IP_ADDRESS  192,168,1,113
-#define SUBNET_MASK        255,255,255,0 // REQUIRED for ESP8266_WIFI, ignored for others
-#define GATEWAY_IP_ADDRESS 0,0,0,0       // REQUIRED for ESP8266_WIFI, ignored for others
+// If you want to use a static IP (v4) address, uncomment the line below. You can also change the IP.
+// If the first line is commented out, the WiFi shield will attempt to get an IP from the DHCP server.
+// If you are using a static IP with the ESP8266 then you must also uncomment the SUBNET and GATEWAY.
+//#define STATIC_IP_ADDRESS  192,168,1,113
+//#define SUBNET_MASK        255,255,255,0 // REQUIRED for ESP8266_WIFI, optional for others
+//#define GATEWAY_IP_ADDRESS 0,0,0,0       // REQUIRED for ESP8266_WIFI, optional for others
+
 
 // STEP 4 [REQUIRED for all boards and shields]
 // define your port number here, you will need this to open a TCP connection to your Arduino
 #define SERVER_PORT 3030
 
-// STEP 5 [REQUIRED for all boards and shields]
-// determine your network security type (OPTION A, B, or C). Option A is the most common, and the default.
 
+// STEP 5 [REQUIRED for all boards and shields]
+// determine your network security type (OPTION A, B, or C). Option A is the most common, and the
+// default.
 
 /*
  * OPTION A: WPA / WPA2
  *
  * WPA is the most common network security type. A passphrase is required to connect to this type.
  *
- * To enable, leave #define WIFI_WPA_SECURITY uncommented below, set your wpa_passphrase value appropriately,
- * and do not uncomment the #define values under options B and C
+ * To enable, leave #define WIFI_WPA_SECURITY uncommented below, set your wpa_passphrase value
+ * appropriately, and do not uncomment the #define values under options B and C
  */
 #define WIFI_WPA_SECURITY
 
@@ -123,11 +149,11 @@ char wpa_passphrase[] = "your_wpa_passphrase";
 /*
  * OPTION B: WEP
  *
- * WEP is a less common (and regarded as less safe) security type. A WEP key and its associated index are required
- * to connect to this type.
+ * WEP is a less common (and regarded as less safe) security type. A WEP key and its associated
+ * index are required to connect to this type.
  *
- * To enable, Uncomment the #define below, set your wep_index and wep_key values appropriately, and verify
- * the #define values under options A and C are commented out.
+ * To enable, Uncomment the #define below, set your wep_index and wep_key values appropriately,
+ * and verify the #define values under options A and C are commented out.
  */
 //#define WIFI_WEP_SECURITY
 
@@ -142,7 +168,8 @@ char wep_key[] = "your_wep_key";
 /*
  * OPTION C: Open network (no security)
  *
- * Open networks have no security, can be connected to by any device that knows the ssid, and are unsafe.
+ * Open networks have no security, can be connected to by any device that knows the ssid, and are
+ * unsafe.
  *
  * To enable, uncomment #define WIFI_NO_SECURITY below and verify the #define values
  * under options A and B are commented out.
@@ -153,11 +180,11 @@ char wep_key[] = "your_wep_key";
  * CONFIGURATION ERROR CHECK (don't change anything here)
  *============================================================================*/
 
-#if ((defined(ARDUINO_WIFI_SHIELD) && (defined(WIFI_101) || defined(HUZZAH_WIFI))) || (defined(WIFI_101) && defined(HUZZAH_WIFI))  || (defined(WIFI_101) && defined(ESP8266_WIFI))  || (defined(ESP8266_WIFI) && defined(HUZZAH_WIFI)) || (defined(ESP8266_WIFI) && defined(ARDUINO_WIFI_SHIELD)))
+#ifdef MULTIPLE_WIFI_LIB_INCLUDES
 #error "you may not define more than one wifi device type in wifiConfig.h."
-#endif //WIFI device type check
+#endif
 
-#if !(defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(HUZZAH_WIFI) || defined(ESP8266_WIFI))
+#ifndef WIFI_LIB_INCLUDED
 #error "you must define a wifi device type in wifiConfig.h."
 #endif
 
@@ -171,15 +198,15 @@ char wep_key[] = "your_wep_key";
 
 #if (defined(ESP8266_WIFI) && !(defined(WIFI_NO_SECURITY) || (defined(WIFI_WPA_SECURITY))))
 #error "you must choose between WIFI_NO_SECURITY and WIFI_WPA_SECURITY"
-#endif 
+#endif
 
 /*==============================================================================
  * PIN IGNORE MACROS (don't change anything here)
  *============================================================================*/
 
 // ignore SPI pins, pin 5 (reset WiFi101 shield), pin 7 (WiFi handshake) and pin 10 (WiFi SS)
 // also don't ignore SS pin if it's not pin 10
-// TODO - need to differentiate between Arduino WiFi1 101 Shield and Arduino MKR1000
+// Not needed for Arduino MKR1000.
 #define IS_IGNORE_WIFI101_SHIELD(p)  ((p) == 10 || (IS_PIN_SPI(p) && (p) != SS) || (p) == 5 || (p) == 7)
 
 // ignore SPI pins, pin 4 (SS for SD-Card on WiFi-shield), pin 7 (WiFi handshake) and pin 10 (WiFi SS)