1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (c) 2016 Mario de Sousa (msousa@fe.up.pt)

     8

#

     9

# This program is free software: you can redistribute it and/or modify

    10

# it under the terms of the GNU General Public License as published by

    11

# the Free Software Foundation, either version 2 of the License, or

    12

# (at your option) any later version.

    13

#

    14

# This program is distributed in the hope that it will be useful,

    15

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

# GNU General Public License for more details.

    18

#

    19

# You should have received a copy of the GNU General Public License

    20

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

    21

#

    22

# This code is made available on the understanding that it will not be

    23

# used in safety-critical situations without a full and competent review.

    24

    25

    26

from __future__ import absolute_import

    27

import os

    28

from six.moves import xrange

    29

    30

from modbus.mb_utils import *

    31

from ConfigTreeNode import ConfigTreeNode

    32

from PLCControler import LOCATION_CONFNODE, LOCATION_VAR_MEMORY

    33

import util.paths as paths

    34

    35

ModbusPath = paths.ThirdPartyPath("Modbus")

    36

    37

    38

#

    39

#

    40

#

    41

# C L I E N T    R E Q U E S T            #

    42

#

    43

#

    44

#

    45

    46

    47

class _RequestPlug(object):

    48

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

    49

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    50

      <xsd:element name="ModbusRequest">

    51

        <xsd:complexType>

    52

          <xsd:attribute name="Function" type="xsd:string" use="optional" default="01 - Read Coils"/>

    53

          <xsd:attribute name="SlaveID" use="optional" default="1">

    54

            <xsd:simpleType>

    55

                <xsd:restriction base="xsd:integer">

    56

                    <xsd:minInclusive value="0"/>

    57

                    <xsd:maxInclusive value="255"/>

    58

                </xsd:restriction>

    59

            </xsd:simpleType>

    60

          </xsd:attribute>

    61

          <xsd:attribute name="Nr_of_Channels" use="optional" default="1">

    62

            <xsd:simpleType>

    63

                <xsd:restriction base="xsd:integer">

    64

                    <xsd:minInclusive value="1"/>

    65

                    <xsd:maxInclusive value="2000"/>

    66

                </xsd:restriction>

    67

            </xsd:simpleType>

    68

          </xsd:attribute>

    69

          <xsd:attribute name="Start_Address" use="optional" default="0">

    70

            <xsd:simpleType>

    71

                <xsd:restriction base="xsd:integer">

    72

                    <xsd:minInclusive value="0"/>

    73

                    <xsd:maxInclusive value="65535"/>

    74

                </xsd:restriction>

    75

            </xsd:simpleType>

    76

          </xsd:attribute>

    77

          <xsd:attribute name="Timeout_in_ms" use="optional" default="10">

    78

            <xsd:simpleType>

    79

                <xsd:restriction base="xsd:integer">

    80

                    <xsd:minInclusive value="1"/>

    81

                    <xsd:maxInclusive value="100000"/>

    82

                </xsd:restriction>

    83

            </xsd:simpleType>

    84

          </xsd:attribute>

    85

          <xsd:attribute name="Write_on_change" type="xsd:boolean" use="optional" default="false"/>

    86

        </xsd:complexType>

    87

      </xsd:element>

    88

    </xsd:schema>

    89

    """

    90

    91

    def GetParamsAttributes(self, path=None):

    92

        infos = ConfigTreeNode.GetParamsAttributes(self, path=path)

    93

        for element in infos:

    94

            if element["name"] == "ModbusRequest":

    95

                for child in element["children"]:

    96

                    if child["name"] == "Function":

    97

                        list = modbus_function_dict.keys()

    98

                        list.sort()

    99

                        child["type"] = list

   100

        return infos

   101

   102

    def GetVariableLocationTree(self):

   103

        current_location = self.GetCurrentLocation()

   104

        name = self.BaseParams.getName()

   105

        address = self.GetParamsAttributes()[0]["children"][3]["value"]

   106

        count = self.GetParamsAttributes()[0]["children"][2]["value"]

   107

        function = self.GetParamsAttributes()[0]["children"][0]["value"]

   108

        # 'BOOL' or 'WORD'

   109

        datatype = modbus_function_dict[function][3]

   110

        # 1 or 16

   111

        datasize = modbus_function_dict[function][4]

   112

        # 'Q' for coils and holding registers, 'I' for input discretes and input registers

   113

        # datazone = modbus_function_dict[function][5]

   114

        # 'X' for bits, 'W' for words

   115

        datatacc = modbus_function_dict[function][6]

   116

        # 'Coil', 'Holding Register', 'Input Discrete' or 'Input Register'

   117

        dataname = modbus_function_dict[function][7]

   118

        # start off with a boolean entry

   119

        # This is a flag used to allow the user program to control when to 

   120

        # execute the Modbus request.

   121

        # NOTE: If the Modbus request has a 'current_location' of

   122

        #          %QX1.2.3

   123

        #       then the execution control flag will be

   124

        #          %QX1.2.3.0.0

   125

        #       and all the Modbus registers/coils will be

   126

        #          %QX1.2.3.0

   127

        #          %QX1.2.3.1

   128

        #          %QX1.2.3.2

   129

        #            ..

   130

        #          %QX1.2.3.n

   131

        entries = []

   132

        entries.append({

   133

            "name": "Execute request flag",

   134

            "type": LOCATION_VAR_MEMORY,

   135

            "size": 1,           # BOOL flag

   136

            "IEC_type": "BOOL",  # BOOL flag

   137

            "var_name": "var_name",

   138

            "location": "X" + ".".join([str(i) for i in current_location]) + ".0.0",

   139

            "description": "Modbus request execution control flag",

   140

            "children": []})        

   141

        entries.append({

   142

            "name": "Modbus Request Status flag",

   143

            "type": LOCATION_VAR_MEMORY,

   144

            "size": 8,           # BYTE flag

   145

            "IEC_type": "BYTE",  # BYTE flag

   146

            "var_name": "var_name",

   147

            "location": "B" + ".".join([str(i) for i in current_location]) + ".0.1",

   148

            "description": "Modbus request status flag (0 -> OK, 1 -> Network error, 2 -> Received invalid frame, 3 -> Timeout, 4 -> Received error frame)",

   149

            "children": []})        

   150

        entries.append({

   151

            "name": "Modbus Error Code",

   152

            "type": LOCATION_VAR_MEMORY,

   153

            "size": 8,           # BYTE flag

   154

            "IEC_type": "BYTE",  # BYTE flag

   155

            "var_name": "var_name",

   156

            "location": "B" + ".".join([str(i) for i in current_location]) + ".0.2",

   157

            "description": "Modbus Error Code received in Modbus error frame",

   158

            "children": []})        

   159

        for offset in range(address, address + count):

   160

            entries.append({

   161

                "name": dataname + " " + str(offset),

   162

                "type": LOCATION_VAR_MEMORY,

   163

                "size": datasize,

   164

                "IEC_type": datatype,

   165

                "var_name": "MB_" + "".join([w[0] for w in dataname.split()]) + "_" + str(offset),

   166

                "location": datatacc + ".".join([str(i) for i in current_location]) + "." + str(offset),

   167

                "description": "description",

   168

                "children": []})

   169

        return {"name": name,

   170

                "type": LOCATION_CONFNODE,

   171

                "location": ".".join([str(i) for i in current_location]) + ".x",

   172

                "children": entries}

   173

   174

    def CTNGenerate_C(self, buildpath, locations):

   175

        """

   176

        Generate C code

   177

        @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)

   178

        @param locations: List of complete variables locations \

   179

            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)

   180

            "NAME" : name of the variable (generally "__IW0_1_2" style)

   181

            "DIR" : direction "Q","I" or "M"

   182

            "SIZE" : size "X", "B", "W", "D", "L"

   183

            "LOC" : tuple of interger for IEC location (0,1,2,...)

   184

            }, ...]

   185

        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND

   186

        """

   187

        return [], "", False

   188

   189

   190

   191

#

   192

#

   193

#

   194

# S E R V E R    M E M O R Y    A R E A       #

   195

#

   196

#

   197

#

   198

   199

# dictionary implementing:

   200

# key - string with the description we want in the request plugin GUI

   201

# list - (modbus function number, request type, max count value)

   202

modbus_memtype_dict = {

   203

    "01 - Coils":            ('1', 'rw_bits',  65536, "BOOL", 1, "Q", "X", "Coil"),

   204

    "02 - Input Discretes":  ('2', 'ro_bits',  65536, "BOOL", 1, "I", "X", "Input Discrete"),

   205

    "03 - Holding Registers": ('3', 'rw_words', 65536, "WORD", 16, "Q", "W", "Holding Register"),

   206

    "04 - Input Registers":  ('4', 'ro_words', 65536, "WORD", 16, "I", "W", "Input Register"),

   207

}

   208

   209

   210

class _MemoryAreaPlug(object):

   211

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

   212

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   213

      <xsd:element name="MemoryArea">

   214

        <xsd:complexType>

   215

          <xsd:attribute name="MemoryAreaType" type="xsd:string" use="optional" default="01 - Coils"/>

   216

          <xsd:attribute name="Nr_of_Channels" use="optional" default="1">

   217

            <xsd:simpleType>

   218

                <xsd:restriction base="xsd:integer">

   219

                    <xsd:minInclusive value="1"/>

   220

                    <xsd:maxInclusive value="65536"/>

   221

                </xsd:restriction>

   222

            </xsd:simpleType>

   223

          </xsd:attribute>

   224

          <xsd:attribute name="Start_Address" use="optional" default="0">

   225

            <xsd:simpleType>

   226

                <xsd:restriction base="xsd:integer">

   227

                    <xsd:minInclusive value="0"/>

   228

                    <xsd:maxInclusive value="65535"/>

   229

                </xsd:restriction>

   230

            </xsd:simpleType>

   231

          </xsd:attribute>

   232

        </xsd:complexType>

   233

      </xsd:element>

   234

    </xsd:schema>

   235

    """

   236

   237

    def GetParamsAttributes(self, path=None):

   238

        infos = ConfigTreeNode.GetParamsAttributes(self, path=path)

   239

        for element in infos:

   240

            if element["name"] == "MemoryArea":

   241

                for child in element["children"]:

   242

                    if child["name"] == "MemoryAreaType":

   243

                        list = modbus_memtype_dict.keys()

   244

                        list.sort()

   245

                        child["type"] = list

   246

        return infos

   247

   248

    def GetVariableLocationTree(self):

   249

        current_location = self.GetCurrentLocation()

   250

        name = self.BaseParams.getName()

   251

        address = self.GetParamsAttributes()[0]["children"][2]["value"]

   252

        count = self.GetParamsAttributes()[0]["children"][1]["value"]

   253

        function = self.GetParamsAttributes()[0]["children"][0]["value"]

   254

        # 'BOOL' or 'WORD'

   255

        datatype = modbus_memtype_dict[function][3]

   256

        # 1 or 16

   257

        datasize = modbus_memtype_dict[function][4]

   258

        # 'Q' for coils and holding registers, 'I' for input discretes and input registers

   259

        # datazone = modbus_memtype_dict[function][5]

   260

        # 'X' for bits, 'W' for words

   261

        datatacc = modbus_memtype_dict[function][6]

   262

        # 'Coil', 'Holding Register', 'Input Discrete' or 'Input Register'

   263

        dataname = modbus_memtype_dict[function][7]

   264

        entries = []

   265

        for offset in range(address, address + count):

   266

            entries.append({

   267

                "name": dataname + " " + str(offset),

   268

                "type": LOCATION_VAR_MEMORY,

   269

                "size": datasize,

   270

                "IEC_type": datatype,

   271

                "var_name": "MB_" + "".join([w[0] for w in dataname.split()]) + "_" + str(offset),

   272

                "location": datatacc + ".".join([str(i) for i in current_location]) + "." + str(offset),

   273

                "description": "description",

   274

                "children": []})

   275

        return {"name": name,

   276

                "type": LOCATION_CONFNODE,

   277

                "location": ".".join([str(i) for i in current_location]) + ".x",

   278

                "children": entries}

   279

   280

    def CTNGenerate_C(self, buildpath, locations):

   281

        """

   282

        Generate C code

   283

        @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)

   284

        @param locations: List of complete variables locations \

   285

            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)

   286

            "NAME" : name of the variable (generally "__IW0_1_2" style)

   287

            "DIR" : direction "Q","I" or "M"

   288

            "SIZE" : size "X", "B", "W", "D", "L"

   289

            "LOC" : tuple of interger for IEC location (0,1,2,...)

   290

            }, ...]

   291

        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND

   292

        """

   293

        return [], "", False

   294

   295

   296

