WiFiStream variant integration

Author: jnsbyr

examples/StandardFirmataWiFi/StandardFirmataWiFi.ino

@@ -125,6 +125,16 @@ SerialFirmata serialFeature;
 #ifdef STATIC_IP_ADDRESS
 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;
 int wifiStatus = WL_IDLE_STATUS;
@@ -822,37 +832,37 @@ void systemResetCallback()
 }
 
 void printWifiStatus() {
-#if defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101)
+#if defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(ESP8266_WIFI)
   if ( WiFi.status() != WL_CONNECTED )
   {
     DEBUG_PRINT( "WiFi connection failed. Status value: " );
     DEBUG_PRINTLN( WiFi.status() );
   }
   else
-#endif    //defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101)
+#endif    //defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(ESP8266_WIFI)
   {
     // print the SSID of the network you're attached to:
     DEBUG_PRINT( "SSID: " );
 
-#if defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101)
+#if defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(ESP8266_WIFI)
     DEBUG_PRINTLN( WiFi.SSID() );
-#endif    //defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101)
+#endif    //defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(ESP8266_WIFI)
 
     // print your WiFi shield's IP address:
     DEBUG_PRINT( "IP Address: " );
 
-#if defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101)
+#if defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(ESP8266_WIFI)
     IPAddress ip = WiFi.localIP();
     DEBUG_PRINTLN( ip );
-#endif    //defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101)
+#endif    //defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(ESP8266_WIFI)
 
     // print the received signal strength:
     DEBUG_PRINT( "signal strength (RSSI): " );
 
-#if defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101)
+#if defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(ESP8266_WIFI)
     long rssi = WiFi.RSSI();
     DEBUG_PRINT( rssi );
-#endif    //defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101)
+#endif    //defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(ESP8266_WIFI)
 
     DEBUG_PRINTLN( " dBm" );
   }
@@ -873,6 +883,8 @@ void setup()
   DEBUG_PRINTLN( "using the WiFi 101 library." );
 #elif defined(ARDUINO_WIFI_SHIELD)
   DEBUG_PRINTLN( "using the legacy WiFi library." );
+#elif defined(ESP8266_WIFI)
+  DEBUG_PRINTLN( "using the ESP8266 WiFi library." );
 #elif defined(HUZZAH_WIFI)
   DEBUG_PRINTLN( "using the HUZZAH WiFi library." );
   //else should never happen here as error-checking in wifiConfig.h will catch this
@@ -886,7 +898,11 @@ void setup()
   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  
+  stream.config( local_ip , gateway, subnet );
+#else  
   stream.config( local_ip );
+#endif  
 #else
   DEBUG_PRINTLN( "IP will be requested from DHCP ..." );
 #endif

examples/StandardFirmataWiFi/wifiConfig.h

@@ -23,8 +23,9 @@
  */
 #define ARDUINO_WIFI_SHIELD
 
-//do not modify these next 4 lines
+//do not modify these next 5 lines
 #ifdef ARDUINO_WIFI_SHIELD
+#include <WiFi.h>
 #include "utility/WiFiStream.h"
 WiFiStream stream;
 #endif
@@ -44,46 +45,57 @@ WiFiStream stream;
  */
 //#define WIFI_101
 
-//do not modify these next 4 lines
+//do not modify these next 5 lines
 #ifdef WIFI_101
+#include <WiFi101.h>
 #include "utility/WiFi101Stream.h"
-WiFi101Stream stream;
+WiFiStream stream;
 #endif
 
 /*
- * OPTION C: Configure for HUZZAH
+ * OPTION C: Configure for ESP8266
+ *
+ * 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.
  *
- * HUZZAH is not yet supported, this will be added in a later revision to StandardFirmataWiFi
+ * 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'
  */
+//#define ESP8266_WIFI
 
-//------------------------------
-// TODO
-//------------------------------
-//#define HUZZAH_WIFI
+//do not modify these next 5 lines
+#ifdef ESP8266_WIFI
+#include <ESP8266WiFi.h>
+#include "utility/WiFiStream.h"
+WiFiStream stream;
+#endif
 
 /*
- * OPTION D: Configure for ESP6288
+ * OPTION D: Configure for HUZZAH
  *
- * ESP6288 is supported through its Arduino Core at
- * https://github.com/esp8266/Arduino/
+ * HUZZAH with CC3000 is not yet supported, this will be added in a later revision to StandardFirmataWiFi.
+ * For HUZZAH with ESP8266 use ESP8266_WIFI.
  */
 
-//#define ESP_WIFI
+//------------------------------
+// TODO
+//------------------------------
+//#define HUZZAH_WIFI
 
-//do not modify these next 4 lines
-#ifdef ESP_WIFI
-#include "utility/ESPWiFiStream.h"
-WiFiStream stream;
-#endif
 
 // STEP 2 [REQUIRED for all boards and shields]
 // 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 this 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
+// 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
 
 // 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
@@ -107,6 +119,7 @@ char ssid[] = "your_network_name";
 char wpa_passphrase[] = "your_wpa_passphrase";
 #endif  //WIFI_WPA_SECURITY
 
+
 /*
  * OPTION B: WEP
  *
@@ -140,11 +153,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(ESP_WIFI))  || (defined(ESP_WIFI) && defined(HUZZAH_WIFI)) || (defined(ESP_WIFI) && defined(ARDUINO_WIFI_SHIELD)))
+#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)))
 #error "you may not define more than one wifi device type in wifiConfig.h."
 #endif //WIFI device type check
 
-#if !(defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(HUZZAH_WIFI) || defined(ESP_WIFI))
+#if !(defined(ARDUINO_WIFI_SHIELD) || defined(WIFI_101) || defined(HUZZAH_WIFI) || defined(ESP8266_WIFI))
 #error "you must define a wifi device type in wifiConfig.h."
 #endif
 
@@ -156,6 +169,10 @@ char wep_key[] = "your_wep_key";
 #error "you must define a wifi security type in wifiConfig.h."
 #endif  //WIFI_* security define check
 
+#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 
+
 /*==============================================================================
  * PIN IGNORE MACROS (don't change anything here)
  *============================================================================*/

utility/WiFiStream.h

@@ -1,7 +1,7 @@
 /*
   WiFiStream.h
   An Arduino Stream that wraps an instance of a WiFi server. For use
-  with legacy Arduino WiFi shield and other boards and sheilds that
+  with legacy Arduino WiFi shield and other boards and shields that
   are compatible with the Arduino WiFi library.
 
   Copyright (C) 2015-2016 Jesse Frush. All rights reserved.
@@ -19,7 +19,6 @@
 
 #include <inttypes.h>
 #include <Stream.h>
-#include <WiFi.h>
 
 class WiFiStream : public Stream
 {
@@ -29,6 +28,8 @@ class WiFiStream : public Stream
 
   //configuration members
   IPAddress _local_ip;
+  IPAddress _gateway;
+  IPAddress _subnet;
   uint16_t _port = 0;
   uint8_t _key_idx = 0;               //WEP
   const char *_key = nullptr;         //WEP
@@ -59,19 +60,37 @@ class WiFiStream : public Stream
 public:
   WiFiStream() {};
 
+#ifndef ESP8266
   // allows another way to configure a static IP before begin is called
   inline void config(IPAddress local_ip)
   {
     _local_ip = local_ip;
     WiFi.config( local_ip );
   }
+#endif
+
+  // allows another way to configure a static IP before begin is called
+  inline void config(IPAddress local_ip, IPAddress gateway, IPAddress subnet)
+  {
+    _local_ip = local_ip;
+    _gateway = gateway;
+    _subnet = subnet;
+#ifdef ESP8266
+    WiFi.config( local_ip, gateway, subnet );
+#else
+    WiFi.config( local_ip, IPAddress(0, 0, 0, 0), gateway, subnet );
+#endif
+  }
 
   // get DCHP IP
   inline IPAddress localIP()
   {
     return WiFi.localIP();
   }
 
+  /**
+   * @return true if connected
+   */
   inline bool maintain()
   {
     if( connect_client() ) return true;
@@ -82,17 +101,23 @@ class WiFiStream : public Stream
     {
       if( _local_ip )
       {
+#ifdef ESP8266
+        WiFi.config( _local_ip, _gateway, _subnet );
+#else
         WiFi.config( _local_ip );
+#endif
       }
 
       if( _passphrase )
       {
         result = WiFi.begin( _ssid, _passphrase);
       }
+#ifndef ESP8266
       else if( _key_idx && _key )
       {
         result = WiFi.begin( _ssid, _key_idx, _key );
       }
+#endif
       else
       {
         result = WiFi.begin( _ssid );
@@ -124,6 +149,7 @@ class WiFiStream : public Stream
     return result;
   }
 
+#ifndef ESP8266
   //WEP-encrypted networks
   inline int begin(char *ssid, uint8_t key_idx, const char *key, uint16_t port)
   {
@@ -141,6 +167,7 @@ class WiFiStream : public Stream
     _server.begin();
     return result;
   }
+#endif
 
   //WPA-encrypted networks
   inline int begin(char *ssid, const char *passphrase, uint16_t port)
@@ -163,6 +190,7 @@ class WiFiStream : public Stream
  *           Connection functions without DHCP
  ******************************************************************************/
 
+#ifndef ESP8266
   //OPEN networks with static IP
   inline int begin(char *ssid, IPAddress local_ip, uint16_t port)
   {
@@ -219,6 +247,7 @@ class WiFiStream : public Stream
     _server.begin();
     return result;
   }
+#endif
 
 /******************************************************************************
  *             Stream implementations