Fix #461 - Udp client/server , Fix #401 - package license with source, #457 Fix typo's in docstrings, #455-Support float16

dhoomakethu · dhoomakethu · commit 3fb83cc1b42c · 2019-10-29T15:11:54.000+05:30
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,11 @@
+Version 2.3.0
+-----------------------------------------------------------
+* Support Modbus TLS (client / server)
+* Distribute license with source
+* BinaryPayloadDecoder/Encoder now supports float16 on python3.6 and above
+* Fix asyncio UDP client/server
+* Minor cosmetic updates
+
 Version 2.3.0rc1
 -----------------------------------------------------------
 * Asyncio Server implementation (Python 3.7 and above only)
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,4 @@
 include requirements.txt
 include README.rst
-include CHANGELOG.rst
+include CHANGELOG.rst
+include doc/LICENSE
diff --git a/examples/common/async_asyncio_client.py b/examples/common/async_asyncio_client.py
@@ -16,8 +16,8 @@
     # Import the required asynchronous client
     # ----------------------------------------------------------------------- #
     from pymodbus.client.asynchronous.tcp import AsyncModbusTCPClient as ModbusClient
-    # from pymodbus.client.asynchronous.udp import (
-    #     AsyncModbusUDPClient as ModbusClient)
+    from pymodbus.client.asynchronous.udp import (
+        AsyncModbusUDPClient as ModbusClient)
     from pymodbus.client.asynchronous import schedulers
 
 else:
@@ -141,6 +141,7 @@ def run_with_not_running_loop():
     log.debug("------------------------------------------------------")
     loop = asyncio.new_event_loop()
     assert not loop.is_running()
+    asyncio.set_event_loop(loop)
     new_loop, client = ModbusClient(schedulers.ASYNC_IO, port=5020, loop=loop)
     loop.run_until_complete(start_async_test(client.protocol))
     loop.close()
