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 modbus.mb_utils import *

    29

    30

from ConfigTreeNode import ConfigTreeNode

    31

from PLCControler import LOCATION_CONFNODE, LOCATION_VAR_MEMORY

    32

    33

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

    34

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

    35

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

    36

    37

    38

#

    39

#

    40

#

    41

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

    42

#

    43

#

    44

#

    45

    46

    47

class _RequestPlug(object):

    48

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

    49

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

    50

      <xsd:element name="ModbusRequest">

    51

        <xsd:complexType>

    52

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

    53

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

    54

            <xsd:simpleType>

    55

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

    56

                    <xsd:minInclusive value="0"/>

    57

                    <xsd:maxInclusive value="255"/>

    58

                </xsd:restriction>

    59

            </xsd:simpleType>

    60

          </xsd:attribute>

    61

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

    62

            <xsd:simpleType>

    63

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

    64

                    <xsd:minInclusive value="1"/>

    65

                    <xsd:maxInclusive value="2000"/>

    66

                </xsd:restriction>

    67

            </xsd:simpleType>

    68

          </xsd:attribute>

    69

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

    70

            <xsd:simpleType>

    71

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

    72

                    <xsd:minInclusive value="0"/>

    73

                    <xsd:maxInclusive value="65535"/>

    74

                </xsd:restriction>

    75

            </xsd:simpleType>

    76

          </xsd:attribute>

    77

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

    78

            <xsd:simpleType>

    79

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

    80

                    <xsd:minInclusive value="1"/>

    81

                    <xsd:maxInclusive value="100000"/>

    82

                </xsd:restriction>

    83

            </xsd:simpleType>

    84

          </xsd:attribute>

    85

        </xsd:complexType>

    86

      </xsd:element>

    87

    </xsd:schema>

    88

    """

    89

    90

    def GetParamsAttributes(self, path=None):

    91

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

    92

        for element in infos:

    93

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

    94

                for child in element["children"]:

    95

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

    96

                        list = modbus_function_dict.keys()

    97

                        list.sort()

    98

                        child["type"] = list

    99

        return infos

   100

   101

    def GetVariableLocationTree(self):

   102

        current_location = self.GetCurrentLocation()

   103

        name = self.BaseParams.getName()

   104

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

   105

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

   106

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

   107

        # 'BOOL' or 'WORD'

   108

        datatype = modbus_function_dict[function][3]

   109

        # 1 or 16

   110

        datasize = modbus_function_dict[function][4]

   111

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

   112

        # datazone = modbus_function_dict[function][5]

   113

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

   114

        datatacc = modbus_function_dict[function][6]

   115

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

   116

        dataname = modbus_function_dict[function][7]

   117

        entries = []

   118

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

   119

            entries.append({

   120

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

   121

                "type": LOCATION_VAR_MEMORY,

   122

                "size": datasize,

   123

                "IEC_type": datatype,

   124

                "var_name": "var_name",

   125

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

   126

                "description": "description",

   127

                "children": []})

   128

        return {"name": name,

   129

                "type": LOCATION_CONFNODE,

   130

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

   131

                "children": entries}

   132

   133

    def CTNGenerate_C(self, buildpath, locations):

   134

        """

   135

        Generate C code

   136

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

   137

        @param locations: List of complete variables locations \

   138

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

   139

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

   140

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

   141

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

   142

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

   143

            }, ...]

   144

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

   145

        """

   146

        return [], "", False

   147

   148

   149

#

   150

#

   151

#

   152

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

   153

#

   154

#

   155

#

   156

   157

# dictionary implementing:

   158

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

   159

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

   160

modbus_memtype_dict = {

   161

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

   162

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

   163

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

   164

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

   165

}

   166

   167

   168

class _MemoryAreaPlug(object):

   169

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

   170

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

   171

      <xsd:element name="MemoryArea">

   172

        <xsd:complexType>

   173

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

   174

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

   175

            <xsd:simpleType>

   176

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

   177

                    <xsd:minInclusive value="1"/>

   178

                    <xsd:maxInclusive value="65536"/>

   179

                </xsd:restriction>

   180

            </xsd:simpleType>

   181

          </xsd:attribute>

   182

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

   183

            <xsd:simpleType>

   184

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

   185

                    <xsd:minInclusive value="0"/>

   186

                    <xsd:maxInclusive value="65535"/>

   187

                </xsd:restriction>

   188

            </xsd:simpleType>

   189

          </xsd:attribute>

   190

        </xsd:complexType>

   191

      </xsd:element>

   192

    </xsd:schema>

   193

    """

   194

   195

    def GetParamsAttributes(self, path=None):

   196

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

   197

        for element in infos:

   198

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

   199

                for child in element["children"]:

   200

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

   201

                        list = modbus_memtype_dict.keys()

   202

                        list.sort()

   203

                        child["type"] = list

   204

        return infos

   205

   206

    def GetVariableLocationTree(self):

   207

        current_location = self.GetCurrentLocation()

   208

        name = self.BaseParams.getName()

   209

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

   210

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

   211

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

   212

        # 'BOOL' or 'WORD'

   213

        datatype = modbus_memtype_dict[function][3]

   214

        # 1 or 16

   215

        datasize = modbus_memtype_dict[function][4]

   216

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

   217

        # datazone = modbus_memtype_dict[function][5]

   218

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

   219

        datatacc = modbus_memtype_dict[function][6]

   220

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

   221

        dataname = modbus_memtype_dict[function][7]

   222

        entries = []

   223

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

   224

            entries.append({

   225

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

   226

                "type": LOCATION_VAR_MEMORY,

   227

                "size": datasize,

   228

                "IEC_type": datatype,

   229

                "var_name": "var_name",

   230

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

   231

                "description": "description",

   232

                "children": []})

   233

        return {"name": name,

   234

                "type": LOCATION_CONFNODE,

   235

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

   236

                "children": entries}

   237

   238

    def CTNGenerate_C(self, buildpath, locations):

   239

        """

   240

        Generate C code

   241

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

   242

        @param locations: List of complete variables locations \

   243

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

   244

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

   245

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

   246

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

   247

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

   248

            }, ...]

   249

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

   250

        """

   251

        return [], "", False

   252

   253

   254

