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({

   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",

   150

            "children": []})        

   151

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

   152

            entries.append({

   153

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

   154

                "type": LOCATION_VAR_MEMORY,

   155

                "size": datasize,

   156

                "IEC_type": datatype,

   157

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

   158

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

   159

                "description": "description",

   160

                "children": []})

   161

        return {"name": name,

   162

                "type": LOCATION_CONFNODE,

   163

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

   164

                "children": entries}

   165

   166

    def CTNGenerate_C(self, buildpath, locations):

   167

        """

   168

        Generate C code

   169

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

   170

        @param locations: List of complete variables locations \

   171

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

   172

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

   173

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

   174

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

   175

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

   176

            }, ...]

   177

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

   178

        """

   179

        return [], "", False

   180

   181

   182

#

   183

#

   184

#

   185

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

   186

#

   187

#

   188

#

   189

   190

# dictionary implementing:

   191

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

   192

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

   193

modbus_memtype_dict = {

   194

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

   195

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

   196

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

   197

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

   198

}

   199

   200

   201

class _MemoryAreaPlug(object):

   202

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

   203

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

   204

      <xsd:element name="MemoryArea">

   205

        <xsd:complexType>

   206

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

   207

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

   208

            <xsd:simpleType>

   209

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

   210

                    <xsd:minInclusive value="1"/>

   211

                    <xsd:maxInclusive value="65536"/>

   212

                </xsd:restriction>

   213

            </xsd:simpleType>

   214

          </xsd:attribute>

   215

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

   216

            <xsd:simpleType>

   217

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

   218

                    <xsd:minInclusive value="0"/>

   219

                    <xsd:maxInclusive value="65535"/>

   220

                </xsd:restriction>

   221

            </xsd:simpleType>

   222

          </xsd:attribute>

   223

        </xsd:complexType>

   224

      </xsd:element>

   225

    </xsd:schema>

   226

    """

   227

   228

    def GetParamsAttributes(self, path=None):

   229

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

   230

        for element in infos:

   231

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

   232

                for child in element["children"]:

   233

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

   234

                        list = modbus_memtype_dict.keys()

   235

                        list.sort()

   236

                        child["type"] = list

   237

        return infos

   238

   239

    def GetVariableLocationTree(self):

   240

        current_location = self.GetCurrentLocation()

   241

        name = self.BaseParams.getName()

   242

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

   243

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

   244

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

   245

        # 'BOOL' or 'WORD'

   246

        datatype = modbus_memtype_dict[function][3]

   247

        # 1 or 16

   248

        datasize = modbus_memtype_dict[function][4]

   249

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

   250

        # datazone = modbus_memtype_dict[function][5]

   251

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

   252

        datatacc = modbus_memtype_dict[function][6]

   253

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

   254

        dataname = modbus_memtype_dict[function][7]

   255

        entries = []

   256

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

   257

            entries.append({

   258

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

   259

                "type": LOCATION_VAR_MEMORY,

   260

                "size": datasize,

   261

                "IEC_type": datatype,

   262

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

   263

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

   264

                "description": "description",

   265

                "children": []})

   266

        return {"name": name,

   267

                "type": LOCATION_CONFNODE,

   268

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

   269

                "children": entries}

   270

   271

    def CTNGenerate_C(self, buildpath, locations):

   272

        """

   273

        Generate C code

   274

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

   275

        @param locations: List of complete variables locations \

   276

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

   277

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

   278

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

   279

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

   280

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

   281

            }, ...]

   282

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

   283

        """

   284

        return [], "", False

   285

   286

   287

#

   288

#

   289

#

   290

# T C P    C L I E N T                 #

   291

#

   292

#

   293

#

   294

   295

class _ModbusTCPclientPlug(object):

   296

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

   297

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

   298

      <xsd:element name="ModbusTCPclient">

   299

        <xsd:complexType>

   300

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

   301

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

   302

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

   303

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

   304

            <xsd:simpleType>

   305

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

   306

                    <xsd:minInclusive value="0"/>

   307

                    <xsd:maxInclusive value="2147483647"/>

   308

                </xsd:restriction>

   309

            </xsd:simpleType>

   310

          </xsd:attribute>

   311

        </xsd:complexType>

   312

      </xsd:element>

   313

    </xsd:schema>

   314

    """

   315

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

   316

    # corresponds to aprox 25 days.

   317

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

   318

    # TODO: Replace with CTNType !!!

   319

    PlugType = "ModbusTCPclient"

   320

   321

   322

    def __init__(self):

   323

        # NOTE:

   324

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

   325

        # It will be an XML parser object created by

   326

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   327

   328

        # Set the default value for the "Configuration_Name" parameter

   329

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

   330

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

   331

        # This value will be used by the web interface 

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

   339

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

   340

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

   341

    def GetNodeCount(self):

   342

        return (1, 0, 0)

   343

   344

    def GetConfigName(self):

   345

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

   346

        return self.ModbusTCPclient.getConfiguration_Name()

   347

   348

    def CTNGenerate_C(self, buildpath, locations):

   349

        """

   350

        Generate C code

   351

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

   352

        @param locations: List of complete variables locations \

   353

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

   354

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

   355

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

   356

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

   357

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

   358

            }, ...]

   359

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

   360

        """

   361

        return [], "", False

   362

   363

   364

