Merge branch 'master' into win-report-firmware-fix

Author: soundanalogous

.gitignore

@@ -1 +1,2 @@
 .DS_Store
+release.sh

Boards.h

@@ -200,6 +200,22 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define PIN_TO_SERVO(p)         ((p) - 2)
 
 
+// Arduino DUE
+#elif defined(__SAM3X8E__)
+#define TOTAL_ANALOG_PINS       12
+#define TOTAL_PINS              66 // 54 digital + 12 analog
+#define VERSION_BLINK_PIN       13
+#define IS_PIN_DIGITAL(p)       ((p) >= 2 && (p) < TOTAL_PINS)
+#define IS_PIN_ANALOG(p)        ((p) >= 54 && (p) < TOTAL_PINS)
+#define IS_PIN_PWM(p)           digitalPinHasPWM(p)
+#define IS_PIN_SERVO(p)         ((p) >= 2 && (p) - 2 < MAX_SERVOS)
+#define IS_PIN_I2C(p)           ((p) == 20 || (p) == 21) // 70 71
+#define PIN_TO_DIGITAL(p)       (p)
+#define PIN_TO_ANALOG(p)        ((p) - 54)
+#define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
+#define PIN_TO_SERVO(p)         ((p) - 2)
+
+
 // Teensy 1.0
 #elif defined(__AVR_AT90USB162__)
 #define TOTAL_ANALOG_PINS       0
@@ -234,6 +250,22 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define PIN_TO_SERVO(p)         (p)
 
 
+// Teensy 3.0
+#elif defined(__MK20DX128__)
+#define TOTAL_ANALOG_PINS       14
+#define TOTAL_PINS              38 // 24 digital + 10 analog-digital + 4 analog
+#define VERSION_BLINK_PIN       13
+#define IS_PIN_DIGITAL(p)       ((p) >= 0 && (p) <= 34)
+#define IS_PIN_ANALOG(p)        (((p) >= 14 && (p) <= 23) || ((p) >= 34 && (p) <= 38))
+#define IS_PIN_PWM(p)           digitalPinHasPWM(p)
+#define IS_PIN_SERVO(p)         ((p) >= 0 && (p) < MAX_SERVOS)
+#define IS_PIN_I2C(p)           ((p) == 18 || (p) == 19)
+#define PIN_TO_DIGITAL(p)       (p)
+#define PIN_TO_ANALOG(p)        (((p)<=23)?(p)-14:(p)-24)
+#define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
+#define PIN_TO_SERVO(p)         (p) 
+
+
 // Teensy++ 1.0 and 2.0
 #elif defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__)
 #define TOTAL_ANALOG_PINS       8

Firmata.cpp

@@ -67,14 +67,18 @@ void FirmataClass::begin(void)
 void FirmataClass::begin(long speed)
 {
   Serial.begin(speed);
-  begin(Serial);
-  blinkVersion();  
+  FirmataSerial = &Serial;
+  blinkVersion();
+  printVersion();
+  printFirmwareVersion();
 }
 
 /* begin method for overriding default stream */
 void FirmataClass::begin(Stream &s)
 {
   FirmataSerial = &s;
+  // do not call blinkVersion() here because some hardware such as the
+  // Ethernet shield use pin 13
   printVersion();
   printFirmwareVersion();
 }

Firmata.h

@@ -21,7 +21,7 @@
  * installed firmware. */
 #define FIRMATA_MAJOR_VERSION   2 // for non-compatible changes
 #define FIRMATA_MINOR_VERSION   3 // for backwards compatible changes
-#define FIRMATA_BUGFIX_VERSION  4 // for bugfix releases
+#define FIRMATA_BUGFIX_VERSION  6 // for bugfix releases
 
 #define MAX_DATA_BYTES 32 // max number of data bytes in non-Sysex messages
 

readme.md