#

   255

#

   256

#

   257

# T C P    C L I E N T                 #

   258

#

   259

#

   260

#

   261

   262

class _ModbusTCPclientPlug(object):

   263

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

   264

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

   265

      <xsd:element name="ModbusTCPclient">

   266

        <xsd:complexType>

   267

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

   268

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

   269

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

   270

            <xsd:simpleType>

   271

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

   272

                    <xsd:minInclusive value="1"/>

   273

                    <xsd:maxInclusive value="2147483647"/>

   274

                </xsd:restriction>

   275

            </xsd:simpleType>

   276

          </xsd:attribute>

   277

        </xsd:complexType>

   278

      </xsd:element>

   279

    </xsd:schema>

   280

    """

   281

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

   282

    # corresponds to aprox 25 days.

   283

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

   284

    # TODO: Replace with CTNType !!!

   285

    PlugType = "ModbusTCPclient"

   286

   287

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

   288

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

   289

    def GetNodeCount(self):

   290

        return (1, 0, 0)

   291

   292

    def CTNGenerate_C(self, buildpath, locations):

   293

        """

   294

        Generate C code

   295

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

   296

        @param locations: List of complete variables locations \

   297

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

   298

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

   299

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

   300

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

   301

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

   302

            }, ...]

   303

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

   304

        """

   305

        return [], "", False

   306

   307

   308

#

   309

#

   310

#

   311

# T C P    S E R V E R                 #

   312

#

   313

#

   314

#

   315

   316

class _ModbusTCPserverPlug(object):

   317

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

   318

    # This is because the underlying modbus library accepts strings

   319

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

   320

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

   321

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

   322

      <xsd:element name="ModbusServerNode">

   323

        <xsd:complexType>

   324

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

   325

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

   326

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

   327

            <xsd:simpleType>

   328

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

   329

                    <xsd:minInclusive value="0"/>

   330

                    <xsd:maxInclusive value="255"/>

   331

                </xsd:restriction>

   332

            </xsd:simpleType>

   333

          </xsd:attribute>

   334

        </xsd:complexType>

   335

      </xsd:element>

   336

    </xsd:schema>

   337

    """

   338

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

   339

    # TODO: Replace with CTNType !!!

   340

    PlugType = "ModbusTCPserver"

   341

   342

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

   343

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

   344

    def GetNodeCount(self):

   345

        return (1, 0, 0)

   346

   347

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

   348

    #     location: location of this node in the configuration tree

   349

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

   350

    def GetIPServerPortNumbers(self):

   351

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

   352

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

   353

   354

    def CTNGenerate_C(self, buildpath, locations):

   355

        """

   356

        Generate C code

   357

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

   358

        @param locations: List of complete variables locations \

   359

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

   360

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

   361

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

   362

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

   363

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

   364

            }, ...]

   365

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

   366

        """

   367

        return [], "", False

   368

   369

   370

