Preparations for 2.3.5 release.

kurbatov · kurbatov · commit cfce1754a967 · 2017-06-08T03:08:01.000+03:00
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ Add the following dependency to `pom.xml` of your project:
 <dependency>
     <groupId>com.github.kurbatov</groupId>
     <artifactId>firmata4j</artifactId>
-    <version>2.3.4.1</version>
+    <version>2.3.5</version>
 </dependency>
 ```
 
@@ -33,13 +33,13 @@ IODevice device = new FirmataDevice("/dev/ttyUSB0"); // construct the Firmata de
 // and/or device.getPin(n).addEventListener(...);
 device.start(); // initiate communication to the device
 device.ensureInitializationIsDone(); // wait for initialization is done
-// do actual work here
+// sending commands to the board
 device.stop(); // stop communication to the device
 ```
 
-The "actual work" consists in sending commands to the board. Registered
-listeners process events of the device asynchronously. You can add and
-remove listeners along the way.
+Sending commands to the board may cause the device to emit different events.
+Registered listeners process events of the device asynchronously. You can add
+and remove listeners along the way.
 
 You can subscribe to events of the device or its pin.
 
diff --git a/pom.xml b/pom.xml
@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.github.kurbatov</groupId>
     <artifactId>firmata4j</artifactId>
-    <version>2.5.0-SNAPSHOT</version>
+    <version>2.3.5-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>firmata4j</name>
     <description>firmata4j is a client library of Firmata.</description>
@@ -46,7 +46,7 @@
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
-            <version>1.7.7</version>
+            <version>1.7.25</version>
         </dependency>
         
         <dependency>
@@ -59,7 +59,7 @@
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-simple</artifactId>
             <scope>test</scope>
-            <version>1.7.7</version>
+            <version>1.7.25</version>
         </dependency>
         
     </dependencies>
@@ -82,7 +82,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.1</version>
+                <version>3.6.1</version>
                 <configuration>
                     <source>1.7</source>
                     <target>1.7</target>
@@ -102,7 +102,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-release-plugin</artifactId>
-                <version>2.5</version>
+                <version>2.5.3</version>
                 <configuration>
                     <autoVersionSubmodules>true</autoVersionSubmodules>
                     <useReleaseProfile>false</useReleaseProfile>
@@ -121,7 +121,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-source-plugin</artifactId>
-                        <version>2.3</version>
+                        <version>3.0.1</version>
                         <executions>
                             <execution>
                                 <id>attach-sources</id>
@@ -134,7 +134,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-javadoc-plugin</artifactId>
-                        <version>2.9.1</version>
+                        <version>2.10.4</version>
                         <executions>
                             <execution>
                                 <id>attach-javadocs</id>
@@ -150,7 +150,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-gpg-plugin</artifactId>
-                        <version>1.5</version>
+                        <version>1.6</version>
                         <executions>
                             <execution>
                                 <id>sign-artifacts</id>
diff --git a/src/main/java/org/firmata4j/I2CEvent.java b/src/main/java/org/firmata4j/I2CEvent.java
@@ -65,8 +65,8 @@ public I2CDevice getDevice() {
         return device;
     }
 
-	@Override
-	public String toString() {
-		return "I2CEvent [device=" + device + ", register=0x" + Integer.toHexString(register) + ", data=" + Arrays.toString(data) + "]";
-	}
+    @Override
+    public String toString() {
+        return String.format("I2CEvent [device=%s, register=0x%02X, data=%s]", device, register, Arrays.toString(data));
+    }
 }
diff --git a/src/main/java/org/firmata4j/I2CExample.java b/src/main/java/org/firmata4j/I2CExample.java
@@ -65,7 +65,7 @@ public static void main(String[] args) throws IOException, InterruptedException
         try { // set look and feel
             UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
         } catch (ClassNotFoundException | InstantiationException | IllegalAccessException | UnsupportedLookAndFeelException ex) {
-            Logger.getLogger(Example.class.getName()).log(Level.SEVERE, "Cannot load system look and feel.", ex);
+            Logger.getLogger(I2CExample.class.getName()).log(Level.SEVERE, "Cannot load system look and feel.", ex);
         }
         // requesting a user to define the port name
         String port = requestPort();
