Merge pull request #295 from firmata/ethernet-updates

Ethernet updates

Author: soundanalogous

examples/StandardFirmataEthernet/StandardFirmataEthernet.ino

@@ -20,14 +20,14 @@
 
   See file LICENSE.txt for further informations on licensing terms.
 
-  Last updated by Jeff Hoefs: January 10th, 2016
+  Last updated by Jeff Hoefs: June 18th, 2016
 */
 
 /*
   README
 
-  StandardFirmataEthernet is a client implementation. You will need a Firmata client library with
-  a network transport that can act as a server in order to establish a connection between
+  StandardFirmataEthernet is a TCP client implementation. You will need a Firmata client library
+  with a network transport that can act as a TCP server in order to establish a connection between
   StandardFirmataEthernet and the Firmata client application.
 
   To use StandardFirmataEthernet you will need to have one of the following
@@ -58,9 +58,9 @@
 #include <Firmata.h>
 
 /*
- * 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 executing this sketch
- * until the Serial console is opened.
+ * 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
+ * executing this sketch until the Serial console is opened.
  */
 //#define SERIAL_DEBUG
 #include "utility/firmataDebug.h"
@@ -69,6 +69,17 @@
 #include "ethernetConfig.h"
 #include "utility/EthernetClientStream.h"
 
+/*
+ * Uncomment the following include to enable interfacing with Serial devices via hardware or
+ * software serial.
+ *
+ * DO NOT uncomment if you are running StandardFirmataEthernet on an Arduino Leonardo,
+ * Arduino Micro or other ATMega32u4-based board or you will not have enough Flash and RAM
+ * remaining to reliably run Firmata. Arduino Yun is okay because it doesn't import the Ethernet
+ * libraries.
+ */
+//#include "utility/SerialFirmata.h"
+
 #define I2C_WRITE                   B00000000
 #define I2C_READ                    B00001000
 #define I2C_READ_CONTINUOUSLY       B00010000
@@ -88,7 +99,6 @@
  * GLOBAL VARIABLES
  *============================================================================*/
 
-/* network */
 #if defined remote_ip && !defined remote_host
 #ifdef local_ip
 EthernetClientStream stream(client, local_ip, remote_ip, NULL, remote_port);