@@ -191,9 +192,12 @@ def run_with_no_loop():
     ModbusClient Factory creates a loop.
     :return:
     """
+    log.debug("---------------------RUN_WITH_NO_LOOP-----------------")
     loop, client = ModbusClient(schedulers.ASYNC_IO, port=5020)
     loop.run_until_complete(start_async_test(client.protocol))
     loop.close()
+    log.debug("--------DONE RUN_WITH_NO_LOOP-------------")
+    log.debug("")
 
 
 if __name__ == '__main__':
@@ -207,5 +211,5 @@ def run_with_no_loop():
 
     # Run with already running loop
     run_with_already_running_loop()
-    log.debug("---------------------RUN_WITH_NO_LOOP-----------------")
+
     log.debug("")
diff --git a/examples/common/asynchronous_server.py b/examples/common/asynchronous_server.py
@@ -108,7 +108,7 @@ def run_async_server():
     identity.VendorUrl = 'http://github.com/bashwork/pymodbus/'
     identity.ProductName = 'Pymodbus Server'
     identity.ModelName = 'Pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
     
     # ----------------------------------------------------------------------- # 
     # run the server you want
diff --git a/examples/common/asyncio_server.py b/examples/common/asyncio_server.py
@@ -11,6 +11,7 @@
 # --------------------------------------------------------------------------- #
 # import the various server implementations
 # --------------------------------------------------------------------------- #
+import asyncio
 from pymodbus.server.asyncio import StartTcpServer
 from pymodbus.server.asyncio import StartUdpServer
 from pymodbus.server.asyncio import StartSerialServer
@@ -105,15 +106,15 @@ async def run_server():
     identity.VendorUrl = 'http://github.com/riptideio/pymodbus/'
     identity.ProductName = 'Pymodbus Server'
     identity.ModelName = 'Pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
 
     # ----------------------------------------------------------------------- #
     # run the server you want
     # ----------------------------------------------------------------------- #
     # Tcp:
     # immediately start serving:
-    server = await StartTcpServer(context, identity=identity, address=("0.0.0.0", 5020),
-                                  allow_reuse_address=True)
+    # server = await StartTcpServer(context, identity=identity, address=("0.0.0.0", 5020),
+    #                               allow_reuse_address=True)
 
     # 	deferred start:
     # server = await StartTcpServer(context, identity=identity, address=("0.0.0.0", 5020),
@@ -122,19 +123,15 @@ async def run_server():
     # asyncio.get_event_loop().call_later(20, lambda : server.)
     # await server.serve_forever()
 
-
-
-
     # TCP with different framer
     # StartTcpServer(context, identity=identity,
     #                framer=ModbusRtuFramer, address=("0.0.0.0", 5020))
 
     # Udp:
-    # server = await StartUdpServer(context, identity=identity, address=("0.0.0.0", 5020),
-    # 							  allow_reuse_address=True, defer_start=True)
+    server = await StartUdpServer(context, identity=identity, address=("0.0.0.0", 5020),
+                                  allow_reuse_address=True, defer_start=True)
     #
-    # await server.serve_forever()
-
+    await server.serve_forever()
 
     # !!! SERIAL SERVER NOT IMPLEMENTED !!!
     # Ascii:
diff --git a/examples/common/callback_server.py b/examples/common/callback_server.py
@@ -132,7 +132,7 @@ def run_callback_server():
     identity.VendorUrl = 'http://github.com/bashwork/pymodbus/'
     identity.ProductName = 'pymodbus Server'
     identity.ModelName = 'pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
 
     # ----------------------------------------------------------------------- #
     # run the server you want
diff --git a/examples/common/custom_datablock.py b/examples/common/custom_datablock.py
@@ -68,7 +68,7 @@ def run_custom_db_server():
     identity.VendorUrl = 'http://github.com/bashwork/pymodbus/'
     identity.ProductName = 'pymodbus Server'
     identity.ModelName = 'pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
 
     # ----------------------------------------------------------------------- #
     # run the server you want
diff --git a/examples/common/custom_synchronous_server.py b/examples/common/custom_synchronous_server.py
@@ -101,7 +101,7 @@ def run_server():
     identity.VendorUrl = 'http://github.com/riptideio/pymodbus/'
     identity.ProductName = 'Pymodbus Server'
     identity.ModelName = 'Pymodbus Server'
-    identity.MajorMinorRevision = '2.1.0'
+    identity.MajorMinorRevision = '2.3.0'
 
     # ----------------------------------------------------------------------- #
     # run the server you want
diff --git a/examples/common/dbstore_update_server.py b/examples/common/dbstore_update_server.py
@@ -86,7 +86,7 @@ def run_dbstore_update_server():
     identity.VendorUrl = 'http://github.com/bashwork/pymodbus/'
     identity.ProductName = 'pymodbus Server'
     identity.ModelName = 'pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
 
     # ----------------------------------------------------------------------- #
     # run the server you want
diff --git a/examples/common/modbus_payload.py b/examples/common/modbus_payload.py
@@ -81,6 +81,8 @@ def run_binary_payload_ex():
     builder.add_16bit_uint(0x1234)
     builder.add_32bit_int(-0x1234)
     builder.add_32bit_uint(0x12345678)
+    builder.add_16bit_float(12.34)
+    builder.add_16bit_float(-12.34)
     builder.add_32bit_float(22.34)
     builder.add_32bit_float(-22.34)
     builder.add_64bit_int(-0xDEADBEEF)
@@ -144,6 +146,8 @@ def run_binary_payload_ex():
         ('16uint', decoder.decode_16bit_uint()),
         ('32int', decoder.decode_32bit_int()),
         ('32uint', decoder.decode_32bit_uint()),
+        ('16float', decoder.decode_16bit_float()),
+        ('16float2', decoder.decode_16bit_float()),
         ('32float', decoder.decode_32bit_float()),
         ('32float2', decoder.decode_32bit_float()),
         ('64int', decoder.decode_64bit_int()),
diff --git a/examples/common/modbus_payload_server.py b/examples/common/modbus_payload_server.py
@@ -78,7 +78,7 @@ def run_payload_server():
     identity.VendorUrl = 'http://github.com/bashwork/pymodbus/'
     identity.ProductName = 'Pymodbus Server'
     identity.ModelName = 'Pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
     # ----------------------------------------------------------------------- #
     # run the server you want
     # ----------------------------------------------------------------------- #
diff --git a/examples/common/synchronous_server.py b/examples/common/synchronous_server.py
@@ -106,7 +106,7 @@ def run_server():
     identity.VendorUrl = 'http://github.com/riptideio/pymodbus/'
     identity.ProductName = 'Pymodbus Server'
     identity.ModelName = 'Pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
 
     # ----------------------------------------------------------------------- #
     # run the server you want
diff --git a/examples/common/updating_server.py b/examples/common/updating_server.py
@@ -78,7 +78,7 @@ def run_updating_server():
     identity.VendorUrl = 'http://github.com/bashwork/pymodbus/'
     identity.ProductName = 'pymodbus Server'
     identity.ModelName = 'pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
     
     # ----------------------------------------------------------------------- # 
     # run the server you want
diff --git a/examples/contrib/deviceinfo_showcase_server.py b/examples/contrib/deviceinfo_showcase_server.py
@@ -55,7 +55,7 @@ def run_server():
     identity.VendorUrl = 'http://github.com/riptideio/pymodbus/'
     identity.ProductName = 'Pymodbus Server'
     identity.ModelName = 'Pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
 
     # ----------------------------------------------------------------------- #
     # Add an example which is long enough to force the ReadDeviceInformation
diff --git a/examples/gui/bottle/frontend.py b/examples/gui/bottle/frontend.py
@@ -277,7 +277,7 @@ def RunDebugModbusFrontend(server, port=8080):
     identity.VendorUrl   = 'http://github.com/bashwork/pymodbus/'
     identity.ProductName = 'Pymodbus Server'
     identity.ModelName   = 'Pymodbus Server'
-    identity.MajorMinorRevision = '2.2.0'
+    identity.MajorMinorRevision = '2.3.0'
 
     # ------------------------------------------------------------
     # initialize the datastore
diff --git a/pymodbus/client/asynchronous/asyncio/__init__.py b/pymodbus/client/asynchronous/asyncio/__init__.py
@@ -115,6 +115,9 @@ def connected(self):
         """
         return self._connected
 
