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 plcopen

    26

from plcopen.structures import *

    27

from types import *

    28

    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

# Helper function for reindenting text

    43

def ReIndentText(text, nb_spaces):

    44

    compute = ""

    45

    lines = text.splitlines()

    46

    if len(lines) > 0:

    47

        line_num = 0

    48

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

    49

            line_num += 1

    50

        if line_num < len(lines):

    51

            spaces = 0

    52

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

    53

                spaces += 1

    54

            indent = ""

    55

            for i in xrange(spaces, nb_spaces):

    56

                indent += " "

    57

            for line in lines:

    58

                if line != "":

    59

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

    60

                else:

    61

                    compute += "\n"

    62

    return compute

    63

    64

def SortInstances(a, b):

    65

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

    66

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

    67

    if abs(ax - ay) < 10:

    68

        return ax.__cmp__(bx)

    69

    else:

    70

        return ay.__cmp__(by)

    71

    72

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

    73

#                  Specific exception for PLC generating errors

    74

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

    75

    76

    77

class PLCGenException(Exception):

    78

    pass

    79

    80

    81

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

    82

#                           Generator of PLC program

    83

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

    84

    85

    86

class ProgramGenerator:

    87

    88

    # Create a new PCL program generator

    89

    def __init__(self, controler, project):

    90

        # Keep reference of the controler and project

    91

        self.Controler = controler

    92

        self.Project = project

    93

        # Reset the internal variables used to generate PLC programs

    94

        self.Program = []

    95

        self.DatatypeComputed = {}

    96

        self.PouComputed = {}

    97

    98

    # Compute value according to type given

    99

    def ComputeValue(self, value, var_type):

   100

        base_type = self.Controler.GetBaseType(var_type)

   101

        if base_type == "STRING":

   102

            return "'%s'"%value

   103

        elif base_type == "WSTRING":

   104

            return "\"%s\""%value

   105

        return value

   106

   107

    # Generate a data type from its name

   108

    def GenerateDataType(self, datatype_name):

   109

        # Verify that data type hasn't been generated yet

   110

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

   111

            # If not mark data type as computed

   112

            self.DatatypeComputed[datatype_name] = True

   113

   114

            # Getting datatype model from project

   115

            datatype = self.Project.getdataType(datatype_name)

   116

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

   117

            datatype_def = [("  ", ()), 

   118

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

   119

                            (" : ", ())]

   120

            basetype_content = datatype.baseType.getcontent()

   121

            # Data type derived directly from a string type 

   122

            if basetype_content["name"] in ["string", "wstring"]:

   123

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

   124

            # Data type derived directly from a user defined type 

   125

            elif basetype_content["name"] == "derived":

   126

                basetype_name = basetype_content["value"].getname()

   127

                self.GenerateDataType(basetype_name)

   128

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

   129

            # Data type is a subrange

   130

            elif basetype_content["name"] in ["subrangeSigned", "subrangeUnsigned"]:

   131

                base_type = basetype_content["value"].baseType.getcontent()

   132

                # Subrange derived directly from a user defined type 

   133

                if base_type["name"] == "derived":

   134

                    basetype_name = base_type["value"].getname()

   135

                    self.GenerateDataType(basetype_name)

   136

                # Subrange derived directly from an elementary type 

   137

                else:

   138

                    basetype_name = base_type["name"]

   139

                min_value = basetype_content["value"].range.getlower()

   140

                max_value = basetype_content["value"].range.getupper()

   141

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

   142

                                 (" (", ()),

   143

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

   144

                                 ("..", ()),

   145

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

   146

                                 (")",())]

   147

            # Data type is an enumerated type

   148

            elif basetype_content["name"] == "enum":

   149

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

   150

                          for i, value in enumerate(basetype_content["value"].values.getvalue())]

   151

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

   152

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

   153

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

   154

            # Data type is an array

   155

            elif basetype_content["name"] == "array":

   156

                base_type = basetype_content["value"].baseType.getcontent()

   157

                # Array derived directly from a user defined type 

   158

                if base_type["name"] == "derived":

   159

                    basetype_name = base_type["value"].getname()

   160

                    self.GenerateDataType(basetype_name)

   161

                # Array derived directly from a string type 

   162

                elif base_type["name"] in ["string", "wstring"]:

   163

                    basetype_name = base_type["name"].upper()

   164

                # Array derived directly from an elementary type 

   165

                else:

   166

                    basetype_name = base_type["name"]

   167

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

   168

                               ("..", ()),

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

            # Data type derived directly from a elementary type 

   176

            else:

   177

                datatype_def += [(basetype_content["name"], (tagname, "base"))]

   178

            # Data type has an initial value

   179

            if datatype.initialValue is not None:

   180

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

   181

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

   182

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

   183

            return datatype_def

   184

   185

    # Generate a POU from its name

   186

    def GeneratePouProgram(self, pou_name):

   187

        # Verify that POU hasn't been generated yet

   188

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

   189

            # If not mark POU as computed

   190

            self.PouComputed[pou_name] = True

   191

   192

            # Getting POU model from project

   193

            pou = self.Project.getpou(pou_name)

   194

            pou_type = pou.getpouType()

   195

            # Verify that POU type exists

   196

            if pou_type in pouTypeNames:

   197

                # Create a POU program generator

   198

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

   199

                program = pou_program.GenerateProgram(pou)

   200

                self.Program += program

   201

            else:

   202

                raise PLCGenException, "Undefined pou type \"%s\""%pou_type

   203

   204

    # Generate a configuration from its model

   205

    def GenerateConfiguration(self, configuration):

   206

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

   207

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

   208

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

   209

                  ("\n", ())]

   210

        var_number = 0

   211

        # Generate any global variable in configuration

   212

        for varlist in configuration.getglobalVars():

   213

            # Generate variable block with modifier

   214

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

   215

            if varlist.getretain():

   216

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

   217

            if varlist.getconstant():

   218

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

   219

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

   220

            # Generate any variable of this block

   221

            for var in varlist.getvariable():

   222

                vartype_content = var.gettype().getcontent()

   223

                # Variable type is a user data type

   224

                if vartype_content["name"] == "derived":

   225

                    var_type = vartype_content["value"].getname()

   226

                # Variable type is a string type

   227

                elif vartype_content["name"] in ["string", "wstring"]:

   228

                    var_type = vartype_content["name"].upper()

   229

                # Variable type is an elementary type

   230

                else:

   231

                    var_type = vartype_content["name"]

   232

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

   233

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

   234

                           (" ", ())]

   235

                # Generate variable address if exists

   236

                address = var.getaddress()

   237

                if address:

   238

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

   239

                               (address, (tagname, "variable", var_number, "address")),

   240

                               (" ", ())]

   241

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

   242

                           (var_type, (tagname, "variable", var_number, "type"))]

   243

                # Generate variable initial value if exists

   244

                initial = var.getinitialValue()

   245

                if initial:

   246

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

   247

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

   248

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

   249

                var_number += 1

   250

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

   251

        # Generate any resource in the configuration

   252

        for resource in configuration.getresource():

   253

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

   254

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

   255

        return config

   256

   257

    # Generate a resource from its model

   258

    def GenerateResource(self, resource, config_name):

   259

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

   260

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

   261

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

   262

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

   263

        var_number = 0

   264

        # Generate any global variable in configuration

   265

        for varlist in resource.getglobalVars():

   266

            # Generate variable block with modifier

   267

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

   268

            if varlist.getretain():

   269

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

   270

            if varlist.getconstant():

   271

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

   272

            resrce += "\n"

   273

            # Generate any variable of this block

   274

            for var in varlist.getvariable():

   275

                vartype_content = var.gettype().getcontent()

   276

                # Variable type is a user data type

   277

                if vartype_content["name"] == "derived":

   278

                    var_type = vartype_content["value"].getname()

   279

                # Variable type is a string type

   280

                elif vartype_content["name"] in ["string", "wstring"]:

   281

                    var_type = vartype_content["name"].upper()

   282

                # Variable type is an elementary type

   283

                else:

   284

                    var_type = vartype_content["name"]

   285

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

   286

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

   287

                           (" ", ())]

   288

                address = var.getaddress()

   289

                # Generate variable address if exists

   290

                if address:

   291

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

   292

                               (address, (tagname, "variable", var_number, "address")),

   293

                               (" ", ())]

   294

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

   295

                           (var_type, (tagname, "variable", var_number, "type"))]

   296

                # Generate variable initial value if exists

   297

                initial = var.getinitialValue()

   298

                if initial:

   299

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

   300

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

   301

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

   302

                var_number += 1

   303

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

   304

        # Generate any task in the resource

   305

        tasks = resource.gettask()

   306

        task_number = 0

   307

        for task in tasks:

   308

            # Task declaration

   309

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

   310

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

   311

                       ("(", ())]

   312

            args = []

   313

            single = task.getsingle()

   314

            # Single argument if exists

   315

            if single:

   316

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

   317

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

   318

                           (",", ())]

   319

            # Interval argument if exists

   320

            interval = task.getinterval()

   321

            if interval:

   322

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

   323

                if interval.hour != 0:

   324

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

   325

                if interval.minute != 0:

   326

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

   327

                if interval.second != 0:

   328

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

   329

                if interval.microsecond != 0:

   330

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

   331

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

   332

            # Priority argument

   333

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

   334

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

   335

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

   336

            task_number += 1

   337

        instance_number = 0

   338

        # Generate any program assign to each task

   339

        for task in tasks:

   340

            for instance in task.getpouInstance():

   341

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

   342

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

   343

                           (" WITH ", ()),

   344

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

   345

                           (" : ", ()),

   346

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

   347

                           (";\n", ())]

   348

                instance_number += 1

   349

        # Generate any program assign to no task

   350

        for instance in resource.getpouInstance():

   351

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

   352

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

   353

                           (" : ", ()),

   354

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

   355

                           (";\n", ())]

   356

            instance_number += 1

   357

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

   358

        return resrce

   359

   360

    # Generate the entire program for current project

   361

    def GenerateProgram(self):        

   362

        # Find all data types defined

   363

        for datatype in self.Project.getdataTypes():

   364

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

   365

        # Find all data types defined

   366

        for pou in self.Project.getpous():

   367

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

   368

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

   369

        # type defined

   370

        if len(self.DatatypeComputed) > 0:

   371

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

   372

            # Generate every data types defined

   373

            for datatype_name in self.DatatypeComputed.keys():

   374

                self.Program += self.GenerateDataType(datatype_name)

   375

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

   376

        # Generate every POUs defined

   377

        for pou_name in self.PouComputed.keys():

   378

            self.GeneratePouProgram(pou_name)

   379

        # Generate every configurations defined

   380

        for config in self.Project.getconfigurations():

   381

            self.Program += self.GenerateConfiguration(config)

   382

   383

    # Return generated program

   384

    def GetGeneratedProgram(self):

   385

        return self.Program

   386

   387

   388

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

   389

