Merge pull request #16 from gijzelaerr/cli_getset

implement client/server get/set so we can set TCP port

Author: gijzelaerr

.travis.yml

@@ -12,9 +12,9 @@ before_install:
 install:
   - python setup.py install
 script:
-  - sudo /home/travis/virtualenv/python2.7/bin/nosetests test/test_partner.py
-  - sudo /home/travis/virtualenv/python2.7/bin/nosetests test/test_server.py
-  - nohup sudo /home/travis/virtualenv/python2.7/bin/snap7-server.py &
+  - /home/travis/virtualenv/python2.7/bin/nosetests test/test_partner.py
+  - /home/travis/virtualenv/python2.7/bin/nosetests test/test_server.py
+  - nohup /home/travis/virtualenv/python2.7/bin/snap7-server.py &
   - nosetests test/test_client.py
 notifications:
   webhooks:

run_tests.sh

@@ -3,6 +3,6 @@
 export PYTHONPATH=.
 sudo nosetests test/test_partner.py
 sudo nosetests test/test_server.py
-sudo PYTHONPATH=. snap7/bin/snap7-server.py &
+PYTHONPATH=. snap7/bin/snap7-server.py &
 nosetests test/test_client.py
 

snap7/bin/snap7-server.py

@@ -7,16 +7,16 @@
 import logging
 import snap7
 
+tcpport = 1102
 
 def mainloop():
     server = snap7.server.Server()
     size = 100
     data = (snap7.types.wordlen_to_ctypes[snap7.types.S7WLByte] * size)()
     server.register_area(snap7.types.srvAreaDB, 1, data)
 
-    server.start()
+    server.start(tcpport=tcpport)
     while True:
-        #logger.info("server: %s cpu: %s users: %s" % server.get_status())
         while True:
             event = server.pick_event()
             if event:
@@ -26,31 +26,11 @@ def mainloop():
         time.sleep(1)
 
 
-def check_root():
-    """
-    check if uid of this process is root
-    """
-    import os
-    import platform
-
-    if platform.system() == 'Windows':
-        # We don't need root on Windows to use port 102
-        return True
-
-    if os.getuid() == 0:
-        return True
-
-
-root_msg = "it sucks, but you need to run this as root. The snap7 library is" \
-           " hardcoded run on port 102, which requires root privileges."
-
 if __name__ == '__main__':
     import sys
     if len(sys.argv) > 1:
         snap7.common.load_library(sys.argv[1])
     logging.basicConfig()
     logger = logging.getLogger()
     logger.setLevel(logging.INFO)
-    if not check_root():
-        logging.error(root_msg)
     mainloop()

snap7/client.py

@@ -6,8 +6,7 @@
 import logging
 
 import snap7
-from snap7.types import S7Object, buffer_type, buffer_size
-from snap7.types import wordlen_to_ctypes, BlocksList, areas
+from snap7.types import S7Object, buffer_type, buffer_size, BlocksList, param_types
 from snap7.common import check_error, load_library, ipv4
 from snap7.exceptions import Snap7Exception
 
@@ -55,17 +54,21 @@ def disconnect(self):
         return self.library.Cli_Disconnect(self.pointer)
 
     @error_wrap
-    def connect(self, address, rack, slot):
+    def connect(self, address, rack, slot, tcpport=102):
         """
         Connect to a S7 server.
 
         :param address: IP address of server
         :param rack: rack on server
         :param slot: slot on server.
         """
-        logger.info("connecting to %s rack %s slot %s" % (address, rack, slot))
+        logger.info("connecting to %s:%s rack %s slot %s" % (address, tcpport,
+                                                             rack, slot))
+
+        self.set_param(snap7.types.RemotePort, tcpport)
+
         return self.library.Cli_ConnectTo(self.pointer, c_char_p(address),
-                                  c_int(rack), c_int(slot))
+                                          c_int(rack), c_int(slot))
 
     def db_read(self, db_number, start, size):
         """This is a lean function of Cli_ReadArea() to read PLC DB.
@@ -423,3 +426,23 @@ def compress(self, time):
         :param time: Maximum time expected to complete the operation (ms).
         """
         return self.library.Cli_Compress(self.pointer, time)