@@ -304,7 +314,8 @@ void setPinModeCallback(byte pin, int mode)
     }
   }
   if (IS_PIN_ANALOG(pin)) {
-    reportAnalogCallback(PIN_TO_ANALOG(pin), mode == PIN_MODE_ANALOG ? 1 : 0); // turn on/off reporting
+    // turn on/off reporting
+    reportAnalogCallback(PIN_TO_ANALOG(pin), mode == PIN_MODE_ANALOG ? 1 : 0);
   }
   if (IS_PIN_DIGITAL(pin)) {
     if (mode == INPUT || mode == PIN_MODE_PULLUP) {
@@ -801,10 +812,36 @@ void systemResetCallback()
   isResetting = false;
 }
 
-void setup()
+/*
+ * StandardFirmataEthernet communicates with Ethernet 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 ignorePins()
 {
-  DEBUG_BEGIN(9600);
+#ifdef IS_IGNORE_PIN
+  for (byte i = 0; i < TOTAL_PINS; i++) {
+    if (IS_IGNORE_PIN(i)) {
+      Firmata.setPinMode(i, PIN_MODE_IGNORE);
+    }
+  }
+#endif
 
+#ifdef WIZ5100_ETHERNET
+  // Arduino Ethernet and Arduino EthernetShield 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
+
+#endif // WIZ5100_ETHERNET
+}
+
+void initTransport()
+{
 #ifdef YUN_ETHERNET
   Bridge.begin();
 #else
@@ -816,9 +853,11 @@ void setup()
 #endif
 
   DEBUG_PRINTLN("connecting...");
+}
 
+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);
@@ -828,36 +867,22 @@ void setup()
   Firmata.attach(START_SYSEX, sysexCallback);
   Firmata.attach(SYSTEM_RESET, systemResetCallback);
 
-#ifdef WIZ5100_ETHERNET
-  // StandardFirmataEthernet communicates with Ethernet shields over SPI. Therefore all
-  // SPI pins must be set to IGNORE. Otherwise Firmata would break SPI communication.
-  // add Pin 10 and configure pin 53 as output if using a MEGA with an Ethernet shield.
-
-  for (byte i = 0; i < TOTAL_PINS; i++) {
-    if (IS_IGNORE_ETHERNET_SHIELD(i)
-  #if defined(__AVR_ATmega32U4__)
-        || 24 == i // On Leonardo, pin 24 maps to D4 and pin 28 maps to D10
-        || 28 == i
-  #endif
-       ) {
-      Firmata.setPinMode(i, PIN_MODE_IGNORE);
-    }
-  }
-
-  // Arduino Ethernet and Arduino EthernetShield 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;
-#endif // WIZ5100_ETHERNET
-
-#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
-  pinMode(PIN_TO_DIGITAL(53), OUTPUT); // configure hardware SS as output on MEGA
-#endif
+  ignorePins();
 
   // start up Network Firmata:
   Firmata.begin(stream);
   systemResetCallback();  // reset to default config
 }
 
+void setup()
+{
+  DEBUG_BEGIN(9600);
+
+  initTransport();
+
+  initFirmata();
+}
+
 /*==============================================================================
  * LOOP()
  *============================================================================*/

examples/StandardFirmataEthernet/ethernetConfig.h

@@ -3,8 +3,8 @@
  *
  * You must configure your particular hardware. Follow the steps below.
  *
- * Currently StandardFirmataEthernet is configured as a client. An option to
- * configure as a server may be added in the future.
+ * Currently StandardFirmataEthernet is configured as a TCP client. An
+ * option to configure as a server may be added in the future.
  *============================================================================*/
 
 // STEP 1 [REQUIRED]
@@ -35,6 +35,8 @@ EthernetClient client;
  *
  * On Yun there's no need to configure local_ip and mac address as this is automatically
  * configured on the linux-side of Yun.
+ *
+ * Note that it may take several seconds to establish a connection with the Yun.
  */
 //#define YUN_ETHERNET
 
@@ -44,24 +46,23 @@ EthernetClient client;
 YunClient client;
 #endif
 
-
-// STEP 2 [REQUIRED for all boards and shields]
+// STEP 2[REQUIRED for all boards and shields]
 // replace with IP of the server you want to connect to, comment out if using 'remote_host'
 #define remote_ip IPAddress(10, 0, 0, 3)
 // *** REMOTE HOST IS NOT YET WORKING ***
 // replace with hostname of server you want to connect to, comment out if using 'remote_ip'
 // #define remote_host "server.local"
 
-// STEP 3 [REQUIRED unless using Arduin Yun]
+// STEP 3 [REQUIRED]
 // Replace with the port that your server is listening on
 #define remote_port 3030
 
-// STEP 4 [REQUIRED unless using Arduino Yun OR if not using DHCP]
+// STEP 4 [REQUIRED unless using DHCP]
 // Replace with your board or ethernet shield's IP address
 // Comment out if you want to use DHCP
 #define local_ip IPAddress(10, 0, 0, 15)
 
-// STEP 5 [REQUIRED unless using Arduino Yun]
+// STEP 5 [REQUIRED]
 // replace with ethernet shield mac. Must be unique for your network
 const byte mac[] = {0x90, 0xA2, 0xDA, 0x00, 0x53, 0xE5};
 
@@ -81,5 +82,9 @@ const byte mac[] = {0x90, 0xA2, 0xDA, 0x00, 0x53, 0xE5};
  * PIN IGNORE MACROS (don't change anything here)
  *============================================================================*/
 
+#if defined(WIZ5100_ETHERNET)
+
 // ignore SPI pins, pin 10 (Ethernet SS) and pin 4 (SS for SD-Card on Ethernet shield)
-#define IS_IGNORE_ETHERNET_SHIELD(p) ((IS_PIN_SPI(p) || (p) == 4) || (p) == 10)
+#define IS_IGNORE_PIN(p) ((IS_PIN_SPI(p) || (p) == 4) || (p) == 10)
+
+#endif