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

    34

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

    35

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

    36

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

    37

    38

    39

#

    40

#

    41

#

    42

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

    43

#

    44

#

    45

#

    46

    47

    48

class _RequestPlug(object):

    49

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

    50

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

    51

      <xsd:element name="ModbusRequest">

    52

        <xsd:complexType>

    53

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

    54

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

    55

            <xsd:simpleType>

    56

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

    57

                    <xsd:minInclusive value="0"/>

    58

                    <xsd:maxInclusive value="255"/>

    59

                </xsd:restriction>

    60

            </xsd:simpleType>

    61

          </xsd:attribute>

    62

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

    63

            <xsd:simpleType>

    64

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

    65

                    <xsd:minInclusive value="1"/>

    66

                    <xsd:maxInclusive value="2000"/>

    67

                </xsd:restriction>

    68

            </xsd:simpleType>

    69

          </xsd:attribute>

    70

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

    71

            <xsd:simpleType>

    72

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

    73

                    <xsd:minInclusive value="0"/>

    74

                    <xsd:maxInclusive value="65535"/>

    75

                </xsd:restriction>

    76

            </xsd:simpleType>

    77

          </xsd:attribute>

    78

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

    79

            <xsd:simpleType>

    80

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

    81

                    <xsd:minInclusive value="1"/>

    82

                    <xsd:maxInclusive value="100000"/>

    83

                </xsd:restriction>

    84

            </xsd:simpleType>

    85

          </xsd:attribute>

    86

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

    87

        </xsd:complexType>

    88

      </xsd:element>

    89

    </xsd:schema>

    90

    """

    91

    92

    def GetParamsAttributes(self, path=None):

    93

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

    94

        for element in infos:

    95

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

    96

                for child in element["children"]:

    97

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

    98

                        list = modbus_function_dict.keys()

    99

                        list.sort()

   100

                        child["type"] = list

   101

        return infos

   102

   103

    def GetVariableLocationTree(self):

   104

        current_location = self.GetCurrentLocation()

   105

        name = self.BaseParams.getName()

   106

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

   107

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

   108

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

   109

        # 'BOOL' or 'WORD'

   110

        datatype = modbus_function_dict[function][3]

   111

        # 1 or 16

   112

        datasize = modbus_function_dict[function][4]

   113

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

   114

        # datazone = modbus_function_dict[function][5]

   115

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

   116

        datatacc = modbus_function_dict[function][6]

   117

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

   118

        dataname = modbus_function_dict[function][7]

   119

        # start off with a boolean entry

   120

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

   121

        # execute the Modbus request.

   122

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

   123

        #          %QX1.2.3

   124

        #       then the execution control flag will be

   125

        #          %QX1.2.3.0.0

   126

        #       and all the Modbus registers/coils will be

   127

        #          %QX1.2.3.0

   128

        #          %QX1.2.3.1

   129

        #          %QX1.2.3.2

   130

        #            ..

   131

        #          %QX1.2.3.n

   132

        entries = []

   133

        entries.append({

   134

            "name": "Exec. request flag",

   135

            "type": LOCATION_VAR_MEMORY,

   136

            "size": 1,           # BOOL flag

   137

            "IEC_type": "BOOL",  # BOOL flag

   138

            "var_name": "var_name",

   139

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

   140

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

   141

            "children": []})        

   142

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

   143

            entries.append({

   144

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

   145

                "type": LOCATION_VAR_MEMORY,

   146

                "size": datasize,

   147

                "IEC_type": datatype,

   148

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

   149

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

   150

                "description": "description",

   151

                "children": []})

   152

        return {"name": name,

   153

                "type": LOCATION_CONFNODE,

   154

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

   155

                "children": entries}

   156

   157

    def CTNGenerate_C(self, buildpath, locations):

   158

        """

   159

        Generate C code

   160

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

   161

        @param locations: List of complete variables locations \

   162

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

   163

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

   164

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

   165

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

   166

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

   167

            }, ...]

   168

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

   169

        """

   170

        return [], "", False

   171

   172

   173

#

   174

#

   175

#

   176

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

   177

#

   178

#

   179

#

   180

   181

# dictionary implementing:

   182

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

   183

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

   184

modbus_memtype_dict = {

   185

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

   186

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

   187

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

   188

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

   189

}

   190

   191

   192

class _MemoryAreaPlug(object):

   193

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

   194

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

   195

      <xsd:element name="MemoryArea">

   196

        <xsd:complexType>

   197

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

   198

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

   199

            <xsd:simpleType>

   200

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

   201

                    <xsd:minInclusive value="1"/>

   202

                    <xsd:maxInclusive value="65536"/>

   203

                </xsd:restriction>

   204

            </xsd:simpleType>

   205

          </xsd:attribute>

   206

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

   207

            <xsd:simpleType>

   208

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

   209

                    <xsd:minInclusive value="0"/>

   210

                    <xsd:maxInclusive value="65535"/>

   211

                </xsd:restriction>

   212

            </xsd:simpleType>

   213

          </xsd:attribute>

   214

        </xsd:complexType>

   215

      </xsd:element>

   216

    </xsd:schema>

   217

    """

   218

   219

    def GetParamsAttributes(self, path=None):

   220

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

   221

        for element in infos:

   222

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

   223

                for child in element["children"]:

   224

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

   225

                        list = modbus_memtype_dict.keys()

   226

                        list.sort()

   227

                        child["type"] = list

   228

        return infos

   229

   230

    def GetVariableLocationTree(self):

   231

        current_location = self.GetCurrentLocation()

   232

        name = self.BaseParams.getName()

   233

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

   234

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

   235

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

   236

        # 'BOOL' or 'WORD'

   237

        datatype = modbus_memtype_dict[function][3]

   238

        # 1 or 16

   239

        datasize = modbus_memtype_dict[function][4]

   240

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

   241

        # datazone = modbus_memtype_dict[function][5]

   242

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

   243

        datatacc = modbus_memtype_dict[function][6]

   244

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

   245

        dataname = modbus_memtype_dict[function][7]

   246

        entries = []

   247

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

   248

            entries.append({

   249

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

   250

                "type": LOCATION_VAR_MEMORY,

   251

                "size": datasize,

   252

                "IEC_type": datatype,

   253

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

   254

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

   255

                "description": "description",

   256

                "children": []})

   257

        return {"name": name,

   258

                "type": LOCATION_CONFNODE,

   259

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

   260

                "children": entries}

   261

   262

    def CTNGenerate_C(self, buildpath, locations):

   263

        """

   264

        Generate C code

   265

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

   266

        @param locations: List of complete variables locations \

   267

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

   268

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

   269

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

   270

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

   271

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

   272

            }, ...]

   273

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

   274

        """

   275

        return [], "", False

   276

   277

   278

