refactor setup function

- split wifi init and firmata init into separate functions
- add hostConnectionCallback

Author: soundanalogous

examples/StandardFirmataWiFi/StandardFirmataWiFi.ino

@@ -830,6 +830,28 @@ void systemResetCallback()
   isResetting = false;
 }
 
+/*
+ * Called when a TCP connection is either connected or disconnected.
+ * TODO - figure out why the callback is not being called when using ESP8266 as a TCP server and
+ * why only connect is called when using ESP8266 as a TCP client. In both cases the actual
+ * connection is working but not reported via the callback.
+ */
+void hostConnectionCallback(byte state)
+{
+  switch (state) {
+    case HOST_CONNECTION_CONNECTED:
+      DEBUG_PRINTLN( "TCP connection established" );
+      break;
+    case HOST_CONNECTION_DISCONNECTED:
+      DEBUG_PRINTLN( "TCP connection disconnected" );
+      break;
+  }
+}
+
+/*
+ * Print the status of the WiFi connection. This is the connection to the access point rather
+ * than the TCP connection.
+ */
 void printWifiStatus() {
   if ( WiFi.status() != WL_CONNECTED )
   {
@@ -855,16 +877,51 @@ void printWifiStatus() {
   }
 }
 
-void setup()
+/*
+ * StandardFirmataWiFi communicates with WiFi shields over SPI. Therefore all
+ * SPI pins must be set to IGNORE. Otherwise Firmata would break SPI communication.
+ * Additional pins may also need to be ignored depending on the particular board or
+ * shield in use.
+ */
+void ignoreWiFiPins()
 {
-  /*
-   * WIFI SETUP
-   */
-  DEBUG_BEGIN(9600);
+  for (byte i = 0; i < TOTAL_PINS; i++) {
+#if defined(ARDUINO_WIFI_SHIELD)
+    if (IS_IGNORE_WIFI_SHIELD(i)
+  #if defined(__AVR_ATmega32U4__)
+      || 24 == i // On Leonardo, pin 24 maps to D4 and pin 28 maps to D10
+      || 28 == i
+  #endif  //defined(__AVR_ATmega32U4__)
+       ) {
+// 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
+    if (false) {
+#else
+    if (false) {
+#endif
+      Firmata.setPinMode(i, PIN_MODE_IGNORE);
+    }
+  }
 
-  /*
-   * This statement will clarify how a connection is being made
-   */
+  //Set up controls for the Arduino WiFi Shield SS for the SD Card
+#ifdef ARDUINO_WIFI_SHIELD
+  // Arduino WiFi, Arduino WiFi Shield and Arduino Yun all have SD SS wired to D4
+  pinMode(PIN_TO_DIGITAL(4), OUTPUT);    // switch off SD card bypassing Firmata
+  digitalWrite(PIN_TO_DIGITAL(4), HIGH); // SS is active low;
+
+#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
+  pinMode(PIN_TO_DIGITAL(53), OUTPUT); // configure hardware SS as output on MEGA
+#endif  //defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
+
+#endif  //ARDUINO_WIFI_SHIELD
+}
+
+void initWiFi()
+{
+  // This statement will clarify how a connection is being made
   DEBUG_PRINT( "StandardFirmataWiFi will attempt a WiFi connection " );
 #if defined(WIFI_101)
   DEBUG_PRINTLN( "using the WiFi 101 library." );
@@ -877,9 +934,7 @@ void setup()
   //else should never happen here as error-checking in wifiConfig.h will catch this
 #endif  //defined(WIFI_101)
 
-  /*
-   * Configure WiFi IP Address
-   */
+  // Configure WiFi IP Address
 #ifdef STATIC_IP_ADDRESS
   DEBUG_PRINT( "Using static IP: " );
   DEBUG_PRINTLN( local_ip );
@@ -894,44 +949,39 @@ void setup()
   DEBUG_PRINTLN( "IP will be requested from DHCP ..." );
 #endif
 
-  /*
-   * Configure WiFi security and initiate WiFi connection
-   */
+  stream.attach(hostConnectionCallback);
+
+  // Configure WiFi security and initiate WiFi connection
 #if defined(WIFI_WEP_SECURITY)
-    DEBUG_PRINT( "Attempting to connect to WEP SSID: " );
-    DEBUG_PRINTLN(ssid);
+  DEBUG_PRINT( "Attempting to connect to WEP SSID: " );
+  DEBUG_PRINTLN(ssid);
   stream.begin(ssid, wep_index, wep_key);
 #elif defined(WIFI_WPA_SECURITY)
-    DEBUG_PRINT( "Attempting to connect to WPA SSID: " );
-    DEBUG_PRINTLN(ssid);
+  DEBUG_PRINT( "Attempting to connect to WPA SSID: " );
+  DEBUG_PRINTLN(ssid);
   stream.begin(ssid, wpa_passphrase);
 #else                          //OPEN network
-    DEBUG_PRINTLN( "Attempting to connect to open SSID: " );
-    DEBUG_PRINTLN(ssid);
+  DEBUG_PRINTLN( "Attempting to connect to open SSID: " );
+  DEBUG_PRINTLN(ssid);
   stream.begin(ssid);
 #endif //defined(WIFI_WEP_SECURITY)
   DEBUG_PRINTLN( "WiFi setup done" );
 
-  /*
-   * Wait for TCP connection to be established
-   */
-  while (!streamConnected && ++connectionAttempts <= MAX_CONN_ATTEMPTS) {
+  // Wait for connection to access point to be established. This is necessary for ESP8266
+  // or we won't have a connection state once printWiFiStatus() is called and the state
+  // will be reported as disconnected. We don't want to wait until the TCP connection is
+  // established before calling printWiFiStatus() because printing the IP address upon
+  // connection with the access point is useful when using DHCP
+  while (WiFi.status() != WL_CONNECTED && ++connectionAttempts <= MAX_CONN_ATTEMPTS) {
     delay(500);
     DEBUG_PRINT(".");
-    streamConnected = stream.maintain();
-  }
-  if (streamConnected) {
-    DEBUG_PRINTLN( "TCP connection established" );
-  } else {
-    DEBUG_PRINTLN( "failed to establish TCP connection" );
   }
   printWifiStatus();
+}
 
-  /*
-   * FIRMATA SETUP
-   */
+void initFirmata()
+{
   Firmata.setFirmwareVersion(FIRMATA_FIRMWARE_MAJOR_VERSION, FIRMATA_FIRMWARE_MINOR_VERSION);
-
   Firmata.attach(ANALOG_MESSAGE, analogWriteCallback);
   Firmata.attach(DIGITAL_MESSAGE, digitalWriteCallback);
   Firmata.attach(REPORT_ANALOG, reportAnalogCallback);
@@ -941,47 +991,20 @@ void setup()
   Firmata.attach(START_SYSEX, sysexCallback);
   Firmata.attach(SYSTEM_RESET, systemResetCallback);
 
-  // StandardFirmataWiFi communicates with WiFi shields over SPI. Therefore all
-  // SPI pins must be set to IGNORE. Otherwise Firmata would break SPI communication.
-  // Additional pins may also need to be ignored depending on the particular board or
-  // shield in use.
+  ignoreWiFiPins();
 
-  for (byte i = 0; i < TOTAL_PINS; i++) {
-#if defined(ARDUINO_WIFI_SHIELD)
-    if (IS_IGNORE_WIFI_SHIELD(i)
-  #if defined(__AVR_ATmega32U4__)
-        || 24 == i // On Leonardo, pin 24 maps to D4 and pin 28 maps to D10
-        || 28 == i
-  #endif  //defined(__AVR_ATmega32U4__)
-       ) {
-// 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
-    if (false) {
-#else
-    if (false) {
-#endif
-      Firmata.setPinMode(i, PIN_MODE_IGNORE);
-    }
-  }
-
-  //Set up controls for the Arduino WiFi Shield SS for the SD Card
-#ifdef ARDUINO_WIFI_SHIELD
-  // Arduino WiFi, Arduino WiFi Shield and Arduino Yun all have SD SS wired to D4
-  pinMode(PIN_TO_DIGITAL(4), OUTPUT);    // switch off SD card bypassing Firmata
-  digitalWrite(PIN_TO_DIGITAL(4), HIGH); // SS is active low;
+  // Initialize Firmata to use the WiFi stream object as the transport.
+  Firmata.begin(stream);
+  systemResetCallback();  // reset to default config
+}
 
-#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
-  pinMode(PIN_TO_DIGITAL(53), OUTPUT); // configure hardware SS as output on MEGA
-#endif  //defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
+void setup()
+{
+  DEBUG_BEGIN(9600);
 
-#endif  //ARDUINO_WIFI_SHIELD
+  initWiFi();
 
-  // start up Network Firmata:
-  Firmata.begin(stream);
-  systemResetCallback();  // reset to default config
+  initFirmata();
 }
 
 /*==============================================================================