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

base_folder = os.path.split(os.path.dirname(os.path.realpath(__file__)))[0]

    36

base_folder = os.path.join(base_folder, "..")

    37

ModbusPath = os.path.join(base_folder, "Modbus")

    38

    39

    40

#

    41

#

    42

#

    43

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

    44

#

    45

#

    46

#

    47

    48

    49

class _RequestPlug(object):

    50

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

    51

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

    52

      <xsd:element name="ModbusRequest">

    53

        <xsd:complexType>

    54

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

    55

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

    56

            <xsd:simpleType>

    57

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

    58

                    <xsd:minInclusive value="0"/>

    59

                    <xsd:maxInclusive value="255"/>

    60

                </xsd:restriction>

    61

            </xsd:simpleType>

    62

          </xsd:attribute>

    63

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

    64

            <xsd:simpleType>

    65

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

    66

                    <xsd:minInclusive value="1"/>

    67

                    <xsd:maxInclusive value="2000"/>

    68

                </xsd:restriction>

    69

            </xsd:simpleType>

    70

          </xsd:attribute>

    71

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

    72

            <xsd:simpleType>

    73

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

    74

                    <xsd:minInclusive value="0"/>

    75

                    <xsd:maxInclusive value="65535"/>

    76

                </xsd:restriction>

    77

            </xsd:simpleType>

    78

          </xsd:attribute>

    79

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

    80

            <xsd:simpleType>

    81

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

    82

                    <xsd:minInclusive value="1"/>

    83

                    <xsd:maxInclusive value="100000"/>

    84

                </xsd:restriction>

    85

            </xsd:simpleType>

    86

          </xsd:attribute>

    87

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

    88

        </xsd:complexType>

    89

      </xsd:element>

    90

    </xsd:schema>

    91

    """

    92

    93

    def GetParamsAttributes(self, path=None):

    94

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

    95

        for element in infos:

    96

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

    97

                for child in element["children"]:

    98

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

    99

                        list = modbus_function_dict.keys()

   100

                        list.sort()

   101

                        child["type"] = list

   102

        return infos

   103

   104

    def GetVariableLocationTree(self):

   105

        current_location = self.GetCurrentLocation()

   106

        name = self.BaseParams.getName()

   107

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

   108

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

   109

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

   110

        # 'BOOL' or 'WORD'

   111

        datatype = modbus_function_dict[function][3]

   112

        # 1 or 16

   113

        datasize = modbus_function_dict[function][4]

   114

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

   115

        # datazone = modbus_function_dict[function][5]

   116

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

   117

        datatacc = modbus_function_dict[function][6]

   118

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

   119

        dataname = modbus_function_dict[function][7]

   120

        # start off with a boolean entry

   121

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

   122

        # execute the Modbus request.

   123

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

   124

        #          %QX1.2.3

   125

        #       then the execution control flag will be

   126

        #          %QX1.2.3.0.0

   127

        #       and all the Modbus registers/coils will be

   128

        #          %QX1.2.3.0

   129

        #          %QX1.2.3.1

   130

        #          %QX1.2.3.2

   131

        #            ..

   132

        #          %QX1.2.3.n

   133

        entries = []

   134

        entries.append({

   135

            "name": "Execute request flag",

   136

            "type": LOCATION_VAR_MEMORY,

   137

            "size": 1,           # BOOL flag

   138

            "IEC_type": "BOOL",  # BOOL flag

   139

            "var_name": "var_name",

   140

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

   141

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

   142

            "children": []})        

   143

        entries.append({

   144

            "name": "Modbus Request Status flag",

   145

            "type": LOCATION_VAR_MEMORY,

   146

            "size": 8,           # BYTE flag

   147

            "IEC_type": "BYTE",  # BYTE flag

   148

            "var_name": "var_name",

   149

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

   150

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

   151

            "children": []})        

   152

        entries.append({

   153

            "name": "Modbus Error Code",

   154

            "type": LOCATION_VAR_MEMORY,

   155

            "size": 8,           # BYTE flag

   156

            "IEC_type": "BYTE",  # BYTE flag

   157

            "var_name": "var_name",

   158

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

   159

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

   160

            "children": []})        

   161

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

   162

            entries.append({

   163

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

   164

                "type": LOCATION_VAR_MEMORY,

   165

                "size": datasize,

   166

                "IEC_type": datatype,

   167

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

   168

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

   169

                "description": "description",

   170

                "children": []})

   171

        return {"name": name,

   172

                "type": LOCATION_CONFNODE,

   173

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

   174

                "children": entries}

   175

   176

    def CTNGenerate_C(self, buildpath, locations):

   177

        """

   178

        Generate C code

   179

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

   180

        @param locations: List of complete variables locations \

   181

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

   182

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

   183

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

   184

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

   185

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

   186

            }, ...]

   187

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

   188

        """

   189

        return [], "", False

   190

   191

   192

   193

#

   194

#

   195

#

   196

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

   197

#

   198

#

   199

#

   200

   201

# dictionary implementing:

   202

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

   203

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

   204

modbus_memtype_dict = {

   205

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

   206

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

   207

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

   208

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

   209

}

   210

   211

   212

class _MemoryAreaPlug(object):

   213

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

   214

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

   215

      <xsd:element name="MemoryArea">

   216

        <xsd:complexType>

   217

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

   218

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

   219

            <xsd:simpleType>

   220

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

   221

                    <xsd:minInclusive value="1"/>

   222

                    <xsd:maxInclusive value="65536"/>

   223

                </xsd:restriction>

   224

            </xsd:simpleType>

   225

          </xsd:attribute>

   226

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

   227

            <xsd:simpleType>

   228

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

   229

                    <xsd:minInclusive value="0"/>

   230

                    <xsd:maxInclusive value="65535"/>

   231

                </xsd:restriction>

   232

            </xsd:simpleType>

   233

          </xsd:attribute>

   234

        </xsd:complexType>

   235

      </xsd:element>

   236

    </xsd:schema>

   237

    """

   238

   239

    def GetParamsAttributes(self, path=None):

   240

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

   241

        for element in infos:

   242

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

   243

                for child in element["children"]:

   244

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

   245

                        list = modbus_memtype_dict.keys()

   246

                        list.sort()

   247

                        child["type"] = list

   248

        return infos

   249

   250

    def GetVariableLocationTree(self):

   251

        current_location = self.GetCurrentLocation()

   252

        name = self.BaseParams.getName()

   253

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

   254

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

   255

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

   256

        # 'BOOL' or 'WORD'

   257

        datatype = modbus_memtype_dict[function][3]

   258

        # 1 or 16

   259

        datasize = modbus_memtype_dict[function][4]

   260

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

   261

        # datazone = modbus_memtype_dict[function][5]

   262

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

   263

        datatacc = modbus_memtype_dict[function][6]

   264

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

   265

        dataname = modbus_memtype_dict[function][7]

   266

        entries = []

   267

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

   268

            entries.append({

   269

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

   270

                "type": LOCATION_VAR_MEMORY,

   271

                "size": datasize,

   272

                "IEC_type": datatype,

   273

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

   274

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

   275

                "description": "description",

   276

                "children": []})

   277

        return {"name": name,

   278

                "type": LOCATION_CONFNODE,

   279

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

   280

                "children": entries}

   281

   282

    def CTNGenerate_C(self, buildpath, locations):

   283

        """

   284

        Generate C code

   285

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

   286

        @param locations: List of complete variables locations \

   287

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

   288

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

   289

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

   290

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

   291

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

   292

            }, ...]

   293

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

   294

        """

   295

        return [], "", False

   296

   297

   298

