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

    85

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

    86

#                  Specific exception for PLC generating errors

    87

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

    88

    89

    90

class PLCGenException(Exception):

    91

    pass

    92

    93

    94

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

    95

#                           Generator of PLC program

    96

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

    97

    98

    99

class ProgramGenerator:

   100

   101

    # Create a new PCL program generator

   102

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

   103

        # Keep reference of the controler and project

   104

        self.Controler = controler

   105

        self.Project = project

   106

        # Reset the internal variables used to generate PLC programs

   107

        self.Program = []

   108

        self.DatatypeComputed = {}

   109

        self.PouComputed = {}

   110

        self.Errors = errors

   111

        self.Warnings = warnings

   112

   113

    # Compute value according to type given

   114

    def ComputeValue(self, value, var_type):

   115

        base_type = self.Controler.GetBaseType(var_type)

   116

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

   117

            return "'%s'"%value

   118

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

   119

            return "\"%s\""%value

   120

        return value

   121

   122

    # Generate a data type from its name

   123

    def GenerateDataType(self, datatype_name):

   124

        # Verify that data type hasn't been generated yet

   125

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

   126

            # If not mark data type as computed

   127

            self.DatatypeComputed[datatype_name] = True

   128

   129

            # Getting datatype model from project

   130

            datatype = self.Project.getdataType(datatype_name)

   131

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

   132

            datatype_def = [("  ", ()), 

   133

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

   134

                            (" : ", ())]

   135

            basetype_content = datatype.baseType.getcontent()

   136

            basetype_content_type = basetype_content.getLocalTag()

   137

            # Data type derived directly from a user defined type 

   138

            if basetype_content_type == "derived":

   139

                basetype_name = basetype_content.getname()

   140

                self.GenerateDataType(basetype_name)

   141

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

   142

            # Data type is a subrange

   143

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

   144

                base_type = basetype_content.baseType.getcontent()

   145

                base_type_type = base_type.getLocalTag()

   146

                # Subrange derived directly from a user defined type 

   147

                if base_type_type == "derived":

   148

                    basetype_name = base_type_type.getname()

   149

                    self.GenerateDataType(basetype_name)

   150

                # Subrange derived directly from an elementary type 

   151

                else:

   152

                    basetype_name = base_type_type

   153

                min_value = basetype_content.range.getlower()

   154

                max_value = basetype_content.range.getupper()

   155

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

   156

                                 (" (", ()),

   157

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

   158

                                 ("..", ()),

   159

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

   160

                                 (")",())]

   161

            # Data type is an enumerated type

   162

            elif basetype_content_type == "enum":

   163

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

   164

                          for i, value in enumerate(

   165

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

   166

                                  namespaces=PLCOpenParser.NSMAP))]

   167

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

   168

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

   169

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

   170

            # Data type is an array

   171

            elif basetype_content_type == "array":

   172

                base_type = basetype_content.baseType.getcontent()

   173

                base_type_type = base_type.getLocalTag()

   174

                # Array derived directly from a user defined type 

   175

                if base_type_type == "derived":

   176

                    basetype_name = base_type.getname()

   177

                    self.GenerateDataType(basetype_name)

   178

                # Array derived directly from an elementary type 

   179

                else:

   180

                    basetype_name = base_type_type.upper()

   181

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

   182

                               ("..", ()),

   183

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

   184

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

   185

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

   186

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

   187

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

   188

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

   189

            # Data type is a structure

   190

            elif basetype_content_type == "struct":

   191

                elements = []

   192

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

   193

                    element_type = element.type.getcontent()

   194

                    element_type_type = element_type.getLocalTag()

   195

                    # Structure element derived directly from a user defined type 

   196

                    if element_type_type == "derived":

   197

                        elementtype_name = element_type.getname()

   198

                        self.GenerateDataType(elementtype_name)

   199

                    elif element_type_type == "array":

   200

                        base_type = element_type.baseType.getcontent()

   201

                        base_type_type = base_type.getLocalTag()

   202

                        # Array derived directly from a user defined type 

   203

                        if base_type_type == "derived":

   204

                            basetype_name = base_type.getname()

   205

                            self.GenerateDataType(basetype_name)

   206

                        # Array derived directly from an elementary type 

   207

                        else:

   208

                            basetype_name = base_type_type.upper()

   209

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

   210

                                      for dimension in element_type.getdimension()]

   211

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

   212

                    # Structure element derived directly from an elementary type 

   213

                    else:

   214

                        elementtype_name = element_type_type.upper()

   215

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

   216

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

   217

                                    (" : ", ()),

   218

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

   219

                    if element.initialValue is not None:

   220

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

   221

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

   222

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

   223

                    elements.append(element_text)

   224

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

   225

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

   226

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

   227

            # Data type derived directly from a elementary type 

   228

            else:

   229

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

   230

            # Data type has an initial value

   231

            if datatype.initialValue is not None:

   232

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

   233

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

   234

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

   235

            self.Program += datatype_def

   236

   237

    # Generate a POU from its name

   238

    def GeneratePouProgram(self, pou_name):

   239

        # Verify that POU hasn't been generated yet

   240

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

   241

            # If not mark POU as computed

   242

            self.PouComputed[pou_name] = True

   243

   244

            # Getting POU model from project

   245

            pou = self.Project.getpou(pou_name)

   246

            pou_type = pou.getpouType()

   247

            # Verify that POU type exists

   248

            if pouTypeNames.has_key(pou_type):

   249

                # Create a POU program generator

   250

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

   251

                program = pou_program.GenerateProgram(pou)

   252

                self.Program += program

   253

            else:

   254

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

   255

   256

    # Generate a POU defined and used in text

   257

    def GeneratePouProgramInText(self, text):

   258

        for pou_name in self.PouComputed.keys():

   259

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

   260

            if model.search(text) is not None:

   261

                self.GeneratePouProgram(pou_name)

   262

   263

    # Generate a configuration from its model

   264

    def GenerateConfiguration(self, configuration):

   265

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

   266

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

   267

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

   268

                  ("\n", ())]

   269

        var_number = 0

   270

   271

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

   272

   273

        extra_variables = self.Controler.GetConfigurationExtraVariables()

   274

        if len(extra_variables) > 0:

   275

            if len(varlists) == 0:

   276

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

   277

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

   278

   279

        # Generate any global variable in configuration

   280

        for varlist, varlist_variables in varlists:

   281

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

   282

            # Generate variable block with modifier

   283

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

   284

            if varlist.getconstant():

   285

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

   286

            elif varlist.getretain():

   287

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

   288

            elif varlist.getnonretain():

   289

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

   290

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

   291

            # Generate any variable of this block

   292

            for var in varlist_variables:

   293

                vartype_content = var.gettype().getcontent()

   294

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

   295

                    var_type = vartype_content.getname()

   296

                    self.GenerateDataType(var_type)

   297

                else:

   298

                    var_type = var.gettypeAsText()

   299

   300

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

   301

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

   302

                           (" ", ())]

   303

                # Generate variable address if exists

   304

                address = var.getaddress()

   305

                if address:

   306

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

   307

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

   308

                               (" ", ())]

   309

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

   310

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

   311

                # Generate variable initial value if exists

   312

                initial = var.getinitialValue()

   313

                if initial:

   314

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

   315

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

   316

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

   317

                var_number += 1

   318

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

   319

        # Generate any resource in the configuration

   320

        for resource in configuration.getresource():

   321

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

   322

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

   323

        return config

   324

   325

    # Generate a resource from its model

   326

    def GenerateResource(self, resource, config_name):

   327

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

   328

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

   329

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

   330

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

   331

        var_number = 0

   332

        # Generate any global variable in configuration

   333

        for varlist in resource.getglobalVars():

   334

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

   335

            # Generate variable block with modifier

   336

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

   337

            if varlist.getconstant():

   338

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

   339

            elif varlist.getretain():

   340

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

   341

            elif varlist.getnonretain():

   342

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

   343

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

   344

            # Generate any variable of this block

   345

            for var in varlist.getvariable():

   346

                vartype_content = var.gettype().getcontent()

   347

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

   348

                    var_type = vartype_content.getname()

   349

                    self.GenerateDataType(var_type)

   350

                else:

   351

                    var_type = var.gettypeAsText()

   352

   353

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

   354

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

   355

                           (" ", ())]

   356

                address = var.getaddress()

   357

                # Generate variable address if exists

   358

                if address:

   359

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

   360

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

   361

                               (" ", ())]

   362

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

   363

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

   364

                # Generate variable initial value if exists

   365

                initial = var.getinitialValue()

   366

                if initial:

   367

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

   368

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

   369

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

   370

                var_number += 1

   371

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

   372

        # Generate any task in the resource

   373

        tasks = resource.gettask()

   374

        task_number = 0

   375

        for task in tasks:

   376

            # Task declaration

   377

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

   378

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

   379

                       ("(", ())]

   380

            args = []

   381

            single = task.getsingle()

   382

            # Single argument if exists

   383

            if single:

   384

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

   385

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

   386

                           (",", ())]

   387

            # Interval argument if exists

   388

            interval = task.getinterval()

   389

            if interval:

   390

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

   391

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

   392

                           (",", ())]

   393

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

   394

