ModbusProtocol add cmd_path to _start_server and fix receive bug

recieve is wrong !! use receive

Author: francozappa

examples/swat-s1/plc1.py

@@ -81,12 +81,12 @@ def main_loop(self):
 
             # TODO: use it when implement raw water tank
             # read from PLC2 (constant value)
-            fit201 = float(self.recieve(FIT201_2, PLC2_ADDR))
+            fit201 = float(self.receive(FIT201_2, PLC2_ADDR))
             print "DEBUG PLC1 - receive fit201: %f" % fit201
             self.send(FIT201_1, fit201, PLC1_ADDR)
 
             # # read from PLC3
-            lit301 = float(self.recieve(LIT301_3, PLC3_ADDR))
+            lit301 = float(self.receive(LIT301_3, PLC3_ADDR))
             print "DEBUG PLC1 - receive lit301: %f" % lit301
             self.send(LIT301_1, lit301, PLC1_ADDR)
 

examples/swat-s1/plc2.py

@@ -42,7 +42,7 @@ def main_loop(self):
             print "DEBUG PLC2 - get fit201: %f" % fit201
 
             self.send(FIT201_2, fit201, PLC2_ADDR)
-            # fit201 = self.recieve(FIT201_2, PLC2_ADDR)
+            # fit201 = self.receive(FIT201_2, PLC2_ADDR)
             # print "DEBUG PLC2 - receive fit201: ", fit201
 
             time.sleep(PLC_PERIOD_SEC)

examples/toy/plc1.py

@@ -42,7 +42,7 @@ def main_loop(self, sleep=0.5):
         count = 0
         END = 6e6
         while(True):
-            rec_s31 = self.recieve(SENSOR3_1, PLC1_ADDR)
+            rec_s31 = self.receive(SENSOR3_1, PLC1_ADDR)
             # print 'DEBUG: toy plc1 receive SENSOR3_1: ', rec_s31
             get_s32 = self.get(SENSOR3_2)
             print 'DEBUG: toy plc1 get SENSOR3_2: ', get_s32

minicps/devices.py

@@ -243,9 +243,9 @@ def send(self, what, value, address, **kwargs):
         if type(what) is not tuple:
             raise TypeError('Parameter must be a tuple.')
         else:
-            return self._protocol._send(what, value, address)
+            return self._protocol._send(what, value, address, **kwargs)
 
-    def recieve(self, what, address, **kwargs):
+    def receive(self, what, address, **kwargs):
         """Receive (read) a value from another network host.
 
         ``kwargs`` dict is used to pass extra key-value pair according to the
@@ -254,13 +254,13 @@ def recieve(self, what, address, **kwargs):
         :param tuple what: field[s] identifier[s]
         :param str address: ``ip[:port]``
 
-        :returns: recv value or ``TypeError`` if ``what`` is not a ``tuple``
+        :returns: received value or ``TypeError`` if ``what`` is not a ``tuple``
         """
 
         if type(what) is not tuple:
             raise TypeError('Parameter must be a tuple.')
         else:
-            return self._protocol._receive(what, address)
+            return self._protocol._receive(what, address, **kwargs)
 
 
 # TODO: rename pre_loop and main_loop?

minicps/protocols.py

@@ -63,7 +63,7 @@ def __init__(self, protocol):
 
         try:
             from minicps import __file__
-            self._minicps_path = __file__[:-12]
+            self._minicps_path = __file__[:-12]  # XXX: remove trailing chars
         except Exception as error:
             print 'ERROR Protocol __init__ set _minicps_path: ', error
 
@@ -518,22 +518,27 @@ def __init__(self, protocol):
             # TODO: implement it
 
 
+    # TODO: still not sure about the tags API
     @classmethod
-    def _start_server(cls, address, tags, cmd_path, mode=1):
+    def _start_server(cls, cmd_path, address='localhost:502',
+        tags=(20, 20, 20, 20), mode=1):
         """Start a pymodbus modbus server.
 
         The command used to start the server is generated by
         ``_start_server_cmd``.
 
-        Notice that the client has to manage the new process,
-        eg:kill it after use.
+        Consistency between modbus server key-values and state key-values has to
+        be guaranteed by the client.
 
-        :address: to serve
         :cmd_path: path to the script to start a server
+        :address: ip:port
         :tags: ordered tuple of ints representing the numbers of discrete
                inputs, coils, input registers, and holding registers to be init.
                Current pymodbus servers only support ModbusSequentialDataBlock.
         :mode: int greater than 1, typically set by the constructor
+
+        :returns: list of strings generated with shlex.split,
+                  passable to subprocess.Popen object
         """
 
         try:
@@ -546,25 +551,10 @@ def _start_server(cls, address, tags, cmd_path, mode=1):
             print 'ERROR modbus _start_server: ', error
 
 
