include current Configurable dev into Configurable before merging tone?

Boards.h

@@ -72,7 +72,7 @@ Firmata protocol and the actual pin numbers used by the Arduino
 functions.  Even though such mappings are often simple, pin
 numbers received by Firmata protocol should always be used as
 input to these macros, and the result of the macro should be
-used with with any Arduino function.
+used with any Arduino function.
 
 When Firmata is extended to support a new pin mode or feature,
 a pair of macros should be added and used for all hardware
@@ -144,6 +144,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_SERVO(p)         (IS_PIN_DIGITAL(p) && (p) - 2 < MAX_SERVOS)
 #define IS_PIN_I2C(p)           ((p) == 18 || (p) == 19)
 #define IS_PIN_SPI(p)           ((p) == SS || (p) == MOSI || (p) == MISO || (p) == SCK)
+#define IS_PIN_INTERRUPT(p)     ((p)==2 || (p)==3)
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        ((p) - 14)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -160,6 +161,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_SERVO(p)         ((p) >= 0 && (p) < MAX_SERVOS)
 #define IS_PIN_I2C(p)           ((p) == SDA || (p) == SCL)
 #define IS_PIN_SPI(p)           ((p) == SS || (p) == MOSI || (p) == MISO || (p) == SCK)
+#define IS_PIN_INTERRUPT(p)     0
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        ((p) - FIRST_ANALOG_PIN)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -176,6 +178,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_PWM(p)           digitalPinHasPWM(p)
 #define IS_PIN_SERVO(p)         (IS_PIN_DIGITAL(p) && (p) - 2 < MAX_SERVOS)
 #define IS_PIN_I2C(p)           ((p) == 18 || (p) == 19)
+#define IS_PIN_INTERRUPT(p)     ((p)==2 || (p)==3)
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        ((p) - 14)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -194,6 +197,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_SERVO(p)         ((p) >= 2 && (p) - 2 < MAX_SERVOS)
 #define IS_PIN_I2C(p)           ((p) == 20 || (p) == 21)
 #define IS_PIN_SPI(p)           ((p) == SS || (p) == MOSI || (p) == MISO || (p) == SCK)
+#define IS_PIN_INTERRUPT(p)     ((p)==2 || (p)==3 || (p)==18 || (p)==19 || (p)==20 || (p)==21)
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        ((p) - 54)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -210,6 +214,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #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 IS_PIN_INTERRUPT(p)     IS_PIN_DIGITAL(p) 
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        ((p) - 54)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -227,6 +232,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_SERVO(p)         ((p) >= 0 && (p) < MAX_SERVOS)
 #define IS_PIN_I2C(p)           (0)
 #define IS_PIN_SPI(p)           ((p) == SS || (p) == MOSI || (p) == MISO || (p) == SCK)
+#define IS_PIN_INTERRUPT(p)     ((p) == 0 || (p) == 1 || (p) == 2 ||(p) == 3 || (p) == 4 || (p) == 6 ||(p) == 7 ||(p) == 16)
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        (0)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -244,6 +250,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_SERVO(p)         ((p) >= 0 && (p) < MAX_SERVOS)
 #define IS_PIN_I2C(p)           ((p) == 5 || (p) == 6)
 #define IS_PIN_SPI(p)           ((p) == SS || (p) == MOSI || (p) == MISO || (p) == SCK)
+#define IS_PIN_INTERRUPT(p)     ((p) == 5 || (p) == 6 || (p) == 7 || (p) == 8)
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        (((p)<22)?21-(p):11)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -260,6 +267,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #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 IS_PIN_INTERRUPT(p)     IS_PIN_DIGITAL(p)
 #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)
@@ -277,6 +285,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_SERVO(p)         ((p) >= 0 && (p) < MAX_SERVOS)
 #define IS_PIN_I2C(p)           ((p) == 0 || (p) == 1)
 #define IS_PIN_SPI(p)           ((p) == SS || (p) == MOSI || (p) == MISO || (p) == SCK)
+#define IS_PIN_INTERRUPT(p)     ((p) == 0 || (p) == 1 || (p) == 2 ||(p) == 3 ||(p) == 18 ||(p) == 19 ||(p) == 36 ||(p) == 37)
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        ((p) - 38)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -294,6 +303,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_SERVO(p)         ((p) >= 0 && (p) < MAX_SERVOS)
 #define IS_PIN_I2C(p)           ((p) == 2 || (p) == 3)
 #define IS_PIN_SPI(p)           ((p) == SS || (p) == MOSI || (p) == MISO || (p) == SCK)