##                if interval.hour != 0:

   395

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

   396

##                if interval.minute != 0:

   397

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

   398

##                if interval.second != 0:

   399

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

   400

##                if interval.microsecond != 0:

   401

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

   402

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

   403

            # Priority argument

   404

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

   405

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

   406

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

   407

            task_number += 1

   408

        instance_number = 0

   409

        # Generate any program assign to each task

   410

        for task in tasks:

   411

            for instance in task.getpouInstance():

   412

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

   413

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

   414

                           (" WITH ", ()),

   415

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

   416

                           (" : ", ()),

   417

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

   418

                           (";\n", ())]

   419

                instance_number += 1

   420

        # Generate any program assign to no task

   421

        for instance in resource.getpouInstance():

   422

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

   423

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

   424

                           (" : ", ()),

   425

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

   426

                           (";\n", ())]

   427

            instance_number += 1

   428

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

   429

        return resrce

   430

   431

    # Generate the entire program for current project

   432

    def GenerateProgram(self):        

   433

        # Find all data types defined

   434

        for datatype in self.Project.getdataTypes():

   435

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

   436

        # Find all data types defined

   437

        for pou in self.Project.getpous():

   438

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

   439

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

   440

        # type defined

   441

        if len(self.DatatypeComputed) > 0:

   442

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

   443

            # Generate every data types defined

   444

            for datatype_name in self.DatatypeComputed.keys():

   445

                self.GenerateDataType(datatype_name)

   446

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

   447

        # Generate every POUs defined

   448

        for pou_name in self.PouComputed.keys():

   449

            self.GeneratePouProgram(pou_name)

   450

        # Generate every configurations defined

   451

        for config in self.Project.getconfigurations():

   452

            self.Program += self.GenerateConfiguration(config)

   453

   454

    # Return generated program

   455

    def GetGeneratedProgram(self):

   456

        return self.Program

   457

   458

   459

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

   460