#

   297

#

   298

#

   299

# T C P    C L I E N T                 #

   300

#

   301

#

   302

#

   303

   304

# XXX TODO "Configuration_Name" should disapear in favor of CTN Name, which is already unique

   305

   306

class _ModbusTCPclientPlug(object):

   307

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

   308

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   309

      <xsd:element name="ModbusTCPclient">

   310

        <xsd:complexType>

   311

          <xsd:attribute name="Configuration_Name" type="xsd:string" use="optional" default=""/>

   312

          <xsd:attribute name="Remote_IP_Address" type="xsd:string" use="optional" default="localhost"/>

   313

          <xsd:attribute name="Remote_Port_Number" type="xsd:string" use="optional" default="502"/>

   314

          <xsd:attribute name="Invocation_Rate_in_ms" use="optional" default="100">

   315

            <xsd:simpleType>

   316

                <xsd:restriction base="xsd:unsignedLong">

   317

                    <xsd:minInclusive value="0"/>

   318

                    <xsd:maxInclusive value="2147483647"/>

   319

                </xsd:restriction>

   320

            </xsd:simpleType>

   321

          </xsd:attribute>

   322

        </xsd:complexType>

   323

      </xsd:element>

   324

    </xsd:schema>

   325

    """

   326

    # NOTE: Max value of 2147483647 (i32_max) for Invocation_Rate_in_ms

   327

    # corresponds to aprox 25 days.

   328

    CTNChildrenTypes = [("ModbusRequest", _RequestPlug, "Request")]

   329

    # TODO: Replace with CTNType !!!

   330

    PlugType = "ModbusTCPclient"

   331

   332

   333

    def __init__(self):

   334

        # NOTE:

   335

        # The ModbusTCPclient attribute is added dynamically by ConfigTreeNode._AddParamsMembers()

   336

        # It will be an XML parser object created by

   337

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   338

   339

        # Set the default value for the "Configuration_Name" parameter

   340

        # The default value will need to be different for each instance of the 

   341

        # _ModbusTCPclientPlug class, so we cannot hardcode the default value in the XSD above

   342

        # This value will be used by the web interface 

   343

        #   (i.e. the extension to the web server used to configure the Modbus parameters).

   344

        #   (The web server is run/activated/started by Beremiz_service.py)

   345

        #   (The web server code is found in runtime/NevowServer.py)

   346

        #   (The Modbus extension to the web server is found in runtime/Modbus_config.py)

   347

        loc_str = ".".join(map(str, self.GetCurrentLocation()))

   348

        self.ModbusTCPclient.setConfiguration_Name("Modbus TCP Client " + loc_str)

   349

   350

    # Return the number of (modbus library) nodes this specific TCP client will need

   351

    #   return type: (tcp nodes, rtu nodes, ascii nodes)

   352

    def GetNodeCount(self):

   353

        return (1, 0, 0)

   354

   355

    def GetConfigName(self):

   356

        """ Return the node's Configuration_Name """

   357

        return self.ModbusTCPclient.getConfiguration_Name()

   358

   359

    def CTNGenerate_C(self, buildpath, locations):

   360

        """

   361

        Generate C code

   362

        @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)

   363

        @param locations: List of complete variables locations \

   364

            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)

   365

            "NAME" : name of the variable (generally "__IW0_1_2" style)

   366

            "DIR" : direction "Q","I" or "M"

   367

            "SIZE" : size "X", "B", "W", "D", "L"

   368

            "LOC" : tuple of interger for IEC location (0,1,2,...)

   369

            }, ...]

   370

        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND

   371

        """

   372

        return [], "", False

   373

   374

   375

