1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library is distributed in the hope that it will be useful,

    17

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

from plcopen import PLCOpenParser

    26

from plcopen.structures import *

    27

from types import *

    28

import re

    29

    30

# Dictionary associating PLCOpen variable categories to the corresponding 

    31

# IEC 61131-3 variable categories

    32

varTypeNames = {"localVars" : "VAR", "tempVars" : "VAR_TEMP", "inputVars" : "VAR_INPUT", 

    33

                "outputVars" : "VAR_OUTPUT", "inOutVars" : "VAR_IN_OUT", "externalVars" : "VAR_EXTERNAL",

    34

                "globalVars" : "VAR_GLOBAL", "accessVars" : "VAR_ACCESS"}

    35

    36

    37

# Dictionary associating PLCOpen POU categories to the corresponding 

    38

# IEC 61131-3 POU categories

    39

pouTypeNames = {"function" : "FUNCTION", "functionBlock" : "FUNCTION_BLOCK", "program" : "PROGRAM"}

    40

    41

    42

errorVarTypes = {

    43

    "VAR_INPUT": "var_input",

    44

    "VAR_OUTPUT": "var_output",

    45

    "VAR_INOUT": "var_inout",

    46

}

    47

    48

# Helper function for reindenting text

    49

def ReIndentText(text, nb_spaces):

    50

    compute = ""

    51

    lines = text.splitlines()

    52

    if len(lines) > 0:

    53

        line_num = 0

    54

        while line_num < len(lines) and len(lines[line_num].strip()) == 0:

    55

            line_num += 1

    56

        if line_num < len(lines):

    57

            spaces = 0

    58

            while lines[line_num][spaces] == " ":

    59

                spaces += 1

    60

            indent = ""

    61

            for i in xrange(spaces, nb_spaces):

    62

                indent += " "

    63

            for line in lines:

    64

                if line != "":

    65

                    compute += "%s%s\n"%(indent, line)

    66

                else:

    67

                    compute += "\n"

    68

    return compute

    69

    70

def SortInstances(a, b):

    71

    ax, ay = int(a.getx()), int(a.gety())

    72

    bx, by = int(b.getx()), int(b.gety())

    73

    if abs(ay - by) < 10:

    74

        return cmp(ax, bx)

    75

    else:

    76

        return cmp(ay, by)

    77

    78

#-------------------------------------------------------------------------------

    79

#                  Specific exception for PLC generating errors

    80

#-------------------------------------------------------------------------------

    81

    82

    83

class PLCGenException(Exception):

    84

    pass

    85

    86

    87

#-------------------------------------------------------------------------------

    88

#                           Generator of PLC program

    89

#-------------------------------------------------------------------------------

    90

    91

    92

