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:complexType>

    87

      </xsd:element>

    88

    </xsd:schema>

    89

    """

    90

    91

    def GetParamsAttributes(self, path=None):

    92

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

    93

        for element in infos:

    94

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

    95

                for child in element["children"]:

    96

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

    97

                        list = modbus_function_dict.keys()

    98

                        list.sort()

    99

                        child["type"] = list

   100

        return infos

   101

   102

    def GetVariableLocationTree(self):

   103

        current_location = self.GetCurrentLocation()

   104

        name = self.BaseParams.getName()

   105

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

   106

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

   107

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

   108

        # 'BOOL' or 'WORD'

   109

        datatype = modbus_function_dict[function][3]

   110

        # 1 or 16

   111

        datasize = modbus_function_dict[function][4]

   112

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

   113

        # datazone = modbus_function_dict[function][5]

   114

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

   115

        datatacc = modbus_function_dict[function][6]

   116

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

   117

        dataname = modbus_function_dict[function][7]

   118

        entries = []

   119

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

   120

            entries.append({

   121

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

   122

                "type": LOCATION_VAR_MEMORY,

   123

                "size": datasize,

   124

                "IEC_type": datatype,

   125

                "var_name": "var_name",

   126

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

   127

                "description": "description",

   128

                "children": []})

   129

        return {"name": name,

   130

                "type": LOCATION_CONFNODE,

   131

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

   132

                "children": entries}

   133

   134

    def CTNGenerate_C(self, buildpath, locations):

   135

        """

   136

        Generate C code

   137

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

   138

        @param locations: List of complete variables locations \

   139

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

   140

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

   141

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

   142

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

   143

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

   144

            }, ...]

   145

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

   146

        """

   147

        return [], "", False

   148

   149

   150

#

   151

#

   152

#

   153

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

   154

#

   155

#

   156

#

   157

   158

# dictionary implementing:

   159

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

   160

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

   161

modbus_memtype_dict = {

   162

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

   163

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

   164

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

   165

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

   166

}

   167

   168

   169

class _MemoryAreaPlug(object):

   170

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

   171

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

   172

      <xsd:element name="MemoryArea">

   173

        <xsd:complexType>

   174

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

   175

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

   176

            <xsd:simpleType>

   177

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

   178

                    <xsd:minInclusive value="1"/>

   179

                    <xsd:maxInclusive value="65536"/>

   180

                </xsd:restriction>

   181

            </xsd:simpleType>

   182

          </xsd:attribute>

   183

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

   184

            <xsd:simpleType>

   185

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

   186

                    <xsd:minInclusive value="0"/>

   187

                    <xsd:maxInclusive value="65535"/>

   188

                </xsd:restriction>

   189

            </xsd:simpleType>

   190

          </xsd:attribute>

   191

        </xsd:complexType>

   192

      </xsd:element>

   193

    </xsd:schema>

   194

    """

   195

   196

    def GetParamsAttributes(self, path=None):

   197

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

   198

        for element in infos:

   199

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

   200

                for child in element["children"]:

   201

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

   202

                        list = modbus_memtype_dict.keys()

   203

                        list.sort()

   204

                        child["type"] = list

   205

        return infos

   206

   207

    def GetVariableLocationTree(self):

   208

        current_location = self.GetCurrentLocation()

   209

        name = self.BaseParams.getName()

   210

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

   211

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

   212

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

   213

        # 'BOOL' or 'WORD'

   214

        datatype = modbus_memtype_dict[function][3]

   215

        # 1 or 16

   216

        datasize = modbus_memtype_dict[function][4]

   217

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

   218

        # datazone = modbus_memtype_dict[function][5]

   219

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

   220

        datatacc = modbus_memtype_dict[function][6]

   221

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

   222

        dataname = modbus_memtype_dict[function][7]

   223

        entries = []

   224

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

   225

            entries.append({

   226

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

   227

                "type": LOCATION_VAR_MEMORY,

   228

                "size": datasize,

   229

                "IEC_type": datatype,

   230

                "var_name": "var_name",

   231

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

   232

                "description": "description",

   233

                "children": []})

   234

        return {"name": name,

   235

                "type": LOCATION_CONFNODE,

   236

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

   237

                "children": entries}

   238

   239

    def CTNGenerate_C(self, buildpath, locations):

   240

        """

   241

        Generate C code

   242

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

   243

        @param locations: List of complete variables locations \

   244

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

   245

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

   246

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

   247

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

   248

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

   249

            }, ...]

   250

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

   251

        """

   252

        return [], "", False

   253

   254

   255

#

   256

#

   257

#

   258

# T C P    C L I E N T                 #

   259

#

   260

#

   261

#

   262

   263