#

   371

#

   372

#

   373

# R T U    C L I E N T                 #

   374

#

   375

#

   376

#

   377

   378

class _ModbusRTUclientPlug(object):

   379

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

   380

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

   381

      <xsd:element name="ModbusRTUclient">

   382

        <xsd:complexType>

   383

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

   384

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

   385

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

   386

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

   387

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

   388

            <xsd:simpleType>

   389

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

   390

                    <xsd:minInclusive value="1"/>

   391

                    <xsd:maxInclusive value="2147483647"/>

   392

                </xsd:restriction>

   393

            </xsd:simpleType>

   394

          </xsd:attribute>

   395

        </xsd:complexType>

   396

      </xsd:element>

   397

    </xsd:schema>

   398

    """

   399

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

   400

    # corresponds to aprox 25 days.

   401

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

   402

    # TODO: Replace with CTNType !!!

   403

    PlugType = "ModbusRTUclient"

   404

   405

    def GetParamsAttributes(self, path=None):

   406

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

   407

        for element in infos:

   408

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

   409

                for child in element["children"]:

   410

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

   411

                        child["type"] = modbus_serial_baudrate_list

   412

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

   413

                        child["type"] = modbus_serial_stopbits_list

   414

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

   415

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

   416

        return infos

   417

   418

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

   419

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

   420

    def GetNodeCount(self):

   421

        return (0, 1, 0)

   422

   423

    def CTNGenerate_C(self, buildpath, locations):

   424

        """

   425

        Generate C code

   426

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

   427

        @param locations: List of complete variables locations \

   428

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

   429

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

   430

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

   431

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

   432

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

   433

            }, ...]

   434

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

   435

        """

   436

        return [], "", False

   437

   438

   439

#

   440

#

   441

#

   442

# R T U    S L A V E                   #

   443

#

   444

#

   445

#

   446

   447

   448

class _ModbusRTUslavePlug(object):

   449

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

   450

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

   451

      <xsd:element name="ModbusRTUslave">

   452

        <xsd:complexType>

   453

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

   454

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

   455

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

   456

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

   457

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

   458

            <xsd:simpleType>

   459

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

   460

                    <xsd:minInclusive value="1"/>

   461

                    <xsd:maxInclusive value="255"/>

   462

                </xsd:restriction>

   463

            </xsd:simpleType>

   464

          </xsd:attribute>

   465

        </xsd:complexType>

   466

      </xsd:element>

   467

    </xsd:schema>

   468

    """

   469

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

   470

    # TODO: Replace with CTNType !!!

   471

    PlugType = "ModbusRTUslave"

   472

   473

    def GetParamsAttributes(self, path=None):

   474

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

   475

        for element in infos:

   476

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

   477

                for child in element["children"]:

   478

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

   479

                        child["type"] = modbus_serial_baudrate_list

   480

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

   481

                        child["type"] = modbus_serial_stopbits_list

   482

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

   483

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

   484

        return infos

   485

   486

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

   487

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

   488

    def GetNodeCount(self):

   489

        return (0, 1, 0)

   490

   491

    def CTNGenerate_C(self, buildpath, locations):

   492

        """

   493

        Generate C code

   494

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

   495

        @param locations: List of complete variables locations \

   496

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

   497

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

   498

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

   499

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

   500

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

   501

            }, ...]

   502

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

   503

        """

   504

        return [], "", False

   505

   506

   507

def _lt_to_str(loctuple):

   508

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

   509

   510

   511

#

   512

#

   513

#

   514

# R O O T    C L A S S                #