Merge pull request #50 from sunspec/development

Development

Author: bobfox

scripts/__init__.py

@@ -0,0 +1,99 @@
+#!/usr/bin/env python3
+
+"""
+  Copyright (c) 2021, SunSpec Alliance
+  All Rights Reserved
+
+"""
+
+import sys
+import time
+import sunspec2.modbus.client as client
+import sunspec2.file.client as file_client
+from optparse import OptionParser
+
+"""
+  Original suns options:
+
+      -o: output mode for data (text, xml)
+      -x: export model description (slang, xml)
+      -t: transport type: tcp or rtu (default: tcp)
+      -a: modbus slave address (default: 1)
+      -i: ip address to use for modbus tcp (default: localhost)
+      -P: port number for modbus tcp (default: 502)
+      -p: serial port for modbus rtu (default: /dev/ttyUSB0)
+      -R: parity for modbus rtu: None, E (default: None)
+      -b: baud rate for modbus rtu (default: 9600)
+      -T: timeout, in seconds (can be fractional, such as 1.5; default: 2.0)
+      -r: number of retries attempted for each modbus read
+      -m: specify model file
+      -M: specify directory containing model files
+      -s: run as a test server
+      -I: logger id (for sunspec logger xml output)
+      -N: logger id namespace (for sunspec logger xml output, defaults to 'mac')
+      -l: limit number of registers requested in a single read (max is 125)
+      -c: check models for internal consistency then exit
+      -v: verbose level (up to -vvvv for most verbose)
+      -V: print current release number and exit
+"""
+
+if __name__ == "__main__":
+
+    usage = 'usage: %prog [options]'
+    parser = OptionParser(usage=usage)
+    parser.add_option('-t', metavar=' ',
+                      default='tcp',
+                      help='transport type: rtu, tcp, file [default: tcp]')
+    parser.add_option('-a', metavar=' ', type='int',
+                      default=1,
+                      help='modbus slave address [default: 1]')
+    parser.add_option('-i', metavar=' ',
+                      default='localhost',
+                      help='ip address to use for modbus tcp [default: localhost]')
+    parser.add_option('-P', metavar=' ', type='int',
+                      default=502,
+                      help='port number for modbus tcp [default: 502]')
+    parser.add_option('-p', metavar=' ',
+                      default='/dev/ttyUSB0',
+                      help='serial port for modbus rtu [default: /dev/ttyUSB0]')
+    parser.add_option('-b', metavar=' ',
+                      default=9600,
+                      help='baud rate for modbus rtu [default: 9600]')
+    parser.add_option('-R', metavar=' ',
+                      default=None,
+                      help='parity for modbus rtu: None, E [default: None]')
+    parser.add_option('-T', metavar=' ', type='float',
+                      default=2.0,
+                      help='timeout, in seconds (can be fractional, such as 1.5) [default: 2.0]')
+    parser.add_option('-m', metavar=' ',
+                      help='modbus map file')
+
+    options, args = parser.parse_args()
+
+    try:
+        if options.t == 'tcp':
+            sd = client.SunSpecModbusClientDeviceTCP(slave_id=options.a, ipaddr=options.i, ipport=options.P,
+                                                     timeout=options.T)
+        elif options.t == 'rtu':
+            sd = client.SunSpecModbusClientDeviceRTU(slave_id=options.a, name=options.p, baudrate=options.b,
+                                                     parity=options.R, timeout=options.T)
+        elif options.t == 'file':
+            sd = file_client.FileClientDevice(filename=options.m)
+        else:
+            print('Unknown -t option: %s' % (options.t))
+            sys.exit(1)
+
+    except client.SunSpecModbusClientError as e:
+        print('Error: %s' % e)
+        sys.exit(1)
+    except file_client.FileClientError as e:
+        print('Error: %s' % e)
+        sys.exit(1)
+
+    if sd is not None:
+        print( '\nTimestamp: %s' % (time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime())))
+
+        # read all models in the device
+        sd.scan()
+
+        print(sd.get_text())