#                           Generator of POU programs

   461

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

   462

   463

[ConnectorClass, ContinuationClass, ActionBlockClass] = [

   464

    PLCOpenParser.GetElementClass(instance_name, "commonObjects")

   465

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

   466

[InVariableClass, InOutVariableClass, OutVariableClass, BlockClass] = [

   467

    PLCOpenParser.GetElementClass(instance_name, "fbdObjects")

   468

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

   469

[ContactClass, CoilClass, LeftPowerRailClass, RightPowerRailClass] = [

   470

    PLCOpenParser.GetElementClass(instance_name, "ldObjects")

   471

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

   472

[StepClass, TransitionClass, JumpStepClass, 

   473

 SelectionConvergenceClass, SelectionDivergenceClass,

   474

 SimultaneousConvergenceClass, SimultaneousDivergenceClass] = [

   475

    PLCOpenParser.GetElementClass(instance_name, "sfcObjects")

   476

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

   477

        "selectionConvergence", "selectionDivergence",

   478

        "simultaneousConvergence", "simultaneousDivergence"]]

   479

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

   480

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

   481

   482

class PouProgramGenerator:

   483

   484

    # Create a new POU program generator

   485

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

   486

        # Keep Reference to the parent generator

   487

        self.ParentGenerator = parent

   488

        self.Name = name

   489

        self.Type = type

   490

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

   491

        self.CurrentIndent = "  "

   492

        self.ReturnType = None

   493

        self.Interface = []

   494

        self.InitialSteps = []

   495

        self.ComputedBlocks = {}

   496

        self.ComputedConnectors = {}

   497

        self.ConnectionTypes = {}

   498

        self.RelatedConnections = []

   499

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

   500

        self.SFCComputedBlocks = []

   501

        self.ActionNumber = 0

   502

        self.Program = []

   503

        self.Errors = errors

   504

        self.Warnings = warnings

   505

   506

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

   507

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

   508

   509

    def IndentLeft(self):

   510

        if len(self.CurrentIndent) >= 2:

   511

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

   512

   513

    def IndentRight(self):

   514

        self.CurrentIndent += "  "

   515

   516

    # Generator of unique ID for inline actions

   517

    def GetActionNumber(self):

   518

        self.ActionNumber += 1

   519

        return self.ActionNumber

   520