+    def write_transport(self, packet):
+        return self.transport.write(packet)
+
     def execute(self, request, **kwargs):
         """
         Starts the producer to send the next request to
@@ -123,7 +126,7 @@ def execute(self, request, **kwargs):
         request.transaction_id = self.transaction.getNextTID()
         packet = self.framer.buildPacket(request)
         _logger.debug("send: " + " ".join([hex(byte2int(x)) for x in packet]))
-        self.transport.write(packet)
+        self.write_transport(packet)
         return self._buildResponse(request.transaction_id)
 
     def _dataReceived(self, data):
@@ -206,6 +209,9 @@ def __init__(self, host=None, port=0, **kwargs):
     def datagram_received(self, data, addr):
         self._dataReceived(data)
 
+    def write_transport(self, packet):
+        return self.transport.sendto(packet)
+
 
 class ReconnectingAsyncioModbusTcpClient(object):
     """
diff --git a/pymodbus/client/asynchronous/factory/udp.py b/pymodbus/client/asynchronous/factory/udp.py
@@ -69,7 +69,11 @@ def async_io_factory(host="127.0.0.1", port=Defaults.Port, framer=None,
     loop = kwargs.get("loop") or asyncio.get_event_loop()
     proto_cls = kwargs.get("proto_cls", None)
     cor = init_udp_client(proto_cls, loop, host, port)
-    client = loop.run_until_complete(asyncio.gather(cor))[0]
+    if not loop.is_running():
+        client = loop.run_until_complete(asyncio.gather(cor))[0]
+    else:
+        client = asyncio.run_coroutine_threadsafe(cor, loop=loop)
+        client = client.result()
     return loop, client
 
 
diff --git a/pymodbus/payload.py b/pymodbus/payload.py
@@ -14,7 +14,7 @@
 from pymodbus.utilities import unpack_bitstring
 from pymodbus.utilities import make_byte_string
 from pymodbus.exceptions import ParameterException
-from pymodbus.compat import unicode_string
+from pymodbus.compat import unicode_string, IS_PYTHON3, PYTHON_VERSION
 # --------------------------------------------------------------------------- #
 # Logging
 # --------------------------------------------------------------------------- #
@@ -25,6 +25,7 @@
 WC = {
     "b": 1,
     "h": 2,
+    "e": 2,
     "i": 4,
     "l": 4,
     "q": 8,
@@ -229,6 +230,18 @@ def add_64bit_int(self, value):
         p_string = self._pack_words(fstring, value)
         self._payload.append(p_string)
 
+    def add_16bit_float(self, value):
+        """ Adds a 16 bit float to the buffer
+
+        :param value: The value to add to the buffer
+        """
+        if IS_PYTHON3 and PYTHON_VERSION.minor >= 6:
+            fstring = 'e'
+            p_string = self._pack_words(fstring, value)
+            self._payload.append(p_string)
+        else:
+            _logger.warning("float16 only supported on python3.6 and above!!!")
+
     def add_32bit_float(self, value):
         """ Adds a 32 bit float to the buffer
 
@@ -443,6 +456,18 @@ def decode_64bit_int(self):
         handle = self._unpack_words(fstring, handle)
         return unpack("!"+fstring, handle)[0]
 
+    def decode_16bit_float(self):
+        """ Decodes a 16 bit float from the buffer
+        """
+        if IS_PYTHON3 and PYTHON_VERSION.minor >= 6:
+            self._pointer += 2
+            fstring = 'e'
+            handle = self._payload[self._pointer - 2:self._pointer]
+            handle = self._unpack_words(fstring, handle)
+            return unpack("!"+fstring, handle)[0]
+        else:
+            _logger.warning("float16 only supported on python3.6 and above!!!")
+
     def decode_32bit_float(self):
         """ Decodes a 32 bit float from the buffer
         """
diff --git a/pymodbus/pdu.py b/pymodbus/pdu.py
@@ -19,7 +19,7 @@
 # --------------------------------------------------------------------------- #
 class ModbusPDU(object):
     """
-    Base class for all Modbus mesages
+    Base class for all Modbus messages
 
     .. attribute:: transaction_id
 
diff --git a/pymodbus/repl/helper.py b/pymodbus/repl/helper.py
@@ -33,6 +33,7 @@
     'uint16': 'decode_16bit_uint',
     'uint32': 'decode_32bit_uint',
     'uint64': 'decode_64bit_int',
+    'float16': 'decode_16bit_float',
     'float32': 'decode_32bit_float',
     'float64': 'decode_64bit_float',
 }
diff --git a/pymodbus/transaction.py b/pymodbus/transaction.py
@@ -38,7 +38,7 @@
 # The Global Transaction Manager
 # --------------------------------------------------------------------------- #
 class ModbusTransactionManager(object):
-    """ Impelements a transaction for a manager
+    """ Implements a transaction for a manager
 
     The transaction protocol can be represented by the following pseudo code::
 
diff --git a/pymodbus/version.py b/pymodbus/version.py
@@ -41,7 +41,7 @@ def __str__(self):
         return '[%s, version %s]' % (self.package, self.short())
 
 
-version = Version('pymodbus', 2, 3, 0, "rc1")
+version = Version('pymodbus', 2, 3, 0)
 
 
 version.__name__ = 'pymodbus'  # fix epydoc error