@@ -39,17 +39,19 @@ Most of the time you will be interacting with arduino with a client library on t
 * Flash/AS3
   * [http://funnel.cc]
   * [http://code.google.com/p/as3glue/]
+* PHP
+  * [https://bitbucket.org/ThomasWeinert/carica-firmata]
 
 Note: The above libraries may support various versions of the Firmata protocol and therefore may not support all features of the latest Firmata spec nor all arduino and arduino-compatible boards. Refer to the respective projects for details.
 
-##Updating Firmata in the Arduino IDE
+##Updating Firmata in the Arduino IDE (< Arduino 1.5)
 The version of firmata in the Arduino IDE contains an outdated version of Firmata. To update Firmata, clone the repo into the location of firmata in the arduino IDE or download the latest [tagged version](https://github.com/firmata/arduino/tags) (stable), rename the folder to "Firmata" and replace the existing Firmata folder in your Ardino application.
 
 **Mac OSX**:
 
-```
-rm -r /Applications/Arduino.app/Contents/Resources/Java/libraries/Firmata
-git clone [email protected]:firmata/arduino.git /Applications/Arduino.app/Contents/Resources/Java/libraries/Firmata
+```bash
+$ rm -r /Applications/Arduino.app/Contents/Resources/Java/libraries/Firmata
+$ git clone [email protected]:firmata/arduino.git /Applications/Arduino.app/Contents/Resources/Java/libraries/Firmata
 ```
 
 If you are downloading the latest tagged version of Firmata, rename it to "Firmata" and copy to /Applications/Arduino.app/Contents/Resources/Java/libraries/ overwriting the existing Firmata directory. Right-click (or conrol + click) on the Arduino application and choose "Show Package Contents" and navigate to the libraries directory.
@@ -58,20 +60,43 @@ If you are downloading the latest tagged version of Firmata, rename it to "Firma
 
 Using the Git Shell application installed with [GitHub for Windows](http://windows.github.com/) (set default shell in options to Git Bash) or other command line based git tool:
 
-```
-# update the path and arduino version as necessary
-rm -r c:/Program\ Files/arduino-1.x/libraries/Firmata
-git clone [email protected]:firmata/arduino.git c:/Program\ Files/arduino-1.x/libraries/Firmata
+update the path and arduino version as necessary
+```bash
+$ rm -r c:/Program\ Files/arduino-1.x/libraries/Firmata
+$ git clone [email protected]:firmata/arduino.git c:/Program\ Files/arduino-1.x/libraries/Firmata
 ```
 
 Note: If you use GitHub for Windows, you must clone the firmata/arduino repository using the Git Shell application as described above. You can use the Github for Windows GUI only after you have cloned the repository. Drag the Firmata file into the Github for Windows GUI to track it.
 
 **Linux**:
 
+update the path and arduino version as necessary
+```bash
+$ rm -r ~/arduino-1.x/libraries/Firmata
+$ git clone [email protected]:firmata/arduino.git ~/arduino-1.x/libraries/Firmata
+```
+
+##Updating Firmata in the Arduino IDE (>= Arduino 1.5.2)
+As of Arduino 1.5.2 and there are separate library directories for the sam and
+avr architectures. To update Firmata in Arduino 1.5.2 or higher, follow the 
+instructions above for pre Arduino 1.5 versions but update the path as follows:
+
+**Mac OSX**:
+```
+/Applications/Arduino.app/Contents/Resources/Java/hardware/arduino/avr/libraries/Firmata
+/Applications/Arduino.app/Contents/Resources/Java/hardware/arduino/sam/libraries/Firmata
+```
+
+**Windows**:
+```
+/Program\ Files/arduino-1.5.x/hardware/arduino/avr/libraries/Firmata
+/Program\ Files/arduino-1.5.x/hardware/arduino/sam/libraries/Firmata
+```
+
+**Linux**
 ```
-# update the path and arduino version as necessary
-rm -r ~/arduino-1.x/libraries/Firmata
-git clone [email protected]:firmata/arduino.git ~/arduino-1.x/libraries/Firmata
+~/arduino-1.5.x/hardware/arduino/avr/libraries/Firmata
+~/arduino-1.5.x/hardware/arduino/sam/libraries/Firmata
 ```
 
 <a name="contributing" />

test/readme.md

@@ -1,3 +1,7 @@
 #Testing Firmata
 
-TO DO: overview of firmata testing process.
+The Firmata test suite includes unit tests (see the unit directory). Integration
+tests may also be added at some point in the future.
+
+If you make changes to Firmata.cpp, run the tests in /test/unit/ to ensure
+that your changes have not produced any unexpected errors.

test/unit/firmata_test/firmata_test.ino

@@ -1,28 +1,26 @@
+/*
+ * To run this test suite, you must first install the ArduinoUnit library
+ * to your Arduino/libraries/ directory.
+ * You can get ArduinoUnit here: https://github.com/mmurdoch/arduinounit
+ * Download version 2.0 or greater.
+ */
+
 #include <ArduinoUnit.h>
 #include <Firmata.h>
 
-TestSuite suite;
-
 void setup()
 {
   Serial.begin(9600);
 }
 
 void loop()
 {
-  suite.run();
-}
-
-void assertStringsEqual(Test& __test__, const char* expected, const String& actual)
-{
-  size_t expectedLength = strlen(expected);
-  assertEquals(expectedLength, actual.length());
-  for (size_t i = 0; i < expectedLength; i++)
-  {
-    assertEquals(expected[i], actual[i]);
-  }
+  Test::run();
 }
 
+// Note: this test required adding a method (Firmata.unsetFirmwareVersion()) to 
+// Firmata.cpp solely for the purpose of running this test. The method has been 
+// removed from Firmata.cpp, but keeping the test here as a recored 
 // test(setFirmwareVersionDoesNotLeakMemory)
 // {
 //   Firmata.setFirmwareVersion(1, 0);
@@ -48,7 +46,7 @@ test(beginPrintsVersion)
     FIRMATA_MINOR_VERSION,
     0
   };
-  assertStringsEqual(__test__, expected, stream.bytesWritten());
+  assertEqual(expected, stream.bytesWritten());
 }
 
 void processMessage(const byte* message, size_t length)
@@ -84,7 +82,7 @@ test(processWriteDigital_0)
   byte message[] = { DIGITAL_MESSAGE, 0, 0 };
   processMessage(message, 3);
 
-  assertEquals(0, _digitalPortValue);
+  assertEqual(0, _digitalPortValue);
 }
 
 test(processWriteDigital_127)
@@ -95,7 +93,7 @@ test(processWriteDigital_127)
   byte message[] = { DIGITAL_MESSAGE, 127, 0 };
   processMessage(message, 3);
 
-  assertEquals(127, _digitalPortValue);
+  assertEqual(127, _digitalPortValue);
 }
 
 test(processWriteDigital_128)