class _ModbusTCPclientPlug(object):

   264

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

   265

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

   266

      <xsd:element name="ModbusTCPclient">

   267

        <xsd:complexType>

   268

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

   269

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

   270

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

   271

            <xsd:simpleType>

   272

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

   273

                    <xsd:minInclusive value="1"/>

   274

                    <xsd:maxInclusive value="2147483647"/>

   275

                </xsd:restriction>

   276

            </xsd:simpleType>

   277

          </xsd:attribute>

   278

        </xsd:complexType>

   279

      </xsd:element>

   280

    </xsd:schema>

   281

    """

   282

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

   283

    # corresponds to aprox 25 days.

   284

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

   285

    # TODO: Replace with CTNType !!!

   286

    PlugType = "ModbusTCPclient"

   287

   288

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

   289

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

   290

    def GetNodeCount(self):

   291

        return (1, 0, 0)

   292

   293

    def CTNGenerate_C(self, buildpath, locations):

   294

        """

   295

        Generate C code

   296

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

   297

        @param locations: List of complete variables locations \

   298

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

   299

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

   300

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

   301

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

   302

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

   303

            }, ...]

   304

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

   305

        """

   306

        return [], "", False

   307

   308

   309

#

   310

#

   311

#

   312

# T C P    S E R V E R                 #

   313

#

   314

#

   315

#

   316

   317

class _ModbusTCPserverPlug(object):

   318

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

   319

    # This is because the underlying modbus library accepts strings

   320

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

   321

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

   322

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

   323

      <xsd:element name="ModbusServerNode">

   324

        <xsd:complexType>

   325

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

   326

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

   327

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

   328

            <xsd:simpleType>

   329

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

   330

                    <xsd:minInclusive value="0"/>

   331

                    <xsd:maxInclusive value="255"/>

   332

                </xsd:restriction>

   333

            </xsd:simpleType>

   334

          </xsd:attribute>

   335

        </xsd:complexType>

   336

      </xsd:element>

   337

    </xsd:schema>

   338

    """

   339

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

   340

    # TODO: Replace with CTNType !!!

   341

    PlugType = "ModbusTCPserver"

   342

   343

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

   344

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

   345

    def GetNodeCount(self):

   346

        return (1, 0, 0)

   347

   348

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

   349

    #     location: location of this node in the configuration tree

   350

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

   351

    def GetIPServerPortNumbers(self):

   352

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

   353

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

   354

   355

    def CTNGenerate_C(self, buildpath, locations):

   356

        """

   357

        Generate C code

   358

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

   359

        @param locations: List of complete variables locations \

   360

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

   361

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

   362

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

   363

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

   364

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

   365

            }, ...]

   366

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

   367

        """

   368

        return [], "", False

   369

   370

   371

#

   372

#

   373

#

   374

# R T U    C L I E N T                 #

   375

#

   376

#

   377

#

   378

   379

class _ModbusRTUclientPlug(object):

   380

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

   381

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

   382

      <xsd:element name="ModbusRTUclient">

   383

        <xsd:complexType>

   384

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

   385

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

   386

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

   387

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

   388

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

   389

            <xsd:simpleType>

   390

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

   391

                    <xsd:minInclusive value="1"/>

   392

                    <xsd:maxInclusive value="2147483647"/>

   393

                </xsd:restriction>

   394

            </xsd:simpleType>

   395

          </xsd:attribute>

   396

        </xsd:complexType>

   397

      </xsd:element>

   398

    </xsd:schema>

   399

    """

   400

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

   401

    # corresponds to aprox 25 days.

   402

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

   403

    # TODO: Replace with CTNType !!!

   404

    PlugType = "ModbusRTUclient"

   405

   406

    def GetParamsAttributes(self, path=None):

   407

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

   408

        for element in infos:

   409

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

   410

                for child in element["children"]:

   411

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

   412

                        child["type"] = modbus_serial_baudrate_list

   413

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

   414

                        child["type"] = modbus_serial_stopbits_list

   415

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

   416

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

   417

        return infos

   418

   419

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

   420

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

   421

    def GetNodeCount(self):

   422

        return (0, 1, 0)

   423

   424

    def CTNGenerate_C(self, buildpath, locations):

   425

        """

   426

        Generate C code

   427

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

   428

        @param locations: List of complete variables locations \

   429

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

   430

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

   431

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

   432

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

   433

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

   434

            }, ...]

   435

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

   436

        """

   437

        return [], "", False

   438

   439

   440

#

   441

#

   442

#

   443

# R T U    S L A V E                   #

   444

#

   445

#

   446

#

   447

   448

   449

class _ModbusRTUslavePlug(object):

   450

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

   451

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

   452

      <xsd:element name="ModbusRTUslave">

   453

        <xsd:complexType>

   454

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

   455

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

   456

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

   457

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

   458

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

   459

            <xsd:simpleType>

   460

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

   461

                    <xsd:minInclusive value="1"/>

   462

                    <xsd:maxInclusive value="255"/>

   463

                </xsd:restriction>

   464

            </xsd:simpleType>

   465

          </xsd:attribute>

   466

        </xsd:complexType>

   467

      </xsd:element>

   468

    </xsd:schema>

   469

    """

   470

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

   471

    # TODO: Replace with CTNType !!!

   472

    PlugType = "ModbusRTUslave"

   473

   474

    def GetParamsAttributes(self, path=None):

   475

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

   476

        for element in infos:

   477

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

   478

                for child in element["children"]:

   479

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

   480

                        child["type"] = modbus_serial_baudrate_list

   481

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

   482

                        child["type"] = modbus_serial_stopbits_list

   483

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

   484

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

   485

        return infos

   486

   487

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

   488

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

   489

    def GetNodeCount(self):

   490

        return (0, 1, 0)

   491

   492

    def CTNGenerate_C(self, buildpath, locations):

   493

        """

   494

        Generate C code

   495

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

   496

        @param locations: List of complete variables locations \

   497

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

   498

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

   499

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

   500

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

   501

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

   502

            }, ...]

   503

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

   504

        """

   505

        return [], "", False

   506

   507

   508

def _lt_to_str(loctuple):

   509

    return '.'.join(map(str, loctuple))

   510

   511

   512

#

   513

#

   514

#