class ProgramGenerator:

    93

    94

    # Create a new PCL program generator

    95

    def __init__(self, controler, project, errors, warnings):

    96

        # Keep reference of the controler and project

    97

        self.Controler = controler

    98

        self.Project = project

    99

        # Reset the internal variables used to generate PLC programs

   100

        self.Program = []

   101

        self.DatatypeComputed = {}

   102

        self.PouComputed = {}

   103

        self.Errors = errors

   104

        self.Warnings = warnings

   105

   106

    # Compute value according to type given

   107

    def ComputeValue(self, value, var_type):

   108

        base_type = self.Controler.GetBaseType(var_type)

   109

        if base_type == "STRING" and not value.startswith("'") and not value.endswith("'"):

   110

            return "'%s'"%value

   111

        elif base_type == "WSTRING" and not value.startswith('"') and not value.endswith('"'):

   112

            return "\"%s\""%value

   113

        return value

   114

   115

    # Generate a data type from its name

   116

    def GenerateDataType(self, datatype_name):

   117

        # Verify that data type hasn't been generated yet

   118

        if not self.DatatypeComputed.get(datatype_name, True):

   119

            # If not mark data type as computed

   120

            self.DatatypeComputed[datatype_name] = True

   121

   122

            # Getting datatype model from project

   123

            datatype = self.Project.getdataType(datatype_name)

   124

            tagname = self.Controler.ComputeDataTypeName(datatype.getname())

   125

            datatype_def = [("  ", ()), 

   126

                            (datatype.getname(), (tagname, "name")),

   127

                            (" : ", ())]

   128

            basetype_content = datatype.baseType.getcontent()

   129

            basetype_content_type = basetype_content.getLocalTag()

   130

            # Data type derived directly from a user defined type 

   131

            if basetype_content_type == "derived":

   132

                basetype_name = basetype_content.getname()

   133

                self.GenerateDataType(basetype_name)

   134

                datatype_def += [(basetype_name, (tagname, "base"))]

   135

            # Data type is a subrange

   136

            elif basetype_content_type in ["subrangeSigned", "subrangeUnsigned"]:

   137

                base_type = basetype_content.baseType.getcontent()

   138

                base_type_type = base_type.getLocalTag()

   139

                # Subrange derived directly from a user defined type 

   140

                if base_type_type == "derived":

   141

                    basetype_name = base_type_type.getname()

   142

                    self.GenerateDataType(basetype_name)

   143

                # Subrange derived directly from an elementary type 

   144

                else:

   145

                    basetype_name = base_type_type

   146

                min_value = basetype_content.range.getlower()

   147

                max_value = basetype_content.range.getupper()

   148

                datatype_def += [(basetype_name, (tagname, "base")),

   149

                                 (" (", ()),

   150

                                 ("%s"%min_value, (tagname, "lower")),

   151

                                 ("..", ()),

   152

                                 ("%s"%max_value, (tagname, "upper")),

   153

                                 (")",())]

   154

            # Data type is an enumerated type

   155

            elif basetype_content_type == "enum":

   156

                values = [[(value.getname(), (tagname, "value", i))]

   157

                          for i, value in enumerate(

   158

                              basetype_content.xpath("ppx:values/ppx:value", 

   159

                                  namespaces=PLCOpenParser.NSMAP))]

   160

                datatype_def += [("(", ())]

   161

                datatype_def += JoinList([(", ", ())], values)

   162

                datatype_def += [(")", ())]

   163

            # Data type is an array

   164

            elif basetype_content_type == "array":

   165

                base_type = basetype_content.baseType.getcontent()

   166

                base_type_type = base_type.getLocalTag()

   167

                # Array derived directly from a user defined type 

   168

                if base_type_type == "derived":

   169

                    basetype_name = base_type.getname()

   170

                    self.GenerateDataType(basetype_name)

   171

                # Array derived directly from an elementary type 

   172

                else:

   173

                    basetype_name = base_type_type.upper()

   174

                dimensions = [[("%s"%dimension.getlower(), (tagname, "range", i, "lower")),

   175

                               ("..", ()),

   176

                               ("%s"%dimension.getupper(), (tagname, "range", i, "upper"))] 

   177

                              for i, dimension in enumerate(basetype_content.getdimension())]

   178

                datatype_def += [("ARRAY [", ())]

   179

                datatype_def += JoinList([(",", ())], dimensions)

   180

                datatype_def += [("] OF " , ()),

   181

                                 (basetype_name, (tagname, "base"))]

   182

            # Data type is a structure

   183

            elif basetype_content_type == "struct":

   184

                elements = []

   185

                for i, element in enumerate(basetype_content.getvariable()):

   186

                    element_type = element.type.getcontent()

   187

                    element_type_type = element_type.getLocalTag()

   188

                    # Structure element derived directly from a user defined type 

   189

                    if element_type_type == "derived":

   190

                        elementtype_name = element_type.getname()

   191

                        self.GenerateDataType(elementtype_name)

   192

                    elif element_type_type == "array":

   193

                        base_type = element_type.baseType.getcontent()

   194

                        base_type_type = base_type.getLocalTag()

   195

                        # Array derived directly from a user defined type 

   196

                        if base_type_type == "derived":

   197

                            basetype_name = base_type.getname()

   198

                            self.GenerateDataType(basetype_name)

   199

                        # Array derived directly from an elementary type 

   200

                        else:

   201

                            basetype_name = base_type_type.upper()

   202

                        dimensions = ["%s..%s" % (dimension.getlower(), dimension.getupper())

   203

                                      for dimension in element_type.getdimension()]

   204

                        elementtype_name = "ARRAY [%s] OF %s" % (",".join(dimensions), basetype_name)

   205

                    # Structure element derived directly from an elementary type 

   206

                    else:

   207

                        elementtype_name = element_type_type.upper()

   208

                    element_text = [("\n    ", ()),

   209

                                    (element.getname(), (tagname, "struct", i, "name")),

   210

                                    (" : ", ()),

   211

                                    (elementtype_name, (tagname, "struct", i, "type"))]

   212

                    if element.initialValue is not None:

   213

                        element_text.extend([(" := ", ()),

   214

                                             (self.ComputeValue(element.initialValue.getvalue(), elementtype_name), (tagname, "struct", i, "initial value"))])

   215

                    element_text.append((";", ()))

   216

                    elements.append(element_text)

   217

                datatype_def += [("STRUCT", ())]

   218

                datatype_def += JoinList([("", ())], elements)

   219

                datatype_def += [("\n  END_STRUCT", ())]

   220

            # Data type derived directly from a elementary type 

   221

            else:

   222

                datatype_def += [(basetype_content_type.upper(), (tagname, "base"))]

   223

            # Data type has an initial value

   224

            if datatype.initialValue is not None:

   225

                datatype_def += [(" := ", ()),

   226

                                 (self.ComputeValue(datatype.initialValue.getvalue(), datatype_name), (tagname, "initial value"))]

   227

            datatype_def += [(";\n", ())]

   228

            self.Program += datatype_def

   229

   230

    # Generate a POU from its name

   231

    def GeneratePouProgram(self, pou_name):

   232

        # Verify that POU hasn't been generated yet

   233

        if not self.PouComputed.get(pou_name, True):

   234

            # If not mark POU as computed

   235

            self.PouComputed[pou_name] = True

   236

   237

            # Getting POU model from project

   238

            pou = self.Project.getpou(pou_name)

   239

            pou_type = pou.getpouType()

   240

            # Verify that POU type exists

   241

            if pouTypeNames.has_key(pou_type):

   242

                # Create a POU program generator

   243

                pou_program = PouProgramGenerator(self, pou.getname(), pouTypeNames[pou_type], self.Errors, self.Warnings)

   244

                program = pou_program.GenerateProgram(pou)

   245

                self.Program += program

   246

            else:

   247

                raise PLCGenException, _("Undefined pou type \"%s\"")%pou_type

   248

   249

    # Generate a POU defined and used in text

   250

    def GeneratePouProgramInText(self, text):

   251

        for pou_name in self.PouComputed.keys():

   252

            model = re.compile("(?:^|[^0-9^A-Z])%s(?:$|[^0-9^A-Z])"%pou_name.upper())

   253

            if model.search(text) is not None:

   254

                self.GeneratePouProgram(pou_name)

   255

   256

    # Generate a configuration from its model

   257

    def GenerateConfiguration(self, configuration):

   258

        tagname = self.Controler.ComputeConfigurationName(configuration.getname())

   259

        config = [("\nCONFIGURATION ", ()),

   260

                  (configuration.getname(), (tagname, "name")),

   261

                  ("\n", ())]

   262

        var_number = 0

   263

   264

        varlists = [(varlist, varlist.getvariable()[:]) for varlist in configuration.getglobalVars()]

   265

   266

        extra_variables = self.Controler.GetConfigurationExtraVariables()

   267

        if len(extra_variables) > 0:

   268

            if len(varlists) == 0:

   269

                varlists = [(PLCOpenParser.CreateElement("globalVars", "interface"), [])]

   270

            varlists[-1][1].extend(extra_variables)

   271

   272

        # Generate any global variable in configuration

   273

        for varlist, varlist_variables in varlists:

   274

            variable_type = errorVarTypes.get("VAR_GLOBAL", "var_local")

   275

            # Generate variable block with modifier

   276

            config += [("  VAR_GLOBAL", ())]

   277

            if varlist.getconstant():

   278

                config += [(" CONSTANT", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "constant"))]

   279

            elif varlist.getretain():

   280

                config += [(" RETAIN", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "retain"))]

   281

            elif varlist.getnonretain():

   282

                config += [(" NON_RETAIN", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "non_retain"))]

   283

            config += [("\n", ())]

   284

            # Generate any variable of this block

   285

            for var in varlist_variables:

   286

                vartype_content = var.gettype().getcontent()

   287

                if vartype_content.getLocalTag() == "derived":

   288

                    var_type = vartype_content.getname()

   289

                    self.GenerateDataType(var_type)

   290

                else:

   291

                    var_type = var.gettypeAsText()

   292

   293

                config += [("    ", ()),

   294

                           (var.getname(), (tagname, variable_type, var_number, "name")),

   295

                           (" ", ())]

   296

                # Generate variable address if exists

   297

                address = var.getaddress()

   298

                if address:

   299

                    config += [("AT ", ()),

   300

                               (address, (tagname, variable_type, var_number, "location")),

   301

                               (" ", ())]

   302

                config += [(": ", ()),

   303

                           (var.gettypeAsText(), (tagname, variable_type, var_number, "type"))]

   304

                # Generate variable initial value if exists

   305

                initial = var.getinitialValue()

   306

                if initial:

   307

                    config += [(" := ", ()),

   308

                               (self.ComputeValue(initial.getvalue(), var_type), (tagname, variable_type, var_number, "initial value"))]

   309

                config += [(";\n", ())]

   310

                var_number += 1

   311

            config += [("  END_VAR\n", ())]

   312

        # Generate any resource in the configuration

   313

        for resource in configuration.getresource():

   314

            config += self.GenerateResource(resource, configuration.getname())

   315

        config += [("END_CONFIGURATION\n", ())]

   316

        return config

   317

   318

    # Generate a resource from its model

   319

    def GenerateResource(self, resource, config_name):

   320

        tagname = self.Controler.ComputeConfigurationResourceName(config_name, resource.getname())

   321

        resrce = [("\n  RESOURCE ", ()),

   322

                  (resource.getname(), (tagname, "name")),

   323

                  (" ON PLC\n", ())]

   324

        var_number = 0

   325

        # Generate any global variable in configuration

   326

        for varlist in resource.getglobalVars():

   327

            variable_type = errorVarTypes.get("VAR_GLOBAL", "var_local")

   328

            # Generate variable block with modifier

   329

            resrce += [("    VAR_GLOBAL", ())]

   330

            if varlist.getconstant():

   331

                resrce += [(" CONSTANT", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "constant"))]

   332

            elif varlist.getretain():

   333

                resrce += [(" RETAIN", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "retain"))]

   334

            elif varlist.getnonretain():

   335

                resrce += [(" NON_RETAIN", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "non_retain"))]

   336

            resrce += [("\n", ())]

   337

            # Generate any variable of this block

   338

            for var in varlist.getvariable():

   339

                vartype_content = var.gettype().getcontent()

   340

                if vartype_content.getLocalTag() == "derived":

   341

                    var_type = vartype_content.getname()

   342

                    self.GenerateDataType(var_type)

   343

                else:

   344

                    var_type = var.gettypeAsText()

   345

   346

                resrce += [("      ", ()),

   347

                           (var.getname(), (tagname, variable_type, var_number, "name")),

   348

                           (" ", ())]

   349

                address = var.getaddress()

   350

                # Generate variable address if exists

   351

                if address:

   352

                    resrce += [("AT ", ()),

   353

                               (address, (tagname, variable_type, var_number, "location")),

   354

                               (" ", ())]

   355

                resrce += [(": ", ()),

   356

                           (var.gettypeAsText(), (tagname, variable_type, var_number, "type"))]

   357

                # Generate variable initial value if exists

   358

                initial = var.getinitialValue()

   359

                if initial:

   360

                    resrce += [(" := ", ()),

   361

                               (self.ComputeValue(initial.getvalue(), var_type), (tagname, variable_type, var_number, "initial value"))]

   362

                resrce += [(";\n", ())]

   363

                var_number += 1

   364

            resrce += [("    END_VAR\n", ())]

   365

        # Generate any task in the resource

   366

        tasks = resource.gettask()

   367

        task_number = 0

   368

        for task in tasks:

   369

            # Task declaration

   370

            resrce += [("    TASK ", ()),

   371

                       (task.getname(), (tagname, "task", task_number, "name")),

   372

                       ("(", ())]

   373

            args = []

   374

            single = task.getsingle()

   375

            # Single argument if exists

   376

            if single:

   377

                resrce += [("SINGLE := ", ()),

   378

                           (single, (tagname, "task", task_number, "single")),

   379

                           (",", ())]

   380

            # Interval argument if exists

   381

            interval = task.getinterval()

   382

            if interval:

   383

                resrce += [("INTERVAL := ", ()),

   384

                           (interval, (tagname, "task", task_number, "interval")),

   385

                           (",", ())]

   386