+
+    @error_wrap
+    def set_param(self, number, value):
+        """Sets an internal Server object parameter.
+        """
+        logger.debug("setting param number %s to %s" % (number, value))
+        type_ = param_types[number]
+        return self.library.Cli_SetParam(self.pointer, number,
+                                         byref(type_(value)))
+
+    def get_param(self, number):
+        """Reads an internal Server object parameter.
+        """
+        logger.debug("retreiving param number %s" % number)
+        type_ = param_types[number]
+        value = type_()
+        code = self.library.Cli_GetParam(self.pointer, c_int(number),
+                                         byref(value))
+        check_error(code)
+        return value.value

snap7/server.py

@@ -4,8 +4,7 @@
 import ctypes
 import logging
 import re
-from snap7.types import S7Object, longword, SrvEvent, server_statuses, \
-    cpu_statuses
+import snap7.types
 from snap7.common import check_error, load_library, ipv4
 
 logger = logging.getLogger(__name__)
@@ -57,7 +56,7 @@ def create(self):
         """
         logger.info("creating server")
         self.library.Srv_Create.restype = ctypes.c_void_p
-        return S7Object(self.library.Srv_Create())
+        return snap7.types.S7Object(self.library.Srv_Create())
 
     @error_wrap
     def register_area(self, area_code, index, userdata):
@@ -78,7 +77,8 @@ def set_events_callback(self, call_back):
         """
         logger.info("setting event callback")
         CALLBACK = ctypes.CFUNCTYPE(None, ctypes.c_void_p,
-                                    ctypes.POINTER(SrvEvent), ctypes.c_int)
+                                    ctypes.POINTER(snap7.types.SrvEvent),
+                                    ctypes.c_int)
 
         def wrapper(usrptr, pevent, size):
             """
@@ -106,7 +106,8 @@ def set_read_events_callback(self, call_back):
         """
         logger.info("setting read event callback")
         CALLBACK = ctypes.CFUNCTYPE(None, ctypes.c_void_p,
-                                    ctypes.POINTER(SrvEvent), ctypes.c_int)
+                                    ctypes.POINTER(snap7.types.SrvEvent),
+                                    ctypes.c_int)
 
         def wrapper(usrptr, pevent, size):
             """
@@ -136,11 +137,14 @@ def log_callback(event):
         self.set_events_callback(log_callback)
 
     @error_wrap
-    def start(self):
+    def start(self, tcpport=102):
         """
         start the server.
         """
-        logger.info("starting server on 0.0.0.0:102")
+        if tcpport != 102:
+            logging.info("setting server TCP port to %s" % tcpport)
+            self.set_param(snap7.types.LocalPort, tcpport)
+        logger.info("starting server on 0.0.0.0:%s" % tcpport)
         return self.library.Srv_Start(self.pointer)
 
     @error_wrap
@@ -176,8 +180,8 @@ def get_status(self):
         logger.debug("status server %s cpu %s clients %s" %
                      (server_status.value, cpu_status.value,
                       clients_count.value))
-        return server_statuses[server_status.value], \
-               cpu_statuses[cpu_status.value], \
+        return snap7.types.server_statuses[server_status.value], \
+               snap7.types.cpu_statuses[cpu_status.value], \
                clients_count.value
 
     @error_wrap
@@ -202,10 +206,13 @@ def lock_area(self, code, index):
         return self.library.Srv_UnlockArea(self.pointer, code, index)
 
     @error_wrap
-    def start_to(self, ip):
+    def start_to(self, ip, tcpport=102):
         """
         start server on a specific interface.
         """
+        if tcpport != 102:
+            logging.info("setting server TCP port to %s" % tcpport)
+            self.set_param(snap7.types.LocalPort, tcpport)
         assert re.match(ipv4, ip), '%s is invalid ipv4' % ip
         logger.info("starting server to %s:102" % ip)
         return self.library.Srv_Start(self.pointer, ip)
@@ -229,15 +236,15 @@ def set_mask(self, kind, mask):
     def set_cpu_status(self, status):
         """Sets the Virtual CPU status.
         """
-        assert status in cpu_statuses, 'unknown cpu state %s' % status
+        assert status in snap7.types.cpu_statuses, 'unknown cpu state %s' % status
         logger.debug("setting cpu status to %s" % status)
         return self.library.Srv_SetCpuStatus(self.pointer, status)
 
     def pick_event(self):
         """Extracts an event (if available) from the Events queue.
         """
         logger.debug("checking event queue")
-        event = SrvEvent()
+        event = snap7.types.SrvEvent()
         ready = ctypes.c_int32()
         code = self.library.Srv_PickEvent(self.pointer, ctypes.byref(event),
                                           ctypes.byref(ready))
@@ -261,7 +268,7 @@ def get_mask(self, kind):
         """Reads the specified filter mask.
         """
         logger.debug("retrieving mask kind %s" % kind)
-        mask = longword()
+        mask = snap7.types.longword()
         code = self.library.Srv_GetMask(self.pointer, kind, ctypes.byref(mask))
         check_error(code)
         return mask

snap7/types.py

@@ -4,9 +4,6 @@
 import ctypes
 from snap7.common import ADict
 
-
-
-
 S7Object = ctypes.c_void_p
 buffer_size = 65536
 buffer_type = ctypes.c_ubyte * buffer_size
@@ -15,21 +12,39 @@
 longword = ctypes.c_uint32
 
 # // PARAMS LIST
-LocalPort       = 1
-RemotePort      = 2
-PingTimeout     = 3
-SendTimeout     = 4
-RecvTimeout     = 5
-WorkInterval    = 6
-SrcRef          = 7
-DstRef          = 8
-SrcTSap         = 9
-PDURequest      = 10
-MaxClients      = 11
-BSendTimeout    = 12
-BRecvTimeout    = 13
-RecoveryTime    = 14
-KeepAliveTime   = 15
+LocalPort = 1
+RemotePort = 2
+PingTimeout = 3
+SendTimeout = 4
+RecvTimeout = 5
+WorkInterval = 6
+SrcRef = 7
+DstRef = 8
+SrcTSap = 9
+PDURequest = 10
+MaxClients = 11
+BSendTimeout = 12
+BRecvTimeout = 13
+RecoveryTime = 14
+KeepAliveTime = 15
+
+param_types = ADict({
+    LocalPort: ctypes.c_uint16,
+    RemotePort: ctypes.c_uint16,
+    PingTimeout: ctypes.c_int32,
+    SendTimeout: ctypes.c_int32,
+    RecvTimeout: ctypes.c_int32,
+    WorkInterval: ctypes.c_int32,
+    SrcRef: ctypes.c_uint16,
+    DstRef: ctypes.c_uint16,
+    SrcTSap: ctypes.c_uint16,
+    PDURequest: ctypes.c_int32,
+    MaxClients: ctypes.c_int32,
+    BSendTimeout: ctypes.c_int32,
+    BRecvTimeout: ctypes.c_int32,
+    RecoveryTime: ctypes.c_uint32,
+    KeepAliveTime:  ctypes.c_uint32,
+})
 
 # mask types
 mkEvent = 0
@@ -147,5 +162,5 @@ class BlocksList(ctypes.Structure):
     def __str__(self):
         return "<block list count OB: %s FB: %s FC: %s SFB: %x SFC: %s DB: %s" \
                " SDB: %s>" % (self.OBCount, self.FBCount, self.FCCount,
-                             self.SFBCount, self.SFCCount, self.DBCount,
-                             self.SDBCount)
+                              self.SFBCount, self.SFCCount, self.DBCount,
+                              self.SDBCount)