-    # TODO: still not sure about the tags API
     @classmethod
     def _start_server_cmd(cls, cmd_path, address='localhost:502',
-        tags=(10, 10, 10, 10), mode=1):
-            # ('CO1', 1, 'CO'), ('HR1', 1, 'HR'))):
-        """Build a subprocess.Popen cmd string for pycomm server.
-
-        Consistency between modbus server key-values and state key-values has to
-        be guaranteed by the client.
-
-        :address: to serve
-        :cmd_path: path to the script to start a server
-        :tags: ordered tuple of ints representing the numbers of discrete
-               inputs, coils, input registers, and holding registers to be init.
-               Current pymodbus servers only support ModbusSequentialDataBlock.
-
-        :returns: list of strings generated with shlex.split,
-                  passable to subprocess.Popen object
-        """
+        tags=(20, 20, 20, 20), mode=1):
+        """Build a subprocess.Popen cmd string for pycomm server."""
 
         if sys.platform.startswith('linux'):
             SHELL = '/bin/bash -c '

scripts/pox/l2_pairs.py

@@ -283,7 +283,7 @@ def _handle_PacketIn(event):
 
         # define an action object to be appended to the actions list
         # the action tell the switch to use event.port as output port
-        # event.port was the port on which the switch recieved the packet
+        # event.port was the port on which the switch received the packet
         # that generates the PackeIn
         action = of.ofp_action_output(port=event.port)  # then forward packet to event.port
 
@@ -309,7 +309,7 @@ def _handle_PacketIn(event):
 
 def _handle_PortStatus(event):
     """
-    Controller recieve info from a datapath about
+    Controller received info from a datapath about
     port changes.
 
 
@@ -350,7 +350,7 @@ def launch(std_flood_port=True):
 
     Datapath mgmt can be programmed using event
     handling. Each event (in this case PacketIn)
-    triggers an handler that recieve an Event obj
+    triggers an handler that received an Event obj
     as argument. The Event obj contains a reference
     to the relevant Connection obj. Indeed the handler
     can use Event obj to retrieve information about

tests/devices_tests.py

@@ -13,7 +13,7 @@
 from nose.plugins.skip import SkipTest
 
 # NOTE: currently testing only set and get
-# TODO: find a way to test also send and recieve outside network emulaiton
+# TODO: find a way to test also send and received outside network emulaiton
 
 class TestDevice():
 

tests/protocols_tests.py

@@ -231,10 +231,16 @@ class TestModbusProtocol():
     else:
         raise OSError
 
+    from minicps import __file__ as minicps_path
+    minicps_path = minicps_path[:-12]
+    SERVER_CMD_PATH = sys.executable + ' ' + minicps_path + \
+            'pymodbus/servers.py '   # NOTE: ending whitespace
+
     def test_server_start_stop(self):
 
         try:
-            server = ModbusProtocol._start_server('localhost:502', self.TAGS)
+            server = ModbusProtocol._start_server(self.SERVER_CMD_PATH,
+                'localhost:502', self.TAGS)
             ModbusProtocol._stop_server(server)
 
         except Exception as error:
@@ -279,7 +285,7 @@ def test_send(self):
         OFFSET = 10
 
         try:
-            server = ModbusProtocol._start_server(ADDRESS, TAGS)
+            server = ModbusProtocol._start_server(self.SERVER_CMD_PATH, ADDRESS, TAGS)
             time.sleep(1.0)
 
             print('TEST: Write to holding registers')
@@ -313,7 +319,7 @@ def test_receive(self):
         OFFSET = 10
 
         try:
-            server = ModbusProtocol._start_server(ADDRESS, TAGS)
+            server = ModbusProtocol._start_server(self.SERVER_CMD_PATH, ADDRESS, TAGS)
             time.sleep(1.0)
 
             print('TEST: Read holding registers')
@@ -407,7 +413,7 @@ def test_receive_count(self):
         TAGS = (20, 20, 20, 20)
 
         try:
-            server = ModbusProtocol._start_server(ADDRESS, TAGS)
+            server = ModbusProtocol._start_server(self.SERVER_CMD_PATH, ADDRESS, TAGS)
             time.sleep(1.0)
 
             print('TEST: Read holding registers, count=3')
@@ -446,7 +452,7 @@ def test_client_server_count(self):
         TAGS = (50, 50, 50, 50)
 
         try:
-            server = ModbusProtocol._start_server(ADDRESS, TAGS)
+            server = ModbusProtocol._start_server(self.SERVER_CMD_PATH, ADDRESS, TAGS)
             time.sleep(1.0)
 
             print('TEST: Write and Read holding registers, offset=4, count=3')