##                resrce += [("INTERVAL := t#", ())]

   387

##                if interval.hour != 0:

   388

##                    resrce += [("%dh"%interval.hour, (tagname, "task", task_number, "interval", "hour"))]

   389

##                if interval.minute != 0:

   390

##                    resrce += [("%dm"%interval.minute, (tagname, "task", task_number, "interval", "minute"))]

   391

##                if interval.second != 0:

   392

##                    resrce += [("%ds"%interval.second, (tagname, "task", task_number, "interval", "second"))]

   393

##                if interval.microsecond != 0:

   394

##                    resrce += [("%dms"%(interval.microsecond / 1000), (tagname, "task", task_number, "interval", "millisecond"))]

   395

##                resrce += [(",", ())]

   396

            # Priority argument

   397

            resrce += [("PRIORITY := ", ()), 

   398

                       ("%d"%task.getpriority(), (tagname, "task", task_number, "priority")),

   399

                       (");\n", ())]

   400

            task_number += 1

   401

        instance_number = 0

   402

        # Generate any program assign to each task

   403

        for task in tasks:

   404

            for instance in task.getpouInstance():

   405

                resrce += [("    PROGRAM ", ()),

   406

                           (instance.getname(), (tagname, "instance", instance_number, "name")),

   407

                           (" WITH ", ()),

   408

                           (task.getname(), (tagname, "instance", instance_number, "task")),

   409

                           (" : ", ()),

   410

                           (instance.gettypeName(), (tagname, "instance", instance_number, "type")),

   411

                           (";\n", ())]

   412

                instance_number += 1

   413

        # Generate any program assign to no task

   414

        for instance in resource.getpouInstance():

   415

            resrce += [("    PROGRAM ", ()),

   416

                           (instance.getname(), (tagname, "instance", instance_number, "name")),

   417

                           (" : ", ()),

   418

                           (instance.gettypeName(), (tagname, "instance", instance_number, "type")),

   419

                           (";\n", ())]

   420

            instance_number += 1

   421

        resrce += [("  END_RESOURCE\n", ())]

   422

        return resrce

   423

   424

    # Generate the entire program for current project

   425

    def GenerateProgram(self):        

   426

        # Find all data types defined

   427

        for datatype in self.Project.getdataTypes():

   428

            self.DatatypeComputed[datatype.getname()] = False

   429

        # Find all data types defined

   430

        for pou in self.Project.getpous():

   431

            self.PouComputed[pou.getname()] = False

   432

        # Generate data type declaration structure if there is at least one data 

   433

        # type defined

   434

        if len(self.DatatypeComputed) > 0:

   435

            self.Program += [("TYPE\n", ())]

   436

            # Generate every data types defined

   437

            for datatype_name in self.DatatypeComputed.keys():

   438

                self.GenerateDataType(datatype_name)

   439

            self.Program += [("END_TYPE\n\n", ())]

   440

        # Generate every POUs defined

   441

        for pou_name in self.PouComputed.keys():

   442

            self.GeneratePouProgram(pou_name)

   443

        # Generate every configurations defined

   444

        for config in self.Project.getconfigurations():

   445

            self.Program += self.GenerateConfiguration(config)

   446

   447

    # Return generated program

   448

    def GetGeneratedProgram(self):

   449

        return self.Program

   450

   451

   452