@@ -106,7 +104,7 @@ test(processWriteDigital_128)
   byte message[] = { DIGITAL_MESSAGE, 0, 1 };
   processMessage(message, 3);
 
-  assertEquals(128, _digitalPortValue);
+  assertEqual(128, _digitalPortValue);
 }
 
 test(processWriteLargestDigitalValue)
@@ -118,7 +116,7 @@ test(processWriteLargestDigitalValue)
   processMessage(message, 3);
 
   // Maximum of 14 bits can be set (B0011111111111111)
-  assertEquals(0x3FFF, _digitalPortValue);
+  assertEqual(0x3FFF, _digitalPortValue);
 }
 
 test(defaultDigitalWritePortIsZero)
@@ -129,7 +127,7 @@ test(defaultDigitalWritePortIsZero)
   byte message[] = { DIGITAL_MESSAGE, 0, 0 };
   processMessage(message, 3);
 
-  assertEquals(0, _digitalPort);
+  assertEqual(0, _digitalPort);
 }
 
 test(specifiedDigitalWritePort)
@@ -140,6 +138,5 @@ test(specifiedDigitalWritePort)
   byte message[] = { DIGITAL_MESSAGE + 1, 0, 0 };
   processMessage(message, 3);
 
-  assertEquals(1, _digitalPort);
+  assertEqual(1, _digitalPort);
 }
-

test/unit/readme.md

@@ -1,4 +1,8 @@
 #Firmata Unit Tests
 
-TO DO: instructions on running unit tests and creating new tests for new
-features.
+Unit tests are written using the [ArduinoUnit](https://github.com/mmurdoch/arduinounit) library (version 2.0).
+
+Follow the instructions in the [ArduinoUnit readme](https://github.com/mmurdoch/arduinounit/blob/master/readme.md) to install the library.
+
+Compile and upload the test sketch as you would any other sketch. Then open the 
+Serial Monitor to view the test results.