scripts/suns.py

@@ -9,13 +9,14 @@
 
 setup(
     name='pysunspec2',
-    version='1.0.4',
+    version='1.0.5',
     description='Python SunSpec Tools',
     author='SunSpec Alliance',
     author_email='support@sunspec.org',
     url='https://sunspec.org/',
     packages=['sunspec2', 'sunspec2.modbus', 'sunspec2.file', 'sunspec2.tests'],
     package_data={'sunspec2.tests': ['test_data/*'], 'sunspec2': ['models/json/*']},
+    scripts=['scripts/suns.py'],
     python_requires='>=3.5',
     extras_require={
       'serial': ['pyserial'],

setup.py

@@ -5,11 +5,13 @@
 import sunspec2.mdef as mdef
 import sunspec2.smdx as smdx
 import sunspec2.mb as mb
+import time
 
 
 class ModelError(Exception):
     pass
 
+
 ACCESS_REGION_REGS = 123
 
 this_dir, this_filename = os.path.split(__file__)
@@ -313,6 +315,34 @@ def is_impl(self):
             impl = self.info.is_impl(self.value)
         return impl
 
+    def get_text(self, index=None, parent_index=None):
+        txt = ''
+        name = self.pdef['name']
+        val = self.value
+        units = self.pdef.get('units')
+        group_index = ''
+        length = ''
+        if index:
+            if parent_index:
+                group_index = f'{parent_index:02}'
+                group_index += ':' + f'{index:02}'
+                txt += '%6s' % (group_index + ':')
+            else:
+                group_index = f'{index:02}'
+                txt += '%6s' % (group_index + ':')
+        else:
+            txt += ' ' * 6
+
+        txt += name
+        length = 55 - len(name)
+        txt += '%*s' % (length, str(val))
+        if units:
+            txt += ' ' + units + '\n'
+        else:
+            txt += '\n'
+
+        return txt
+
 
 class Group(object):
     def __init__(self, gdef=None, model=None, model_offset=0, group_len=0, data=None, data_offset=0, group_class=None,
@@ -616,6 +646,24 @@ def set_mb(self, data=None, computed=False, dirty=None):
                         return None
         return int(offset/2)
 
+    def get_text(self, index=None, parent_index=None):
+        txt = ''
+        tmp_txt = ''
+        for p in self.points:
+            tmp_txt = self.points[p].get_text(index, parent_index)
+            if tmp_txt:
+                txt += tmp_txt
+        for g in self.groups:
+            if isinstance(self.groups[g], list):
+                for i in range(len(self.groups[g])):
+                    if index:
+                        txt += self.groups[g][i].get_text(i+1, parent_index=index)
+                    else:
+                        txt += self.groups[g][i].get_text(i+1)
+            else:
+                txt += self.groups[g].get_text(index)
+        return txt
+
 
 class Model(Group):
     def __init__(self, model_id=None, model_addr=0, model_len=0, model_def=None, data=None, group_class=Group):
@@ -689,6 +737,10 @@ def add_model(self, model):
 
         model.device = self
 
+    def delete_models(self):
+        self.models = {}
+        self.model_list = []
+
     def get_dict(self, computed=False):
         d = {'name': self.name, 'did': self.did, 'models': []}
         for m in self.model_list:
@@ -746,3 +798,13 @@ def _set_dict(self, data, computed=False, detail=False):
                     model_len = 0
                 model = Model(model_def=model_def, data=m, model_id=m['ID'], model_len=model_len)
                 self.add_model(model=model)
+
+    def get_text(self):
+        txt = 'Timestamp: %s\n' % (time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime()))
+        for m in self.model_list:
+            if m.error_info:
+                txt += '\nError: ' + m.error_info + '\n'
+                continue
+            txt += '\nModel: %s (%s)\n\n' % (m.model_def['group']['name'], m.model_id)
+            txt += m.get_text()
+        return txt

sunspec2/device.py

@@ -70,7 +70,9 @@ def __init__(self, gdef=None, model=None, model_offset=0, group_len=0, data=None
                               data=data, data_offset=data_offset, group_class=group_class, point_class=point_class,
                               index=index)
 
-    def read(self):
+    def read(self, len=None):
+        if len is None:
+            len = self.len
         # check if currently connected
         connected = self.model.device.is_connected()
         if not connected:
@@ -82,7 +84,7 @@ def read(self):
                 data += self.model.device.read(self.model.model_addr + self.offset + region[0], region[1])
             data = bytes(data)
         else:
-            data = self.model.device.read(self.model.model_addr + self.offset, self.len)
+            data = self.model.device.read(self.model.model_addr + self.offset, len)
         self.set_mb(data=data, dirty=False)
 
         # disconnect if was not connected
@@ -171,6 +173,9 @@ def __init__(self, model_id=None, model_addr=0, model_len=0, model_def=None, dat
     def add_error(self, error_info):
         self.error_info = '%s%s\n' % (self.error_info, error_info)
 
+    def read(self, len=None):
+        SunSpecModbusClientGroup.read(self, len=self.len + 2)
+
 
 class SunSpecModbusClientDevice(device.Device):
     def __init__(self, model_class=SunSpecModbusClientModel):
@@ -200,11 +205,13 @@ def read(self, addr, count):
     def write(self, addr, data):
         return
 
-    def scan(self, progress=None, delay=None, connect=True):
+    def scan(self, progress=None, delay=None, connect=True, full_model_read=True):
         """Scan all the models of the physical device and create the
         corresponding model objects within the device object based on the
         SunSpec model definitions.
         """
+        self.base_addr = None
+        self.delete_models()
 
         data = error = ''
         connected = False
@@ -259,7 +266,8 @@ def scan(self, progress=None, delay=None, connect=True):
                     model_data = model_id_data + model_len_data
                     model = self.model_class(model_id=model_id, model_addr=addr, model_len=model_len, data=model_data,
                                              mb_device=self)
-                    model.read()
+                    if full_model_read:
+                        model.read()
                     model.mid = '%s_%s' % (self.did, mid)
                     mid += 1
                     self.add_model(model)
@@ -287,7 +295,8 @@ def scan(self, progress=None, delay=None, connect=True):
 
 class SunSpecModbusClientDeviceTCP(SunSpecModbusClientDevice):
     def __init__(self, slave_id=1, ipaddr='127.0.0.1', ipport=502, timeout=None, ctx=None, trace_func=None,
-                 max_count=modbus_client.REQ_COUNT_MAX, test=False, model_class=SunSpecModbusClientModel):
+                 max_count=modbus_client.REQ_COUNT_MAX, max_write_count=modbus_client.REQ_WRITE_COUNT_MAX, test=False,
+                 model_class=SunSpecModbusClientModel):
         SunSpecModbusClientDevice.__init__(self, model_class=model_class)
         self.slave_id = slave_id
         self.ipaddr = ipaddr
@@ -297,10 +306,12 @@ def __init__(self, slave_id=1, ipaddr='127.0.0.1', ipport=502, timeout=None, ctx
         self.socket = None
         self.trace_func = trace_func
         self.max_count = max_count
+        self.max_write_count = max_write_count
 
         self.client = modbus_client.ModbusClientTCP(slave_id=slave_id, ipaddr=ipaddr, ipport=ipport, timeout=timeout,
                                                     ctx=ctx, trace_func=trace_func,
-                                                    max_count=modbus_client.REQ_COUNT_MAX, test=test)
+                                                    max_count=modbus_client.REQ_COUNT_MAX,
+                                                    max_write_count=modbus_client.REQ_WRITE_COUNT_MAX, test=test)
         if self.client is None:
             raise SunSpecModbusClientError('No modbus tcp client set for device')
 
@@ -353,7 +364,8 @@ class SunSpecModbusClientDeviceRTU(SunSpecModbusClientDevice):
     """
 
     def __init__(self, slave_id, name, baudrate=None, parity=None, timeout=None, ctx=None, trace_func=None,
-                 max_count=modbus_client.REQ_COUNT_MAX, model_class=SunSpecModbusClientModel):
+                 max_count=modbus_client.REQ_COUNT_MAX, max_write_count=modbus_client.REQ_WRITE_COUNT_MAX,
+                 model_class=SunSpecModbusClientModel):
         # test if this super class init is needed
         SunSpecModbusClientDevice.__init__(self, model_class=model_class)
         self.slave_id = slave_id
@@ -362,6 +374,7 @@ def __init__(self, slave_id, name, baudrate=None, parity=None, timeout=None, ctx
         self.ctx = ctx
         self.trace_func = trace_func
         self.max_count = max_count
+        self.max_write_count = max_write_count
 
         self.client = modbus_client.modbus_rtu_client(name, baudrate, parity)
         if self.client is None:
@@ -406,4 +419,5 @@ def write(self, addr, data):
                 Byte string containing register contents.
         """
 
-        return self.client.write(self.slave_id, addr, data, trace_func=self.trace_func, max_count=self.max_count)
+        return self.client.write(self.slave_id, addr, data, trace_func=self.trace_func,
+                                 max_write_count=self.max_write_count)

sunspec2/modbus/client.py

@@ -26,6 +26,7 @@
 PARITY_EVEN = 'E'
 
 REQ_COUNT_MAX = 125
+REQ_WRITE_COUNT_MAX = 123
 
 FUNC_READ_HOLDING = 3
 FUNC_READ_INPUT = 4
@@ -405,7 +406,7 @@ def _write(self, slave_id, addr, data, trace_func=None):
             if resp_slave_id != slave_id or resp_func != func or resp_addr != addr or resp_count != count:
                 raise ModbusClientError('Mobus response format error')
 
-    def write(self, slave_id, addr, data, trace_func=None, max_count=REQ_COUNT_MAX):
+    def write(self, slave_id, addr, data, trace_func=None, max_write_count=REQ_WRITE_COUNT_MAX):
         """
         Parameters:
             slave_id :
@@ -417,17 +418,17 @@ def write(self, slave_id, addr, data, trace_func=None, max_count=REQ_COUNT_MAX):
             trace_func :
                 Trace function to use for detailed logging. No detailed logging
                 is perform is a trace function is not supplied.
-            max_count :
-                Maximum register count for a single Modbus request.
+            max_write_count :
+                Maximum register count for a single Modbus write.
         """
 
         write_offset = 0
         count = len(data)/2
 
         if self.serial is not None:
             while (count > 0):
-                if count > max_count:
-                    write_count = max_count
+                if count > max_write_count:
+                    write_count = max_write_count
                 else:
                     write_count = count
                 start = int(write_offset * 2)
@@ -442,7 +443,7 @@ def write(self, slave_id, addr, data, trace_func=None, max_count=REQ_COUNT_MAX):
 
 class ModbusClientTCP(object):
     def __init__(self, slave_id=1, ipaddr='127.0.0.1', ipport=502, timeout=None, ctx=None, trace_func=None,
-                 max_count=REQ_COUNT_MAX, test=False):
+                 max_count=REQ_COUNT_MAX, max_write_count=REQ_WRITE_COUNT_MAX, test=False):
         self.slave_id = slave_id
         self.ipaddr = ipaddr
         self.ipport = ipport
@@ -451,6 +452,7 @@ def __init__(self, slave_id=1, ipaddr='127.0.0.1', ipport=502, timeout=None, ctx
         self.socket = None
         self.trace_func = trace_func
         self.max_count = max_count
+        self.max_write_count = max_write_count
 
         if ipport is None:
             self.ipport = TCP_DEFAULT_PORT
@@ -672,8 +674,8 @@ def write(self, addr, data):
 
         try:
             while (count > 0):
-                if count > self.max_count:
-                    write_count = self.max_count
+                if count > self.max_write_count:
+                    write_count = self.max_write_count
                 else:
                     write_count = count
                     start = (write_offset * 2)