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

   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

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

   196

#

   197

#

   198

#

   199

   200

# dictionary implementing:

   201

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

   202

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

   203

modbus_memtype_dict = {

   204

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

   205

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

   206

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

   207

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

   208

}

   209

   210

   211

class _MemoryAreaPlug(object):

   212

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

   213

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

   214

      <xsd:element name="MemoryArea">

   215

        <xsd:complexType>

   216

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

   217

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

   218

            <xsd:simpleType>

   219

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

   220

                    <xsd:minInclusive value="1"/>

   221

                    <xsd:maxInclusive value="65536"/>

   222

                </xsd:restriction>

   223

            </xsd:simpleType>

   224

          </xsd:attribute>

   225

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

   226

            <xsd:simpleType>

   227

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

   228

                    <xsd:minInclusive value="0"/>

   229

                    <xsd:maxInclusive value="65535"/>

   230

                </xsd:restriction>

   231

            </xsd:simpleType>

   232

          </xsd:attribute>

   233

        </xsd:complexType>

   234

      </xsd:element>

   235

    </xsd:schema>

   236

    """

   237

   238

    def GetParamsAttributes(self, path=None):

   239

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

   240

        for element in infos:

   241

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

   242

                for child in element["children"]:

   243

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

   244

                        list = modbus_memtype_dict.keys()

   245

                        list.sort()

   246

                        child["type"] = list

   247

        return infos

   248

   249

    def GetVariableLocationTree(self):

   250

        current_location = self.GetCurrentLocation()

   251

        name = self.BaseParams.getName()

   252

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

   253

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

   254

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

   255

        # 'BOOL' or 'WORD'

   256

        datatype = modbus_memtype_dict[function][3]

   257

        # 1 or 16

   258

        datasize = modbus_memtype_dict[function][4]

   259

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

   260

        # datazone = modbus_memtype_dict[function][5]

   261

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

   262

        datatacc = modbus_memtype_dict[function][6]

   263

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

   264

        dataname = modbus_memtype_dict[function][7]

   265

        entries = []

   266

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

   267

            entries.append({

   268

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

   269

                "type": LOCATION_VAR_MEMORY,

   270

                "size": datasize,

   271

                "IEC_type": datatype,

   272

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

   273

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

   274

                "description": "description",

   275

                "children": []})

   276

        return {"name": name,

   277

                "type": LOCATION_CONFNODE,

   278

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

   279

                "children": entries}

   280

   281

    def CTNGenerate_C(self, buildpath, locations):

   282

        """

   283

        Generate C code

   284

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

   285

        @param locations: List of complete variables locations \

   286

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

   287

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

   288

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

   289

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

   290

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

   291

            }, ...]

   292

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

   293

        """

   294

        return [], "", False

   295

   296

   297

#

   298

#

   299

#

   300

# T C P    C L I E N T                 #

   301

#

   302

#

   303

#

   304

   305

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

   306

   307

class _ModbusTCPclientPlug(object):

   308

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

   309

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

   310

      <xsd:element name="ModbusTCPclient">

   311

        <xsd:complexType>

   312

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

   313

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

   314

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

   315

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

   316

            <xsd:simpleType>

   317

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

   318

                    <xsd:minInclusive value="0"/>

   319

                    <xsd:maxInclusive value="2147483647"/>

   320

                </xsd:restriction>

   321

            </xsd:simpleType>

   322

          </xsd:attribute>

   323

        </xsd:complexType>

   324

      </xsd:element>

   325

    </xsd:schema>

   326

    """

   327

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

   328

    # corresponds to aprox 25 days.

   329

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

   330

    # TODO: Replace with CTNType !!!

   331

    PlugType = "ModbusTCPclient"

   332

   333

   334

    def __init__(self):

   335

        # NOTE:

   336

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

   337

        # It will be an XML parser object created by

   338

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   339

   340

        # Set the default value for the "Configuration_Name" parameter

   341

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

   342

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

   343

        # This value will be used by the web interface 

   344

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

   345

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

   346

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

   347

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

   348

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

   349

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

   350

   351

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

   352

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

   353

    def GetNodeCount(self):

   354

        return (1, 0, 0)

   355

   356

    def GetConfigName(self):

   357

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

   358

        return self.ModbusTCPclient.getConfiguration_Name()

   359

   360

    def CTNGenerate_C(self, buildpath, locations):

   361

        """

   362

        Generate C code

   363

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

   364

        @param locations: List of complete variables locations \

   365

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

   366

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

   367

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

   368

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

   369

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

   370

            }, ...]

   371

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

   372

        """

   373

        return [], "", False

   374

   375

   376

