merge upstream v3.3.0

README.md

@@ -25,7 +25,7 @@ Snapshot releases can be downloaded here
 # Dependencies
 
 * [jSerialComm](http://fazecast.github.io/jSerialComm/)
-The serial comms is handled by JSerialComm that includs native implementations for most platforms.
+The serial comms is handled by JSerialComm that includes native implementations for most platforms.
 * [slf4j](https://www.slf4j.org/)
 Logging facade to fit in with your application logging framework
 * JRE 1.8 (JRE 1.6 for v2.70 and lower)

RELEASE_NOTES.md

@@ -256,6 +256,8 @@ _(**NOT BACKWARDS COMPATIBLE**)_
 * Add support for providing an optional java.net proxy for. (#151)
 * Added support for testing serial comms on Mac/Linux
 
-## Version 3.2.2-openems.1
-* Add Deploy Workflow
-* Forward 'disablePortConfiguration'-setting from jSerialComm
+## Version 3.2.3
+* Failed to read response! CRC Error in received frame #153 - thanks thomas-hutterer-tik. (#153)
+* Expose disableRs485ModeControl from jSerialComm v2.11.4 thanks da-Kai (#160)
+
+**_Note: - from 3.3.0 onwards, the release notes will be maintained in commit and GitHub releases._**

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

pom.xml

@@ -8,7 +8,7 @@
     <artifactId>j2mod</artifactId>
     <name>j2mod</name>
     <url>https://github.com/OpenEMS/j2mod</url>
-    <version>3.2.2-openems.2</version>
+    <version>3.3.0-openems.1-SNAPSHOT</version>
     <description>A Modbus TCP/UDP/Serial Master and Slave implementation</description>
 
     <packaging>bundle</packaging>
@@ -23,7 +23,7 @@
             <name>Dieter Wimberger</name>
             <email>wimpi@user.sourceforge.com</email>
             <organization>SourceForge</organization>
-            <organizationUrl>http://jamod.sourceforge.net</organizationUrl>
+            <organizationUrl>https://jamod.sourceforge.net</organizationUrl>
             <roles>
                 <role>architect</role>
                 <role>developer</role>
@@ -34,17 +34,17 @@
             <name>John Charlton</name>
             <email>jdcharlton@user.sourceforge.com</email>
             <organization>SourceForge</organization>
-            <organizationUrl>http://jamod.sourceforge.net</organizationUrl>
+            <organizationUrl>https://jamod.sourceforge.net</organizationUrl>
             <roles>
                 <role>developer</role>
             </roles>
         </developer>
         <developer>
             <id>jhaugh</id>
             <name>Julie Haugh</name>
-            <email>http://www.ghgande.com</email>
+            <email>https://www.ghgande.com</email>
             <organization>greenHouse Gas and Electric</organization>
-            <organizationUrl>http://www.ghgande.com</organizationUrl>
+            <organizationUrl>https://www.ghgande.com</organizationUrl>
             <roles>
                 <role>developer</role>
             </roles>
@@ -54,7 +54,7 @@
             <name>Steve O'Hara</name>
             <email>steve.ohara@4ng.co.uk</email>
             <organization>4NG</organization>
-            <organizationUrl>http://www.4ng.co.uk</organizationUrl>
+            <organizationUrl>https://www.4ng.co.uk</organizationUrl>
             <roles>
                 <role>developer</role>
             </roles>
@@ -64,7 +64,7 @@
     <licenses>
         <license>
             <name>The Apache License, Version 2.0</name>
-            <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
+            <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
         </license>
     </licenses>
 
@@ -88,15 +88,14 @@
 
         <dependency>
             <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-log4j12</artifactId>
+            <artifactId>slf4j-reload4j</artifactId>
             <version>2.0.9</version>
-            <scope>test</scope>
         </dependency>
 
         <dependency>
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-core</artifactId>
-            <version>2.20.0</version>
+            <version>2.25.3</version>
             <scope>test</scope>
         </dependency>
 
@@ -252,7 +251,7 @@
             <plugin>
                 <groupId>org.sonatype.central</groupId>
                 <artifactId>central-publishing-maven-plugin</artifactId>
-                <version>0.7.0</version>
+                <version>0.9.0</version>
                 <extensions>true</extensions>
                 <configuration>
                     <publishingServerId>central</publishingServerId>

src/main/java/com/ghgande/j2mod/modbus/io/BytesOutputStream.java

@@ -70,6 +70,17 @@ public void reset() {
         count = 0;
     }
 
+    /**
+     * Resets this <tt>BytesInputStream</tt> using the given
+     * byte[] as new input buffer.
+     *
+     * @param data a byte array with data to be read.
+     */
+    public void reset(byte[] data) {
+        buf = data;
+        count = 0;
+    }
+
     @Override
     public void writeBoolean(boolean v) throws IOException {
         dataOutputStream.writeBoolean(v);

src/main/java/com/ghgande/j2mod/modbus/io/ModbusRTUTransport.java

@@ -321,7 +321,8 @@ protected ModbusRequest readRequestIn(AbstractModbusListener listener) throws Mo
                         int[] crc = ModbusUtil.calculateCRC(inBuffer, 0, dlength); // does not include CRC
                         if (ModbusUtil.unsignedByteToInt(inBuffer[dlength]) != crc[0] || ModbusUtil.unsignedByteToInt(inBuffer[dlength + 1]) != crc[1]) {
                             if (logger.isDebugEnabled()) {
-                                logger.debug("CRC should be {}, {}", Integer.toHexString(crc[0]), Integer.toHexString(crc[1]));
+                                logger.debug("CRC should be {}, {} inBuffer={}", Integer.toHexString(crc[0]), Integer.toHexString(crc[1]), 
+                                		ModbusUtil.toHex(inBuffer, 0, dlength + 2));
                             }
 
                             // Drain the input in case the frame was misread and more
@@ -380,6 +381,8 @@ protected ModbusRequest readRequestIn(AbstractModbusListener listener) throws Mo
                                 logger.debug("Read message not meant for us: {}", ModbusUtil.toHex(byteInputOutputStream.getBuffer(), 0, byteInputOutputStream.size()));
                             }
                         }
+                        // as the buffer might have been bumped due to more than 256 bytes input, we reset it to the original inBuffer
+                        byteInputOutputStream.reset(inBuffer);
                     }
                 }
             }

src/main/java/com/ghgande/j2mod/modbus/io/ModbusSerialTransport.java

@@ -637,7 +637,8 @@ int getInterFrameDelay() {
             return 1750;
         }
         else {
-            return Math.max(getCharInterval(Modbus.INTER_MESSAGE_GAP), Modbus.MINIMUM_TRANSMIT_DELAY);
+            long delay = Math.max(getCharIntervalMicro(Modbus.INTER_MESSAGE_GAP), Modbus.MINIMUM_TRANSMIT_DELAY * 1000L);
+            return delay > Integer.MAX_VALUE ? Integer.MAX_VALUE : (int) delay;
         }
     }
 