#

   279

#

   280

#

   281

# T C P    C L I E N T                 #

   282

#

   283

#

   284

#

   285

   286

class _ModbusTCPclientPlug(object):

   287

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

   288

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

   289

      <xsd:element name="ModbusTCPclient">

   290

        <xsd:complexType>

   291

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

   292

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

   293

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

   294

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

   295

            <xsd:simpleType>

   296

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

   297

                    <xsd:minInclusive value="0"/>

   298

                    <xsd:maxInclusive value="2147483647"/>

   299

                </xsd:restriction>

   300

            </xsd:simpleType>

   301

          </xsd:attribute>

   302

        </xsd:complexType>

   303

      </xsd:element>

   304

    </xsd:schema>

   305

    """

   306

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

   307

    # corresponds to aprox 25 days.

   308

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

   309

    # TODO: Replace with CTNType !!!

   310

    PlugType = "ModbusTCPclient"

   311

   312

   313

    def __init__(self):

   314

        # NOTE:

   315

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

   316

        # It will be an XML parser object created by

   317

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   318

   319

        # Set the default value for the "Configuration_Name" parameter

   320

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

   321

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

   322

        # This value will be used by the web interface 

   323

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

   324

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

   325

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

   326

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

   327

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

   328

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

   329

   330

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

   331

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

   332

    def GetNodeCount(self):

   333

        return (1, 0, 0)

   334

   335

    def GetConfigName(self):

   336

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

   337

        return self.ModbusTCPclient.getConfiguration_Name()

   338

   339

    def CTNGenerate_C(self, buildpath, locations):

   340

        """

   341

        Generate C code

   342

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

   343

        @param locations: List of complete variables locations \

   344

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

   345

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

   346

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

   347

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

   348

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

   349

            }, ...]

   350

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

   351

        """

   352

        return [], "", False

   353

   354

   355

#

   356

#

   357

#

   358

# T C P    S E R V E R                 #

   359

#

   360

#

   361

#

   362

   363

class _ModbusTCPserverPlug(object):

   364

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

   365

    # This is because the underlying modbus library accepts strings

   366

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

   367

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

   368

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

   369

      <xsd:element name="ModbusServerNode">

   370

        <xsd:complexType>

   371

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

   372

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

   373

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

   374

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

   375

            <xsd:simpleType>

   376

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

   377

                    <xsd:minInclusive value="0"/>

   378

                    <xsd:maxInclusive value="255"/>

   379

                </xsd:restriction>

   380

            </xsd:simpleType>

   381

          </xsd:attribute>

   382

        </xsd:complexType>

   383

      </xsd:element>

   384

    </xsd:schema>

   385

    """

   386

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

   387

    # TODO: Replace with CTNType !!!

   388

    PlugType = "ModbusTCPserver"

   389

   390

    def __init__(self):

   391

        # NOTE:

   392

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

   393

        # It will be an XML parser object created by

   394

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   395

   396

        # Set the default value for the "Configuration_Name" parameter

   397

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

   398

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

   399

        # This value will be used by the web interface 

   400

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

   401

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

   402

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

   403

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

   404

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

   405

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

   406

   407

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

   408

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

   409

    def GetNodeCount(self):

   410

        return (1, 0, 0)

   411

   412

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

   413

    #     location   : location of this node in the configuration tree

   414

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

   415

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

   416

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

   417

    def GetIPServerPortNumbers(self):

   418

        port = self.ModbusServerNode.getLocal_Port_Number()

   419

        addr = self.ModbusServerNode.getLocal_IP_Address()

   420

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

   421

   422

    def GetConfigName(self):

   423

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

   424

        return self.ModbusServerNode.getConfiguration_Name()

   425

   426

    def CTNGenerate_C(self, buildpath, locations):

   427

        """

   428

        Generate C code

   429

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

   430

        @param locations: List of complete variables locations \

   431

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

   432

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

   433

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

   434

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

   435

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

   436

            }, ...]

   437

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

   438

        """

   439

        return [], "", False

   440

   441

   442