+#define IS_PIN_INTERRUPT(p)     ((p)==0 || (p)==1 || (p)==2 || (p)==3 || (p)==7)
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        (p) - 18
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -310,6 +320,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_PWM(p)           digitalPinHasPWM(p)
 #define IS_PIN_SERVO(p)         ((p) >= 0 && (p) < MAX_SERVOS)
 #define IS_PIN_I2C(p)           ((p) == 16 || (p) == 17)
+#define IS_PIN_INTERRUPT(p)     ((p)==2 || (p)==10 || (p)==11)
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        ((p) - 24)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -326,6 +337,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 #define IS_PIN_PWM(p)           digitalPinHasPWM(p)
 #define IS_PIN_SERVO(p)         ((p) >= 0 && (p) < MAX_SERVOS)
 #define IS_PIN_I2C(p)           ((p) == 4 || (p) == 5)
+#define IS_PIN_INTERRUPT(p)     (0)
 #define PIN_TO_DIGITAL(p)       (p)
 #define PIN_TO_ANALOG(p)        ((p) - 36)
 #define PIN_TO_PWM(p)           PIN_TO_DIGITAL(p)
@@ -339,7 +351,7 @@ writePort(port, value, bitmask):  Write an 8 bit port.
 
 // as long this is not defined for all boards:
 #ifndef IS_PIN_SPI
-#define IS_PIN_SPI(p)           0
+#define IS_PIN_SPI(p)           (0)
 #endif
 
 /*==============================================================================

examples/ConfigurableFirmata/ConfigurableFirmata.ino

@@ -105,13 +105,16 @@ FirmataExt firmataExt;
 #include <utility/FirmataScheduler.h>
 FirmataScheduler scheduler;
 
+#include <utility/EncoderFirmata.h>
+EncoderFirmata encoder;
+
 
 // dependencies. Do not comment out the following lines
 #if defined AnalogOutputFirmata_h || defined ServoFirmata_h
 #include <utility/AnalogWrite.h>
 #endif
 
-#if defined AnalogInputFirmata_h || defined I2CFirmata_h
+#if defined AnalogInputFirmata_h || defined I2CFirmata_h || defined EncoderFirmata_h
 #include <utility/FirmataReporting.h>
 FirmataReporting reporting;
 #endif
@@ -220,6 +223,9 @@ void setup()
 #ifdef FirmataScheduler_h
   firmataExt.addFeature(scheduler);
 #endif
+#ifdef EncoderFirmata_h
+  firmataExt.addFeature(encoder);
+#endif
 #endif
   /* systemResetCallback is declared here (in ConfigurableFirmata.ino) */
   Firmata.attach(SYSTEM_RESET, systemResetCallback);
@@ -289,6 +295,10 @@ runtasks: scheduler.runTasks();
 #ifdef I2CFirmata_h
     // report i2c data for all device with read continuous mode enabled
     i2c.report();
+#endif
+#ifdef EncoderFirmata_h
+    // report encoders positions if reporting enabled.
+    encoder.report();
 #endif
   }
 #endif

examples/SimpleEncoderFirmata/SimpleEncoderFirmata.ino