#                           Generator of POU programs

   390

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

   391

   392

   393

class PouProgramGenerator:

   394

   395

    # Create a new POU program generator

   396

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

   397

        # Keep Reference to the parent generator

   398

        self.ParentGenerator = parent

   399

        self.Name = name

   400

        self.Type = type

   401

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

   402

        self.CurrentIndent = "  "

   403

        self.ReturnType = None

   404

        self.Interface = []

   405

        self.InitialSteps = []

   406

        self.ComputedBlocks = {}

   407

        self.ComputedConnectors = {}

   408

        self.ConnectionTypes = {}

   409

        self.RelatedConnections = []

   410

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

   411

        self.SFCComputedBlocks = []

   412

        self.ActionNumber = 0

   413

        self.Program = []

   414

   415

    def GetBlockType(self, type):

   416

        return self.ParentGenerator.Controler.GetBlockType(type)

   417

   418

    def IndentLeft(self):

   419

        if len(self.CurrentIndent) >= 2:

   420

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

   421

   422

    def IndentRight(self):

   423

        self.CurrentIndent += "  "

   424

   425

    # Generator of unique ID for inline actions

   426

    def GetActionNumber(self):

   427

        self.ActionNumber += 1

   428

        return self.ActionNumber

   429

   430

    # Test if a variable has already been defined

   431

    def IsAlreadyDefined(self, name):

   432

        for list_type, retain, constant, located, vars in self.Interface:

   433

            for var_type, var_name, var_address, var_initial in vars:

   434

                if name == var_name:

   435

                    return True

   436

        return False

   437

   438

    # Return the type of a variable defined in interface

   439

    def GetVariableType(self, name):

   440

        for list_type, retain, constant, located, vars in self.Interface:

   441

            for var_type, var_name, var_address, var_initial in vars:

   442

                if name == var_name:

   443

                    return var_type

   444

        return None

   445

   446

    # Return connectors linked by a connection to the given connector

   447

    def GetConnectedConnector(self, connector, body):

   448

        links = connector.getconnections()

   449

        if links and len(links) == 1:

   450

            return self.GetLinkedConnector(links[0], body)

   451

        return None        

   452

   453

    def GetLinkedConnector(self, link, body):

   454

        parameter = link.getformalParameter()

   455

        instance = body.getcontentInstance(link.getrefLocalId())

   456

        if isinstance(instance, (plcopen.fbdObjects_inVariable, plcopen.fbdObjects_inOutVariable, plcopen.commonObjects_continuation, plcopen.ldObjects_contact, plcopen.ldObjects_coil)):

   457

            return instance.connectionPointOut

   458

        elif isinstance(instance, plcopen.fbdObjects_block):

   459

            outputvariables = instance.outputVariables.getvariable()

   460

            if len(outputvariables) == 1:

   461

                return outputvariables[0].connectionPointOut

   462

            elif parameter:

   463

                for variable in outputvariables:

   464

                    if variable.getformalParameter() == parameter:

   465

                        return variable.connectionPointOut

   466

            else:

   468

                for variable in outputvariables:

   469

                    relposition = variable.connectionPointOut.getrelPositionXY()

   470

                    blockposition = instance.getposition()

   471

                    if point.x == blockposition.x + relposition[0] and point.y == blockposition.y + relposition[1]:

   472

                        return variable.connectionPointOut

   473

        elif isinstance(instance, plcopen.ldObjects_leftPowerRail):

   474

            outputconnections = instance.getconnectionPointOut()

   475

            if len(outputconnections) == 1:

   476

                return outputconnections[0]

   477

            else:

   478

                point = link.getposition()[-1]

   479

                for outputconnection in outputconnections:

   480

                    relposition = outputconnection.getrelPositionXY()

   481

                    powerrailposition = instance.getposition()

   482

                    if point.x == powerrailposition.x + relposition[0] and point.y == powerrailposition.y + relposition[1]:

   483

                        return outputconnection

   484

        return None

   485

   486

    def ExtractRelatedConnections(self, connection):

   487

        for i, related in enumerate(self.RelatedConnections):

   488

            if connection in related:

   489

                return self.RelatedConnections.pop(i)

   490

        return [connection]

   491

   492

    def ComputeInterface(self, pou):

   493

        interface = pou.getinterface()