#

   365

#

   366

#

   367

# T C P    S E R V E R                 #

   368

#

   369

#

   370

#

   371

   372

class _ModbusTCPserverPlug(object):

   373

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

   374

    # This is because the underlying modbus library accepts strings

   375

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

   376

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

   377

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

   378

      <xsd:element name="ModbusServerNode">

   379

        <xsd:complexType>

   380

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

   381

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

   382

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

   383

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

   384

            <xsd:simpleType>

   385

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

   386

                    <xsd:minInclusive value="0"/>

   387

                    <xsd:maxInclusive value="255"/>

   388

                </xsd:restriction>

   389

            </xsd:simpleType>

   390

          </xsd:attribute>

   391

        </xsd:complexType>

   392

      </xsd:element>

   393

    </xsd:schema>

   394

    """

   395

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

   396

    # TODO: Replace with CTNType !!!

   397

    PlugType = "ModbusTCPserver"

   398

   399

    def __init__(self):

   400

        # NOTE:

   401

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

   402

        # It will be an XML parser object created by

   403

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   404

   405

        # Set the default value for the "Configuration_Name" parameter

   406

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

   407

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

   408

        # This value will be used by the web interface 

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

   416

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

   417

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

   418

    def GetNodeCount(self):

   419

        return (1, 0, 0)

   420

   421

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

   422

    #     location   : location of this node in the configuration tree

   423

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

   424

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

   425

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

   426

    def GetIPServerPortNumbers(self):

   427

        port = self.ModbusServerNode.getLocal_Port_Number()

   428

        addr = self.ModbusServerNode.getLocal_IP_Address()

   429

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

   430

   431

    def GetConfigName(self):

   432

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

   433

        return self.ModbusServerNode.getConfiguration_Name()

   434

   435

    def CTNGenerate_C(self, buildpath, locations):

   436

        """

   437

        Generate C code

   438

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

   439

        @param locations: List of complete variables locations \

   440

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

   441

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

   442

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

   443

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

   444

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

   445

            }, ...]

   446

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

   447

        """

   448

        return [], "", False

   449

   450

   451

#

   452

#

   453

#

   454

# R T U    C L I E N T                 #

   455

#

   456

#

   457

#

   458

   459

class _ModbusRTUclientPlug(object):

   460

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

   461

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

   462

      <xsd:element name="ModbusRTUclient">

   463

        <xsd:complexType>

   464

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

   465

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

   466

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

   467

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

   468

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

   469

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

   470

            <xsd:simpleType>

   471

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

   472

                    <xsd:minInclusive value="0"/>

   473

                    <xsd:maxInclusive value="2147483647"/>

   474

                </xsd:restriction>

   475

            </xsd:simpleType>

   476

          </xsd:attribute>

   477

        </xsd:complexType>

   478

      </xsd:element>

   479

    </xsd:schema>

   480

    """

   481

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

   482

    # corresponds to aprox 25 days.

   483

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

   484

    # TODO: Replace with CTNType !!!

   485

    PlugType = "ModbusRTUclient"

   486

   487

    def __init__(self):

   488

        # NOTE:

   489

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

   490

        # It will be an XML parser object created by

   491

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   492

   493

        # Set the default value for the "Configuration_Name" parameter

   494

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

   495

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

   496

        # This value will be used by the web interface 

   497

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

   498

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

   499

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

   500

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

   501

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

   502

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

   503

   504

    def GetParamsAttributes(self, path=None):

   505

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

   506

        for element in infos:

   507

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

   508