diff --git a/src/main/java/org/firmata4j/IOEvent.java b/src/main/java/org/firmata4j/IOEvent.java
@@ -42,15 +42,12 @@ public class IOEvent {
      * @param device the device that originated the event
      */
     public IOEvent(IODevice device) {
-        this.device = device;
-        this.pin = null;
-        this.value = 0;
-        this.timestamp = System.currentTimeMillis();
+        this(device, System.currentTimeMillis());
     }
 
     /**
      * Constructs the event is relevant to {@link IODevice} as a whole.
-     * <br/>
+     *
      * This constructor allows setting the timestamp of event.
      * 
      * @param device the device that originated the event
@@ -69,15 +66,12 @@ public IOEvent(IODevice device, long timestamp) {
      * @param pin the pin that originated the event
      */
     public IOEvent(Pin pin) {
-        this.device = pin.getDevice();
-        this.pin = pin;
-        this.value = pin.getValue();
-        this.timestamp = System.currentTimeMillis();
+        this(pin, System.currentTimeMillis());
     }
     
     /**
      * Constructs the event is relevant to a particular {@link Pin}.
-     * <br/>
+     *
      * This constructor allows setting the timestamp of event.
      * 
      * @param pin the pin that originated the event
@@ -112,7 +106,7 @@ public Pin getPin() {
 
     /**
      * Returns the value the pin received.
-     * <br/>
+     *
      * If the event is not about pin, always returns 0.
      * 
      * @return the value the pin received
@@ -123,6 +117,7 @@ public long getValue() {
 
     /**
      * Returns the timestamp of the event.
+     *
      * @return timestamp of the event
      */
     public long getTimestamp() {
diff --git a/src/main/java/org/firmata4j/firmata/FirmataDevice.java b/src/main/java/org/firmata4j/firmata/FirmataDevice.java
@@ -23,25 +23,36 @@
  */
 package org.firmata4j.firmata;
 
-import static org.firmata4j.firmata.parser.FirmataToken.*;
-
 import java.io.IOException;
 import java.text.MessageFormat;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
 import java.util.concurrent.ArrayBlockingQueue;
 import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicInteger;
-
-import org.firmata4j.*;
+import jssc.SerialPort;
+import jssc.SerialPortEvent;
+import jssc.SerialPortEventListener;
+import jssc.SerialPortException;
+import org.firmata4j.I2CDevice;
+import org.firmata4j.IODevice;
+import org.firmata4j.IODeviceEventListener;
+import org.firmata4j.IOEvent;
+import org.firmata4j.Pin;
 import org.firmata4j.firmata.parser.FirmataToken;
 import org.firmata4j.firmata.parser.WaitingForMessageState;
 import org.firmata4j.fsm.Event;
 import org.firmata4j.fsm.FiniteStateMachine;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-
-import jssc.*;
+import static org.firmata4j.firmata.parser.FirmataToken.*;
 
 /**
  * Implements {@link IODevice} that is using Firmata protocol.
@@ -96,11 +107,6 @@ public void start() throws IOException {
              response.  If this REPORT_FIRMWARE request isn't sent,
              these boards will not automatically send this info.
 
-             Arduino boards that reboot on DTR will act like a board
-             that does not reboot, if DTR is not raised when the
-             port opens.  This program attempts to avoid raising
-             DTR on windows.  (is this possible on Linux and Mac OS-X?)
-
              Either way, when we hear the REPORT_FIRMWARE reply, we
              know the board is alive and ready to communicate.
              */
@@ -515,11 +521,9 @@ public void onEvent(Event event) {
         @Override
         public void run() {
             while (!Thread.interrupted()) {
-                try 
-                {
+                try {
                     process(queue.take());
-                    if (!isReady())
-                    {
+                    if (!isReady()) {
                         Thread.sleep(DELAY);
                     }
                 } catch (InterruptedException ex) {
diff --git a/src/main/java/org/firmata4j/firmata/FirmataI2CDevice.java b/src/main/java/org/firmata4j/firmata/FirmataI2CDevice.java
@@ -21,13 +21,14 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
-
 package org.firmata4j.firmata;
 
 import java.io.IOException;
-import java.util.*;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentSkipListSet;
 import java.util.concurrent.atomic.AtomicBoolean;
-
 import org.firmata4j.I2CDevice;
 import org.firmata4j.I2CEvent;
 import org.firmata4j.I2CListener;
@@ -39,17 +40,18 @@
  * @author Oleg Kurbatov &lt;o.v.kurbatov@gmail.com&gt;
  */
 public class FirmataI2CDevice implements I2CDevice {
-	public static final int REGISTER_NOT_SET = -1;
+
+    public static final int REGISTER_NOT_SET = -1;
 
     private final FirmataDevice masterDevice;
 
     private final byte address;
 
     private final AtomicBoolean receivingUpdates = new AtomicBoolean(false);
 
-    private final Map<Integer, I2CListener> callbacks = new HashMap<>();
+    private final Map<Integer, I2CListener> callbacks = new ConcurrentHashMap<>();
 
-    private final Set<I2CListener> subscribers = Collections.synchronizedSet(new HashSet<I2CListener>());
+    private final Set<I2CListener> subscribers = new ConcurrentSkipListSet<>();
 
     FirmataI2CDevice(FirmataDevice masterDevice, byte address) {
         this.masterDevice = masterDevice;
@@ -73,12 +75,12 @@ public void tell(byte... data) throws IOException {
 
     @Override
     public void ask(byte responseLength, I2CListener listener) throws IOException {
-    	ask(-1, responseLength, listener);
+        ask(REGISTER_NOT_SET, responseLength, listener);
     }
-    
+
     @Override
-	public void ask(int register, byte responseLength, I2CListener listener) throws IOException {
-        callbacks.put(Integer.valueOf(register), listener);
+    public void ask(int register, byte responseLength, I2CListener listener) throws IOException {
+        callbacks.put(register, listener);
         masterDevice.sendMessage(FirmataMessageFactory.i2cReadRequest(address, register, responseLength, false));
     }
 
@@ -106,29 +108,28 @@ public void stopReceivingUpdates() throws IOException {
         }
     }
 
-	/**
-	 * {@link FirmataDevice} calls this method when receives a message from I2C
-	 * device.
-	 * 
-	 * @param register The device register read from.
-	 * @param message actual data from I2C device
-	 */
+    /**
+     * {@link FirmataDevice} calls this method when receives a message from I2C
+     * device.
+     *
+     * @param register The device register read from.
+     * @param message actual data from I2C device
+     */
     void onReceive(int register, byte[] message) {
         I2CEvent evt = new I2CEvent(this, register, message);
-        I2CListener cb_listener = callbacks.get(Integer.valueOf(register));
-        if (cb_listener != null) {
-        	cb_listener.onReceive(evt);
-        } else {
-            Set<I2CListener> notificationSet = new HashSet<>(subscribers);
-            for (I2CListener listener : notificationSet) {
-                listener.onReceive(evt);
+        I2CListener listener = callbacks.remove(register);
+        if (listener == null) {
+            for (I2CListener subscriber : subscribers) {
+                subscriber.onReceive(evt);
             }
+        } else {
+            listener.onReceive(evt);
         }
     }
 
-	@Override
-	public String toString() {
-		return "FirmataI2CDevice [address=0x" + Integer.toHexString(address) + "]";
-	}
+    @Override
+    public String toString() {
+        return String.format("FirmataI2CDevice [address=0x%02X]", address);
+    }
 
 }
diff --git a/src/main/java/org/firmata4j/firmata/parser/ParsingI2CMessageState.java b/src/main/java/org/firmata4j/firmata/parser/ParsingI2CMessageState.java

Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,8 @@ public I2CDevice getDevice() {`
`65`	`65`	`return device;`
`66`	`66`	`}`
`67`	`67`
`68`		`- @Override`
`69`		`- public String toString() {`
`70`		`- return "I2CEvent [device=" + device + ", register=0x" + Integer.toHexString(register) + ", data=" + Arrays.toString(data) + "]";`
`71`		`- }`
	`68`	`+ @Override`
	`69`	`+ public String toString() {`
	`70`	`+ return String.format("I2CEvent [device=%s, register=0x%02X, data=%s]", device, register, Arrays.toString(data));`
	`71`	`+ }`
`72`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public static void main(String[] args) throws IOException, InterruptedException`
`65`	`65`	`try { // set look and feel`
`66`	`66`	`UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());`
`67`	`67`	`} catch (ClassNotFoundException \| InstantiationException \| IllegalAccessException \| UnsupportedLookAndFeelException ex) {`
`68`		`- Logger.getLogger(Example.class.getName()).log(Level.SEVERE, "Cannot load system look and feel.", ex);`
	`68`	`+ Logger.getLogger(I2CExample.class.getName()).log(Level.SEVERE, "Cannot load system look and feel.", ex);`
`69`	`69`	`}`
`70`	`70`	`// requesting a user to define the port name`
`71`	`71`	`String port = requestPort();`