fix error calculating response pdu length for read coil/discrete input requests (#183)

dhoomakethu · web-flow · commit f2e17d014e55 · 2017-06-08T13:52:43.000+05:30
* Refactored and simplified calculation of RTU frames, added missing unit tests * - fixing a few small issues - bringing a few areas of coverage back up * adding installer test script * enabling the checksum tests in check frame, fixing tests * * Updating documentation * Adding code to handle messages that do not respond * Fixes issue 41 * cleaning up the build tools a bit * Adding more commands to the setup.py - pep8, lint, 2to3 Fixed a few pep8/lint bugs to test * moving files around * pep8 and cleanup * more cleanup * Fixes issue 47 * adding another quick example * cutting 200 pep8 errors * working on py3 merge * updating to python3 * reverting back changes, remember Switch flag next time * adding some magic methods, just cause * adding documentation pdf * Fixes issue 49 * Adds True and False constants for older python versions. Update issue 50 * adding tests for a few fixes * Fixes issue 51 * fixing tests broken by interface change * Updates issue 52 * Fixes issue 53 * Fix to add Python < 2.5 compatibility This fix simply removes all the ternaries that were added in Python 2.5. Fixes issue 50 * adding a mostly complete diagnostic register implementation * Adding more documentation and helpful factory methods. The documentation added was to address some questions with the synchronous and asynchrounous server implementations as well as the functionality of the data contexts. The factory methods were added by request to simplify the creation of a fully populated DataBlock address space. * adding modbus plus registers * adding endian ability to payload builder * Finishing the remaining modbus protocol * Adding the remaining portions of the protocol (request/response) * Tieing these into the factory decoder * Adding tests to cover the new code (need more) * Fixing a few bugs found along the way * finished file read/write record requests * documentation, more tests, fixing extra commands * adding more tests * Fixing the client/server async/sync implementations - asynchronous client/server for tcp working and tested - synchronous client/server for tcp/udp working and tested - adding tests to exercise the synchronous client/server - more documentation * adding test stubs to get full coverage count * working on jamod, need to set up more complete project * adding GetDeviceInformationRequest * adding read device information to decoder factory * fixing some example errors * working on the serial implementations * fixing the synchronous server implementation * updating functional tests and documentation for sync-serial * updating tac files * Updating the documentation for the serial client/servers * adding readme to root * Fixes issue 56 * Fixes issue 1 * adding a requirements file for virtualenv folk * adding more cohesive code to the payload utilities * forgot to add the new example to the doc index * Fixing the rtu size calculation isse #55 on google code * using the endian flag in register factory * fixing bad documentation * fixing issue 58 on google code * Fix binary framer and add start and end tokens Fixes a TypeError occuring while escaping token bytes in the message and adds the start and end tokens to the packet. * Adding checking in the client for an unconnected socket. * Fixing issue 60 on google code (including ez_setup) * fixing github issue #7 * adding tests and two utilities * adding message parser utility * Fixing extended message decoding * Now correctly decoding sub function messages (diagnostic) * Message parser now finished and documented * Fixed broken logger unit test * ModbusSparseDataBlock handled dictionaries incorrectly (they have an __iter__ attribute). Changed 'if' to 'elif' * Updating the Readme.rst to explain how to install in zero dependency mode. * Fixing issue #10 * updating the client documentation * updating the server context documentation * fixes #9 on github * fixing the factory decoding and adding examples * pushing to version 1.0 * Fixing a bug in the asynchronous client that slipped through. * complete tests for the sync client * cleaning up some pep8 errors * finished unit tests for async client * adding another test to the test-install script * finished covering sync client * updating documentation * adding another example, adding debug checks * Fixing the serial implementation of everything * updating lots of reference documentation * fixing the fifo semantics of serial clients * using transaction manager in async clients * fixing references * fixing incorrect rtu lenght calculation * Add optional server_address to Sync and Async TCP/UDP Server API * Improve erver_address defaults to passing None * adding a few messages * Adding a message encoding generator for testing. - fixed messages not passing **kwargs to base - fixed binary framer off by 1 - fixed mei_message rtu size tests - added a message generator to use with message parser - fixed message parser with ascii - tested message parser with all formats (added to messages) * adding documentation for message formats * updating documentation and being pedantic * Allowing overloading of message encoding * allow codes like payload builder to encode * added IPayloadBuilder interface (future) * renamed builder methods to reflect vision * added error code decoding to name * fixed affected tests * Cleaning up the build tools - moving custom datastores to examples - bumping required versions - making the debug server console optional - updating documentation * adding support for pydev * fixing broken nosetest (/dev/pts) and pydev issues * adding bcd payload builder * reworking contrib packages * adding bcd payload contrib * moving complex examples to contrib * syncing version on pypi * adding server rest api * moving web -> bottle * fixing documentation * adding gui base * adding initial manager page * adding data view * fixing error in example * adding the ability to override sync client framer * updating the performance test * fixing documentation * fixing memory leak in sync client * adding modicon encoder/decoder * Fix bogus calculation in ModbusSocketFramer.checkFrame (one of the tests also seemed wrong, I had to fix it) * Adding sunspec client example * Changing @staticmethod to @classmethod to fix inheritance * adding method to retrieve all the device blocks * adding the initial mapper interface * adding ideas in progress * adding a modbus datastore saver * making lrc/crc read stdin * adding the callback server example * adding a periodic updating example * fixing documentation * adding fix for stuck RTU streams * fixing documentation error * Adding an example for changing framers - new example changing-framers.py - added documentation link * Reworking the transaction managers to be explicit - Serial framers use the FIFO manager (results in order) - Socket framers use the Dict manager (tid -> result) - Fixed tests and removed bad global managers - Managers no longer use global state (now instance) * Bumping the version and adding a changelog * Fixing a logic error in client code - Now correctly choosing transaction manager * Fixing 2to3 common warnings * Fixed example typo in readme * Adding slave context delete ability - Fixes #20 * Fixing google code issue 69 - custom-message example had bugs - http://code.google.com/p/pymodbus/issues/detail?id=69 * Fixed docstring in synchronous serial client connect() method I think there was a copy/paste error in the docstring. It said tcp but I think it is supposed to be serial. * Fix for issue #21 * Allowing options to be passed through - This fixes issue #21 - Options now go to the transaction manager * Adding source_address to TCP client inputs * Typo * Typo * Typo * Typo * Adding some new examples * modbus scraper (and documentation) * thread safe datastore (and documentation) * Adding a concurrent client example * Allow specification of client connection handler in Modbus...Server o ModbusTcpServer and ModbusUdpServer allows handler class other than default Modbus{Connected,Disconnected}RequestHandler o Add debug logging on request failure, to help diagnose root causes * Fixes #46 * Fixes #48 * Adds the option to drop into zero mode for slaves * Fixes #42 * Bumping the version to 1.3.0 * add missing self operator The parameter values of the constructor within class WriteMultipleRegistersRequest can specified as single value or list of values. But if a single value is given the missing self operator on line 137 leads to crash in line 138 with error: TypeError("object of type 'int' has no len()",) * typo: fix spelling of Parameter Signed-off-by: Karl Palsson <karlp@remake.is> * async: missing slaves: add missing imports 1e0bcde is missing imports into the async server, the import was only added to the sync server. Further fix for #42 Signed-off-by: Karl Palsson <karlp@remake.is> * Fix zero_mode argument for ModbusSlaveContext Using "-" in the argument name causes SyntaxError 'non-keyword arg after keyword arg' * Fix typo in constants * Adding an example and adding tcp timeout * fixes #70 * Endianness now used in packing bytes * Adding a libmodbus wrapper * adding new contrib example of libmodbus client * updating example documentation so users can find it * closes #73 * Execute methods of Requests accept context There were errors whenever a request that got handles in other_message.py got it's execute method called, as it was being called with a context parameter. The functions now accept this parameter, although they don't do anything with it. The tests have also been updated. * Add Modbus RTU syncronous server example * Signal handlers to stop in shutdown(). * WriteMultipleRegistersRequest: Handle values=None case Currently, if None is passed in explicitly, or if values is not given, the 'values' object is correctly identified as *not* having an __iter__ attribute, but is incorrectly identified as being a valid register value. This breaks testInvalidWriteMultipleRegistersRequest. Solution: if we see None, replace this with [] and skip the check for __iter__. * Fix payload tests. Looking at the "encoded" string, it looks identical to that of the big endian encoding string, and my understanding is that the data shown in "encoded" *IS* big-endian, not little-endian. I have no idea how this passed before, but it passes now. * sync.ModbusUdpClient: Correct reference to settimeout. I could not find a 'settimeout' (case-insensitive) anywhere in the codebase other than on this line, but I *did* see it was a method of socket.socket. So I'll assume that this was *supposed* to be calling socket.socket.settimeout. * test-client-sync: Fix UDP connection test. Rather than passing in a vanilla object, we should pass in something that implements the settimeout method. * Lazily initialize InstallManagementConsole Simply importing the management console takes ~0.3 sec on an 1GHz Atom. Since it is (I suspect) often not used, lazily importing it should help startup for many programs. * Fixes the UDP client socket timeout bug fixes #51 * Implement mask_write_register method in client mixin * Workaround for bug 101 #101 * Workaround for bug 101 #101 * Riptide 1.3.0 pymodbus internal pre-release (riptide1) with dhoomakethu's fix for bashwork#101. * Riptide 1.3.0 pymodbus internal pre-release (riptide1) with dhoomakethu's fix for bashwork#101. * Use a PEP 404 compliant version. Start at rc93101 to usurp any other real release candidates. * Use a PEP 404 compliant version. Start at rc93101 to usurp any other real release candidates. * Document Riptide specific instructions. * Include Workaround for bug 101 bashwork#101 * Include Workaround for bug 101 bashwork#101 * Better tag names. * pymodbus fix for modes RTU error cases. * version bumped to c93103 * version bumped to c93103 * fixed issue with pymodbus timing over serial * fixed issue with pymodbus timing over serial * Add RIPTIDE.md to .gitignore * bump version to rc93105 * fix merge conflicts * fix version file * fix unit test failures * cleanup * #121 changelog updated * Misc update Add __maintainer__ field in setup.py * 1. #162, creating universal distribution for py2 and py3 2. Merge PR #152 , create compatible versions * fix test failures * fix ReadDeviceInformationRequest encoding probelm * #166 fix failing tests on python 3.5 * mis - Updated documentation * #167 updated documentation for CI * #167 disable pep8/flake checks for the time being * #167, fix install dependencies osx, remove pypy from supported python versions * #167, fix install dependencies osx, remove pypy from supported python versions * #167 , fix minior error in travis.yml * Bump version to 1.3.0rc2 * Fix #170 and other misc updates * Updated Documents * Add coverage.rc to show missing lines with coverage >4.0 * new documentation * #171 Minor bug fix in BinaryPayloadBuilder.add_string method for python3 * 1. #179 fix error calculating response pdu length for read coil/discrete input requests 2. #179 add tests * Enable debug logging for send packets
diff --git a/pymodbus/bit_read_message.py b/pymodbus/bit_read_message.py
@@ -15,6 +15,7 @@ class ReadBitsRequestBase(ModbusRequest):
     ''' Base class for Messages Requesting bit values '''
 
     _rtu_frame_size = 8
+
     def __init__(self, address, count, **kwargs):
         ''' Initializes the read request data
 
@@ -41,10 +42,15 @@ def decode(self, data):
     
     def get_response_pdu_size(self):
         """
-        Func_code (1 byte) + Byte Count(1 byte) + Quantity of Coils (n Bytes)
+        Func_code (1 byte) + Byte Count(1 byte) + Quantity of Coils (n Bytes)/8,
+        if the remainder is different of 0 then N = N+1
         :return: 
         """
-        return 1 + 1 + self.count
+        count = self.count//8
+        if self.count % 8:
+            count += 1
+
+        return 1 + 1 + count
     
     def __str__(self):
         ''' Returns a string representation of the instance
diff --git a/pymodbus/transaction.py b/pymodbus/transaction.py
@@ -88,7 +88,10 @@ def execute(self, request):
         while retries > 0:
             try:
                 self.client.connect()
-                self.client._send(self.client.framer.buildPacket(request))
+                packet = self.client.framer.buildPacket(request)
+                if _logger.isEnabledFor(logging.DEBUG):
+                    _logger.debug("send: " + " ".join([hex(byte2int(x)) for x in packet]))
+                self.client._send(packet)
                 result = self.client._recv(expected_response_length)
 
                 if not result and self.retry_on_empty:
diff --git a/test/test_bit_read_messages.py b/test/test_bit_read_messages.py
@@ -17,7 +17,8 @@
 from pymodbus.compat import iteritems
 
 from .modbus_mocks import MockContext
-
+res = [True] * 21
+res.extend([False] * 3)
 #---------------------------------------------------------------------------#
 # Fixture
 #---------------------------------------------------------------------------#
@@ -78,7 +79,7 @@ def testBitReadBaseRequests(self):
         ''' Test bit read request encoding '''
         messages = {
             ReadBitsRequestBase(12, 14)        : b'\x00\x0c\x00\x0e',
-            ReadBitsResponseBase([1,0,1,1,0])  : b'\x01\x0d',
+            ReadBitsResponseBase([1,0,1,1,0])  : b'\x01\x0d'
         }
         for request, expected in iteritems(messages):
             self.assertEqual(request.encode(), expected)
@@ -118,6 +119,20 @@ def testBitReadMessageExecuteSuccess(self):
             result = request.execute(context)
             self.assertEqual(result.bits, [True] * 5)
 
+    def testBitReadMessageGetResponsePDU(self):
+        requests = {
+            ReadCoilsRequest(1,5): 3,
+            ReadCoilsRequest(1, 8): 3,
+            ReadCoilsRequest(0, 16): 4,
+            ReadDiscreteInputsRequest(1, 21): 5,
+            ReadDiscreteInputsRequest(1, 24): 5,
+            ReadDiscreteInputsRequest(1, 1900): 240,
+        }
+        for request, expected in iteritems(requests):
+            pdu_len = request.get_response_pdu_size()
+            self.assertEqual(pdu_len, expected)
+
+
 #---------------------------------------------------------------------------#
 # Main
 #---------------------------------------------------------------------------#
diff --git a/test/test_bit_write_messages.py b/test/test_bit_write_messages.py
@@ -46,6 +46,14 @@ def testBitWriteBaseRequests(self):
         for request, expected in iteritems(messages):
             self.assertEqual(request.encode(), expected)
 
+    def testBitWriteMessageGetResponsePDU(self):
+        requests = {
+            WriteSingleCoilRequest(1, 0xabcd): 5
+        }
+        for request, expected in iteritems(requests):
+            pdu_len = request.get_response_pdu_size()
+            self.assertEqual(pdu_len, expected)
+
     def testWriteMultipleCoilsRequest(self):
         request = WriteMultipleCoilsRequest(1, [True]*5)
         request.decode(b'\x00\x01\x00\x05\x01\x1f')