#

   377

#

   378

#

   379

# T C P    S E R V E R                 #

   380

#

   381

#

   382

#

   383

   384

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

   385

   386

class _ModbusTCPserverPlug(object):

   387

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

   388

    # This is because the underlying modbus library accepts strings

   389

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

   390

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

   391

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

   392

      <xsd:element name="ModbusServerNode">

   393

        <xsd:complexType>

   394

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

   395

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

   396

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

   397

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

   398

            <xsd:simpleType>

   399

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

   400

                    <xsd:minInclusive value="0"/>

   401

                    <xsd:maxInclusive value="255"/>

   402

                </xsd:restriction>

   403

            </xsd:simpleType>

   404

          </xsd:attribute>

   405

        </xsd:complexType>

   406

      </xsd:element>

   407

    </xsd:schema>

   408

    """

   409

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

   410

    # TODO: Replace with CTNType !!!

   411

    PlugType = "ModbusTCPserver"

   412

   413

    def __init__(self):

   414

        # NOTE:

   415

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

   416

        # It will be an XML parser object created by

   417

        # GenerateParserFromXSDstring(self.XSD).CreateRoot()

   418

   419

        # Set the default value for the "Configuration_Name" parameter

   420

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

   421

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

   422

        # This value will be used by the web interface 

   423

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

   424

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

   425

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

   426

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

   427

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

   428

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

   429

   430

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

   431

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

   432

    def GetNodeCount(self):

   433

        return (1, 0, 0)

   434

   435

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

   436

    #     location   : location of this node in the configuration tree

   437

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

   438

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

   439

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

   440

    def GetIPServerPortNumbers(self):

   441

        port = self.ModbusServerNode.getLocal_Port_Number()

   442

        addr = self.ModbusServerNode.getLocal_IP_Address()

   443

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

   444

   445

    def GetConfigName(self):

   446

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

   447

        return self.ModbusServerNode.getConfiguration_Name()

   448

   449

    def CTNGenerate_C(self, buildpath, locations):

   450

        """

   451

        Generate C code

   452

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

   453

        @param locations: List of complete variables locations \

   454

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

   455

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

   456

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

   457

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

   458

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

   459

            }, ...]

   460

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

   461

        """

   462

        return [], "", False

   463

   464

   465

#

   466

#

   467

#

   468

# R T U    C L I E N T                 #

   469

#

   470

#

   471

#

   472

   473

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

   474

   475

class _ModbusRTUclientPlug(object):

   476

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

   477

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

   478

      <xsd:element name="ModbusRTUclient">

   479

        <xsd:complexType>

   480

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

   481

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

   482

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

   483

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

   484

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

   485

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

   486

            <xsd:simpleType>

   487

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

   488

                    <xsd:minInclusive value="0"/>

   489

                    <xsd:maxInclusive value="2147483647"/>

   490

                </xsd:restriction>

   491

            </xsd:simpleType>

   492

          </xsd:attribute>

   493

        </xsd:complexType>

   494

      </xsd:element>

   495

    </xsd:schema>

   496

    """

   497

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

   498

    # corresponds to aprox 25 days.

   499

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

   500

    # TODO: Replace with CTNType !!!

   501

    PlugType = "ModbusRTUclient"

   502

   503

    def __init__(self):

   504

        # NOTE:

   505

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

   506

        # It will be an XML parser object created by

   507