@@ -660,17 +661,6 @@ long getMaxCharDelay() {
      * Used for message timings.
      *
      * @param chars Number of characters
-     * @return char interval in milliseconds
-     */
-    int getCharInterval(double chars) {
-        return (int) (getCharIntervalMicro(chars) / 1000);
-    }
-
-    /**
-     * Calculates an interval based on a set number of characters.
-     * Used for message timings.
-     *
-     * @param chars Number of caracters
      * @return microseconds
      */
     long getCharIntervalMicro(double chars) {

src/main/java/com/ghgande/j2mod/modbus/msg/ReadFileRecordRequest.java

@@ -19,7 +19,6 @@
 import com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse.RecordResponse;
 import com.ghgande.j2mod.modbus.net.AbstractModbusListener;
 import com.ghgande.j2mod.modbus.procimg.*;
-import com.ghgande.j2mod.modbus.procimg.Record;
 
 import java.io.DataInput;
 import java.io.DataOutput;

src/main/java/com/ghgande/j2mod/modbus/msg/WriteFileRecordRequest.java

@@ -19,7 +19,6 @@
 import com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse.RecordResponse;
 import com.ghgande.j2mod.modbus.net.AbstractModbusListener;
 import com.ghgande.j2mod.modbus.procimg.*;
-import com.ghgande.j2mod.modbus.procimg.Record;
 
 import java.io.DataInput;
 import java.io.DataOutput;

src/main/java/com/ghgande/j2mod/modbus/net/TCPMasterConnection.java

@@ -322,6 +322,7 @@ public void setNetworkInterface(NetworkInterface networkInterface) {
 
     /**
      * Sets the <tt>Proxy</tt> that this socket uses. If null (the default), no proxy is used.
+     * @param proxy the proxy as <tt>Proxy</tt>.
      */
     public void setProxy(Proxy proxy) {
         if(socket != null && proxy != null) {

src/main/java/com/ghgande/j2mod/modbus/slave/ModbusSlaveFactory.java

@@ -197,6 +197,7 @@ public static synchronized void close() {
     /**
      * Returns the running slave listening on the given port
      *
+     * @param type Type of slave
      * @param port Port to check for running slave
      * @return Null or ModbusSlave
      */
@@ -207,6 +208,7 @@ public static synchronized ModbusSlave getSlave(ModbusSlaveType type, int port)
     /**
      * Returns the running slave listening on the given port
      *
+     * @param type Type of slave
      * @param port Port to check for running slave
      * @return Null or ModbusSlave
      */

src/main/java/com/ghgande/j2mod/modbus/util/SerialParameters.java

@@ -395,29 +395,6 @@ public void setDatabits(String databits) {
         }
     }
 
-    /**
-     * Disables RS-485 control signals management.
-     * <p>
-     * <i>Please note that this is only effective on Linux.</i>
-     * <p>
-     * This function forces RS-485 mode to stay untouched,
-     * regardless of the current setting of RS-485 mode.
-     * <p>
-     * This function is necessary for Linux drivers that don't handle TIOCGRS485 properly.
-     */
-    public void disableRs485Control() {
-        this.rs485DisableControl = true;
-    }
-
-    /**
-     * Returns whether RS-485 control signals management is disabled.
-     *
-     * @return true if RS-485 control signals management is disabled.
-     */
-    public boolean isRs485ControlDisabled() {
-        return this.rs485DisableControl;
-    }
-
     /**
      * Returns the number of data bits as <tt>String</tt>.
      *
@@ -924,6 +901,29 @@ public void setRs485DelayAfterTxMicroseconds(String microseconds) {
         setRs485DelayAfterTxMicroseconds(Integer.parseInt(microseconds));
     }
 
+    /**
+     * Disables RS-485 control signals management.
+     * <p>
+     * <i>Please note that this is only effective on Linux.</i>
+     * <p>
+     * This function forces RS-485 mode to stay untouched,
+     * regardless of the current setting of RS-485 mode.
+     * <p>
+     * This function is necessary for Linux drivers that don't handle TIOCGRS485 properly.
+     */
+    public void disableRs485Control() {
+        this.rs485DisableControl = true;
+    }
+
+    /**
+     * Returns whether RS-485 control signals management is disabled.
+     *
+     * @return true if RS-485 control signals management is disabled.
+     */
+    public boolean isRs485ControlDisabled() {
+        return this.rs485DisableControl;
+    }
+
     @Override
     public String toString() {
         return "SerialParameters{" +

src/test/java/com/ghgande/j2mod/modbus/TestModbusTCPMasterEquality.java

@@ -9,7 +9,6 @@
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.CoreMatchers.not;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.junit.Assert.*;
 
 /**
  * Testing class for {@link ModbusTCPMaster#equals} & {@link ModbusTCPMaster#hashCode} methods

src/test/java/com/ghgande/j2mod/modbus/cmd/TCPSlaveTest.java

@@ -16,7 +16,6 @@
 package com.ghgande.j2mod.modbus.cmd;
 
 import com.ghgande.j2mod.modbus.Modbus;
-import com.ghgande.j2mod.modbus.procimg.Record;
 import com.ghgande.j2mod.modbus.procimg.*;
 import com.ghgande.j2mod.modbus.slave.ModbusSlave;
 import com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory;

src/test/java/com/ghgande/j2mod/modbus/cmd/UDPSlaveTest.java

@@ -17,7 +17,6 @@
 
 import com.ghgande.j2mod.modbus.Modbus;
 import com.ghgande.j2mod.modbus.procimg.*;
-import com.ghgande.j2mod.modbus.procimg.Record;
 import com.ghgande.j2mod.modbus.slave.ModbusSlave;
 import com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory;
 import org.slf4j.Logger;

src/test/java/com/ghgande/j2mod/modbus/utils/AbstractTestModbus.java

@@ -16,7 +16,6 @@
 package com.ghgande.j2mod.modbus.utils;
 
 import com.ghgande.j2mod.modbus.procimg.*;
-import com.ghgande.j2mod.modbus.procimg.Record;
 import com.ghgande.j2mod.modbus.slave.ModbusSlave;
 import com.ghgande.j2mod.modbus.util.Observable;
 import com.ghgande.j2mod.modbus.util.Observer;