#

   299

#

   300

#

   301

# T C P    C L I E N T                 #

   302

#

   303

#

   304

#

   305

   306

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

   307

   308

class _ModbusTCPclientPlug(object):

   309

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

   310

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

   311

      <xsd:element name="ModbusTCPclient">

   312

        <xsd:complexType>

   313

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

   314

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

   315

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

   316

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

   317

            <xsd:simpleType>

   318

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

   319

                    <xsd:minInclusive value="0"/>

   320

                    <xsd:maxInclusive value="2147483647"/>

   321

                </xsd:restriction>

   322

            </xsd:simpleType>

   323

          </xsd:attribute>

   324

        </xsd:complexType>

   325

      </xsd:element>

   326

    </xsd:schema>

   327

    """

   328

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

   329

    # corresponds to aprox 25 days.

   330

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

   331

    # TODO: Replace with CTNType !!!

   332

    PlugType = "ModbusTCPclient"

   333

   334

   335

    def __init__(self):

   336

        # NOTE:

   337

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

   338

        # It will be an XML parser object created by

   339

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   340

   341

        # Set the default value for the "Configuration_Name" parameter

   342

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

   343

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

   344

        # This value will be used by the web interface 

   345

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

   346

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

   347

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

   348

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

   349

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

   350

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

   351

   352

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

   353

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

   354

    def GetNodeCount(self):

   355

        return (1, 0, 0)

   356

   357

    def GetConfigName(self):

   358

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

   359

        return self.ModbusTCPclient.getConfiguration_Name()

   360

   361

    def CTNGenerate_C(self, buildpath, locations):

   362

        """

   363

        Generate C code

   364

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

   365

        @param locations: List of complete variables locations \

   366

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

   367

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

   368

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

   369

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

   370

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

   371

            }, ...]

   372

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

   373

        """

   374

        return [], "", False

   375

   376

   377

#

   378

#

   379

#

   380

# T C P    S E R V E R                 #

   381

#

   382

#

   383

#

   384

   385

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

   386

   387

class _ModbusTCPserverPlug(object):

   388

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

   389

    # This is because the underlying modbus library accepts strings

   390

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

   391

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

   392

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

   393

      <xsd:element name="ModbusServerNode">

   394

        <xsd:complexType>

   395

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

   396

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

   397

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

   398

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

   399

            <xsd:simpleType>

   400

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

   401

                    <xsd:minInclusive value="0"/>

   402

                    <xsd:maxInclusive value="255"/>

   403

                </xsd:restriction>

   404

            </xsd:simpleType>

   405

          </xsd:attribute>

   406

        </xsd:complexType>

   407

      </xsd:element>

   408

    </xsd:schema>

   409

    """

   410

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

   411

    # TODO: Replace with CTNType !!!

   412

    PlugType = "ModbusTCPserver"

   413

   414

    def __init__(self):

   415

        # NOTE:

   416

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

   417

        # It will be an XML parser object created by

   418

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   419

   420

        # Set the default value for the "Configuration_Name" parameter

   421

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

   422

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

   423

        # This value will be used by the web interface 

   424

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

   425

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

   426

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

   427

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

   428

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

   429

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

   430

   431

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

   432

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

   433

    def GetNodeCount(self):

   434

        return (1, 0, 0)

   435

   436

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

   437

    #     location   : location of this node in the configuration tree

   438

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

   439

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

   440

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

   441

    def GetIPServerPortNumbers(self):

   442

        port = self.ModbusServerNode.getLocal_Port_Number()

   443

        addr = self.ModbusServerNode.getLocal_IP_Address()

   444

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

   445

   446

    def GetConfigName(self):

   447

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

   448

        return self.ModbusServerNode.getConfiguration_Name()

   449

   450

    def GetVariableLocationTree(self):

   451

        current_location = self.GetCurrentLocation()

   452

        name             = self.BaseParams.getName()

   453

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

   454

        # handled by this Modbus server/slave.

   455

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

   456

        # May be used to detect communication errors.

   457

        # execute the Modbus request.

   458

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

   459

        #          %QX1.2

   460

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

   461

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

   462

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

   463

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

   464

        #

   465

        # Note that any MemoryArea contained under this server/slave

   466

        # will ocupy the locations of type

   467

        #          %MX or %MW

   468

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

   469

        # Additionaly, any MemoryArea contained under this server/slave

   470

        # will ocupy locations with

   471

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

   472

        # and therefore never ocupy the locations

   473

        #           %M1.2.0

   474

        #           %M1.2.1

   475

        #           %M1.2.2

   476

        #           %M1.2.3

   477

        # used by the following flags/counters.

   478

        entries = []

   479

        entries.append({

   480

            "name": "Modbus Read Request Counter",

   481

            "type": LOCATION_VAR_MEMORY,

   482

            "size": 32,           # UDINT flag

   483

            "IEC_type": "UDINT",  # UDINT flag

   484

            "var_name": "var_name",

   485

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

   486

            "description": "Modbus read request counter",

   487

            "children": []})        

   488

        entries.append({

   489

            "name": "Modbus Write Request Counter",

   490

            "type": LOCATION_VAR_MEMORY,

   491

            "size": 32,           # UDINT flag

   492

            "IEC_type": "UDINT",  # UDINT flag

   493

            "var_name": "var_name",

   494

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

   495

            "description": "Modbus write request counter",

   496

            "children": []})        

   497

        entries.append({

   498

            "name": "Modbus Read Request Flag",

   499

            "type": LOCATION_VAR_MEMORY,

   500

            "size": 1,            # BOOL flag

   501

            "IEC_type": "BOOL",   # BOOL flag

   502

            "var_name": "var_name",

   503

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

   504

            "description": "Modbus read request flag",

   505