#

   376

#

   377

#

   378

# T C P    S E R V E R                 #

   379

#

   380

#

   381

#

   382

   383

# XXX TODO "Configuration_Name" should disapear in favor of CTN Name, which is already unique

   384

   385

class _ModbusTCPserverPlug(object):

   386

    # NOTE: the Port number is a 'string' and not an 'integer'!

   387

    # This is because the underlying modbus library accepts strings

   388

    # (e.g.: well known port names!)

   389

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

   390

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   391

      <xsd:element name="ModbusServerNode">

   392

        <xsd:complexType>

   393

          <xsd:attribute name="Configuration_Name" type="xsd:string" use="optional" default=""/>

   394

          <xsd:attribute name="Local_IP_Address" type="xsd:string" use="optional"  default="#ANY#"/>

   395

          <xsd:attribute name="Local_Port_Number" type="xsd:string" use="optional" default="502"/>

   396

          <xsd:attribute name="SlaveID" use="optional" default="0">

   397

            <xsd:simpleType>

   398

                <xsd:restriction base="xsd:integer">

   399

                    <xsd:minInclusive value="0"/>

   400

                    <xsd:maxInclusive value="255"/>

   401

                </xsd:restriction>

   402

            </xsd:simpleType>

   403

          </xsd:attribute>

   404

        </xsd:complexType>

   405

      </xsd:element>

   406

    </xsd:schema>

   407

    """

   408

    CTNChildrenTypes = [("MemoryArea", _MemoryAreaPlug, "Memory Area")]

   409

    # TODO: Replace with CTNType !!!

   410

    PlugType = "ModbusTCPserver"

   411

   412

    def __init__(self):

   413

        # NOTE:

   414

        # The ModbusServerNode attribute is added dynamically by ConfigTreeNode._AddParamsMembers()

   415

        # It will be an XML parser object created by

   416

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   417

   418

        # Set the default value for the "Configuration_Name" parameter

   419

        # The default value will need to be different for each instance of the 

   420

        # _ModbusTCPclientPlug class, so we cannot hardcode the default value in the XSD above

   421

        # This value will be used by the web interface 

   422

        #   (i.e. the extension to the web server used to configure the Modbus parameters).

   423

        #   (The web server is run/activated/started by Beremiz_service.py)

   424

        #   (The web server code is found in runtime/NevowServer.py)

   425

        #   (The Modbus extension to the web server is found in runtime/Modbus_config.py)

   426

        loc_str = ".".join(map(str, self.GetCurrentLocation()))

   427

        self.ModbusServerNode.setConfiguration_Name("Modbus TCP Server " + loc_str)

   428

   429

    # Return the number of (modbus library) nodes this specific TCP server will need

   430

    #   return type: (tcp nodes, rtu nodes, ascii nodes)

   431

    def GetNodeCount(self):

   432

        return (1, 0, 0)

   433

   434

    # Return a list with a single tuple conatining the (location, IP address, port number)

   435

    #     location   : location of this node in the configuration tree

   436

    #     port number: IP port used by this Modbus/IP server

   437

    #     IP address : IP address of the network interface on which the server will be listening

   438

    #                  ("", "*", or "#ANY#" => listening on all interfaces!)

   439

    def GetIPServerPortNumbers(self):

   440

        port = self.ModbusServerNode.getLocal_Port_Number()

   441

        addr = self.ModbusServerNode.getLocal_IP_Address()

   442

        return [(self.GetCurrentLocation(), addr, port)]

   443

   444

    def GetConfigName(self):

   445

        """ Return the node's Configuration_Name """

   446

        return self.ModbusServerNode.getConfiguration_Name()

   447

   448

    def GetVariableLocationTree(self):

   449

        current_location = self.GetCurrentLocation()

   450

        name             = self.BaseParams.getName()

   451

        # start off with flags that count the number of Modbus requests/transactions

   452

        # handled by this Modbus server/slave.

   453

        # These flags are mapped onto located variables and therefore available to the user programs

   454

        # May be used to detect communication errors.

   455

        # execute the Modbus request.

   456

        # NOTE: If the Modbus slave has a 'current_location' of

   457

        #          %QX1.2

   458

        #       then the "Modbus Read Request Counter"  will be %MD1.2.0

   459

        #       then the "Modbus Write Request Counter" will be %MD1.2.1

   460

        #       then the "Modbus Read Request Flag"     will be %MD1.2.2

   461

        #       then the "Modbus Write Request Flag"    will be %MD1.2.3

   462

        #

   463

        # Note that any MemoryArea contained under this server/slave

   464

        # will ocupy the locations of type

   465

        #          %MX or %MW

   466

        # which will never clash with the %MD used here.

   467

        # Additionaly, any MemoryArea contained under this server/slave

   468

        # will ocupy locations with

   469

        #           %M1.2.a.b (with a and b being numbers in range 0, 1, ...)

   470

        # and therefore never ocupy the locations

   471

        #           %M1.2.0

   472

        #           %M1.2.1

   473

        #           %M1.2.2

   474

        #           %M1.2.3

   475

        # used by the following flags/counters.

   476

        entries = []

   477

        entries.append({

   478

            "name": "Modbus Read Request Counter",

   479

            "type": LOCATION_VAR_MEMORY,

   480

            "size": 32,           # UDINT flag

   481

            "IEC_type": "UDINT",  # UDINT flag

   482

            "var_name": "var_name",

   483

            "location": "D" + ".".join([str(i) for i in current_location]) + ".0",

   484

            "description": "Modbus read request counter",

   485

            "children": []})        

   486

        entries.append({

   487

            "name": "Modbus Write Request Counter",

   488

            "type": LOCATION_VAR_MEMORY,

   489

            "size": 32,           # UDINT flag

   490

            "IEC_type": "UDINT",  # UDINT flag

   491

            "var_name": "var_name",

   492

            "location": "D" + ".".join([str(i) for i in current_location]) + ".1",

   493

            "description": "Modbus write request counter",

   494

            "children": []})        

   495

        entries.append({

   496

            "name": "Modbus Read Request Flag",

   497

            "type": LOCATION_VAR_MEMORY,

   498

            "size": 1,            # BOOL flag

   499

            "IEC_type": "BOOL",   # BOOL flag

   500

            "var_name": "var_name",

   501

            "location": "X" + ".".join([str(i) for i in current_location]) + ".2",

   502

            "description": "Modbus read request flag",

   503

            "children": []})        

   504

        entries.append({

   505

            "name": "Modbus write Request Flag",