#

   443

#

   444

#

   445

# R T U    C L I E N T                 #

   446

#

   447

#

   448

#

   449

   450

class _ModbusRTUclientPlug(object):

   451

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

   452

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

   453

      <xsd:element name="ModbusRTUclient">

   454

        <xsd:complexType>

   455

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

   456

          <xsd:attribute name="Serial_Port" type="xsd:string"  use="optional" default="/dev/ttyS0"/>

   457

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

   458

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

   459

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

   460

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

   461

            <xsd:simpleType>

   462

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

   463

                    <xsd:minInclusive value="0"/>

   464

                    <xsd:maxInclusive value="2147483647"/>

   465

                </xsd:restriction>

   466

            </xsd:simpleType>

   467

          </xsd:attribute>

   468

        </xsd:complexType>

   469

      </xsd:element>

   470

    </xsd:schema>

   471

    """

   472

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

   473

    # corresponds to aprox 25 days.

   474

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

   475

    # TODO: Replace with CTNType !!!

   476

    PlugType = "ModbusRTUclient"

   477

   478

    def __init__(self):

   479

        # NOTE:

   480

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

   481

        # It will be an XML parser object created by

   482

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   483

   484

        # Set the default value for the "Configuration_Name" parameter

   485

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

   486

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

   487

        # This value will be used by the web interface 

   488

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

   489

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

   490

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

   491

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

   492

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

   493

        self.ModbusRTUclient.setConfiguration_Name("Modbus RTU Client " + loc_str)

   494

   495

    def GetParamsAttributes(self, path=None):

   496

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

   497

        for element in infos:

   498

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

   499

                for child in element["children"]:

   500

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

   501

                        child["type"] = modbus_serial_baudrate_list

   502

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

   503

                        child["type"] = modbus_serial_stopbits_list

   504

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

   505

                        child["type"] = modbus_serial_parity_dict.keys()

   506

        return infos

   507

   508

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