@@ -0,0 +1,160 @@
+/*
+ * Firmata is a generic protocol for communicating with microcontrollers
+ * from software on a host computer. It is intended to work with
+ * any host computer software package.
+ *
+ * To download a host software package, please click on the following link
+ * to open the download page in your default browser.
+ *
+ * http://firmata.org/wiki/Download
+ */
+
+/*
+  Copyright (C) 2006-2008 Hans-Christoph Steiner.  All rights reserved.
+  Copyright (C) 2010-2011 Paul Stoffregen.  All rights reserved.
+  Copyright (C) 2009 Shigeru Kobayashi.  All rights reserved.
+  Copyright (C) 2009-2013 Jeff Hoefs.  All rights reserved.
+  Copyright (C) 2013 Norbert Truchsess. All rights reserved.
+  Copyright (C) 2014 Nicolas Panel. 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
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  See file LICENSE.txt for further informations on licensing terms.
+
+  formatted using the GNU C formatting and indenting
+
+ * =====================================================
+ *  Encoder PROTOCOL
+ * =====================================================
+ *
+ *  Attach encoder query
+ * -----------------------------------------------------
+ * 0 START_SYSEX                (0xF0)
+ * 1 ENCODER_DATA               (0x61)
+ * 2 ENCODER_ATTACH             (0x00)
+ * 3 encoder #                  ([0 - MAX_ENCODERS-1])
+ * 4 pin A #                    (first pin) 
+ * 5 pin B #                    (second pin)
+ * 6 END_SYSEX                  (0xF7)
+ * -----------------------------------------------------
+ *  
+ *  Report encoder's position
+ * -----------------------------------------------------
+ * Sysex Query
+ * ------------------
+ * 0 START_SYSEX                (0xF0)
+ * 1 ENCODER_DATA               (0x61)
+ * 2 ENCODER_REPORT_POSITION    (0x01)
+ * 3 encoder #                  ([0 - MAX_ENCODERS-1])
+ * 4 END_SYSEX                  (0xF7)
+ *--------------------
+ * MIDI Response 
+ * ------------------
+ * 0 ENCODER_MESSAGE (0x80) | Channel (encoder #, 0-4)
+ * 1 direction (positive = 0, negative = 1)
+ * 2 current position, bits 0-6
+ * 3 current position, bits 7-13
+ * 4 current position, bits 14-20
+ * 5 current position, bits 21-27
+ * -----------------------------------------------------
+ * 
+ * Report all encoders positions
+ * -----------------------------------------------------
+ * Sysex Query
+ * ------------------
+ * 0 START_SYSEX                (0xF0)
+ * 1 ENCODER_DATA               (0x61)
+ * 2 ENCODER_REPORT_POSITIONS   (0x02)
+ * 3 END_SYSEX                  (0xF7)
+ *--------------------
+ * Sysex Response
+ * ------------------
+ * 0 START_SYSEX                (0xF0)
+ * 1 ENCODER_DATA               (0x61)
+ * 2 first encoder #            ([0 - MAX_ENCODERS-1])
+ * 3 first enc. dir.            (positive = 0, negative = 1)
+ * 4 first enc. position, bits 0-6
+ * 5 first enc. position, bits 7-13
+ * 6 first enc. position, bits 14-20
+ * 7 first enc. position, bits 21-27
+ * ...
+ * N END_SYSEX                  (0xF7)
+ * -----------------------------------------------------
+ *
+ * Reset encoder position to zero (Sysex Query)
+ * -----------------------------------------------------
+ * 0 START_SYSEX                (0xF0)
+ * 1 ENCODER_DATA               (0x61)
+ * 2 ENCODER_RESET_POSITION     (0x03)
+ * 3 encoder #                  ([0 - MAX_ENCODERS-1])
+ * 4 END_SYSEX                  (0xF7)
+ * -----------------------------------------------------
+ * 
+ * Enable/disable reporting (Sysex Query)
+ * -----------------------------------------------------
+ * 0 START_SYSEX                (0xF0)
+ * 1 ENCODER_DATA               (0x61)
+ * 2 ENCODER_REPORT_AUTO        (0x04)
+ * 3 enable                     (0x00 => false, true otherwise)
+ * 4 END_SYSEX                  (0xF7)
+ * -----------------------------------------------------
+ *
+ * Detach encoder (Sysex Query)
+ * -----------------------------------------------------
+ * 0 START_SYSEX                (0xF0)
+ * 1 ENCODER_DATA               (0x61)
+ * 2 ENCODER_DETACH             (0x05)
+ * 3 encoder #                  ([0 - MAX_ENCODERS-1])
+ * 4 END_SYSEX                  (0xF7)
+ *--------------------
+ */
+
+#include <Firmata.h>
+#include <utility/FirmataExt.h>
+#include <utility/FirmataReporting.h>
+#include <utility/EncoderFirmata.h>
+
+FirmataExt firmataExt;
+FirmataReporting reporting;
+EncoderFirmata encoder;
+
+/*==============================================================================
+ * FUNCTIONS
+ *============================================================================*/
+void systemResetCallback()
+{
+  firmataExt.reset();
+}
+
+/*==============================================================================
+ * SETUP()
+ *============================================================================*/
+void setup() 
+{
+  Firmata.setFirmwareVersion(FIRMATA_MAJOR_VERSION, FIRMATA_MINOR_VERSION);
+  firmataExt.addFeature(reporting);
+  firmataExt.addFeature(encoder);
+  /* systemResetCallback is declared here (in ConfigurableFirmata.ino) */
+  Firmata.attach(SYSTEM_RESET, systemResetCallback);
+  Firmata.begin(57600);
+  systemResetCallback();  // reset to default config
+}
+
+/*==============================================================================
+ * LOOP()
+ *============================================================================*/
+void loop() 
+{
+  /* STREAMREAD - processing incoming messagse as soon as possible, while still
+   * checking digital inputs.  */
+  while(Firmata.available()) {
+    Firmata.processInput();
+  }
+
+  if (reporting.elapsed()) {
+    encoder.report();
+  }
+}