#-------------------------------------------------------------------------------

   453

#                           Generator of POU programs

   454

#-------------------------------------------------------------------------------

   455

   456

[ConnectorClass, ContinuationClass, ActionBlockClass] = [

   457

    PLCOpenParser.GetElementClass(instance_name, "commonObjects")

   458

    for instance_name in ["connector", "continuation", "actionBlock"]]

   459

[InVariableClass, InOutVariableClass, OutVariableClass, BlockClass] = [

   460

    PLCOpenParser.GetElementClass(instance_name, "fbdObjects")

   461

    for instance_name in ["inVariable", "inOutVariable", "outVariable", "block"]]

   462

[ContactClass, CoilClass, LeftPowerRailClass, RightPowerRailClass] = [

   463

    PLCOpenParser.GetElementClass(instance_name, "ldObjects")

   464

    for instance_name in ["contact", "coil", "leftPowerRail", "rightPowerRail"]]

   465

[StepClass, TransitionClass, JumpStepClass, 

   466

 SelectionConvergenceClass, SelectionDivergenceClass,

   467

 SimultaneousConvergenceClass, SimultaneousDivergenceClass] = [

   468

    PLCOpenParser.GetElementClass(instance_name, "sfcObjects")

   469

    for instance_name in ["step", "transition", "jumpStep", 

   470

        "selectionConvergence", "selectionDivergence",

   471

        "simultaneousConvergence", "simultaneousDivergence"]]

   472

TransitionObjClass = PLCOpenParser.GetElementClass("transition", "transitions")

   473

ActionObjClass = PLCOpenParser.GetElementClass("action", "actions")

   474

   475

class PouProgramGenerator:

   476

   477

    # Create a new POU program generator

   478

    def __init__(self, parent, name, type, errors, warnings):

   479

        # Keep Reference to the parent generator

   480

        self.ParentGenerator = parent

   481

        self.Name = name

   482

        self.Type = type

   483

        self.TagName = self.ParentGenerator.Controler.ComputePouName(name)

   484

        self.CurrentIndent = "  "

   485

        self.ReturnType = None

   486

        self.Interface = []

   487

        self.InitialSteps = []

   488

        self.ComputedBlocks = {}

   489

        self.ComputedConnectors = {}

   490

        self.ConnectionTypes = {}

   491

        self.RelatedConnections = []

   492

        self.SFCNetworks = {"Steps":{}, "Transitions":{}, "Actions":{}}

   493

        self.SFCComputedBlocks = []

   494

        self.ActionNumber = 0

   495

        self.Program = []

   496

        self.Errors = errors

   497

        self.Warnings = warnings

   498

   499

    def GetBlockType(self, type, inputs=None):

   500

        return self.ParentGenerator.Controler.GetBlockType(type, inputs)

   501

   502

    def IndentLeft(self):

   503

        if len(self.CurrentIndent) >= 2:

   504

            self.CurrentIndent = self.CurrentIndent[:-2]

   505

   506

    def IndentRight(self):

   507

        self.CurrentIndent += "  "

   508

   509

    # Generator of unique ID for inline actions

   510

    def GetActionNumber(self):

   511

        self.ActionNumber += 1

   512

        return self.ActionNumber

   513

   514

    # Test if a variable has already been defined

   515

    def IsAlreadyDefined(self, name):

   516

        for list_type, option, located, vars in self.Interface:

   517

            for var_type, var_name, var_address, var_initial in vars:

   518

                if name == var_name:

   519

                    return True

   520

        return False