1

#!/usr/bin/env python

     2

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

     3

     4

import string, os, sys

     5

     6

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

     7

#based on the plcopen standard. 

     8

#

     9

#Copyright (C): Edouard TISSERANT and Laurent BESSARD

    10

#

    11

#See COPYING file for copyrights details.

    12

#

    13

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

    14

#modify it under the terms of the GNU General Public

    15

#License as published by the Free Software Foundation; either

    16

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

    17

#

    18

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

    19

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

    20

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

    21

#Lesser General Public License for more details.

    22

#

    23

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

    24

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

    25

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

    26

    27

    28

LANGUAGES = ["IL","ST","FBD","LD","SFC"]

    29

    30

    31

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

    32

#                        Function Block Types definitions

    33

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

    34

    35

    36

"""

    37

Ordored list of common Function Blocks defined in the IEC 61131-3

    38

Each block have this attributes:

    39

    - "name" : The block name

    40

    - "type" : The block type. It can be "function", "functionBlock" or "program"

    41

    - "extensible" : Boolean that define if the block is extensible

    42

    - "inputs" : List of the block inputs

    43

    - "outputs" : List of the block outputs

    44

    - "comment" : Comment that will be displayed in the block popup

    45

Inputs and outputs are a tuple of characteristics that are in order:

    46

    - The name

    47

    - The data type

    48

    - The default modifier which can be "none", "negated", "rising" or "falling"

    49

"""

    50

    51

BlockTypes = [{"name" : "Standard function blocks", "list":

    52

               [{"name" : "SR", "type" : "functionBlock", "extensible" : False, 

    53

                    "inputs" : [("S1","BOOL","none"),("R","BOOL","none")], 

    54

                    "outputs" : [("Q1","BOOL","none")],

    55

                    "comment" : "SR bistable\nThe SR bistable is a latch where the Set dominates."},

    56

                {"name" : "RS", "type" : "functionBlock", "extensible" : False, 

    57

                    "inputs" : [("S","BOOL","none"),("R1","BOOL","none")], 

    58

                    "outputs" : [("Q1","BOOL","none")],

    59

                    "comment" : "RS bistable\nThe RS bistable is a latch where the Reset dominates."},

    60

                {"name" : "SEMA", "type" : "functionBlock", "extensible" : False, 

    61

                    "inputs" : [("CLAIM","BOOL","none"),("RELEASE","BOOL","none")], 

    62

                    "outputs" : [("BUSY","BOOL","none")],

    63

                    "comment" : "Semaphore\nThe semaphore provides a mechanism to allow software elements mutually exclusive access to certain ressources."},

    64

                {"name" : "R_TRIG", "type" : "functionBlock", "extensible" : False, 

    65

                    "inputs" : [("CLK","BOOL","none")], 

    66

                    "outputs" : [("Q","BOOL","none")],

    67

                    "comment" : "Rising edge detector\nThe output produces a single pulse when a rising edge is detected."},

    68

                {"name" : "F_TRIG", "type" : "functionBlock", "extensible" : False, 

    69

                    "inputs" : [("CLK","BOOL","none")], 

    70

                    "outputs" : [("Q","BOOL","none")],

    71

                    "comment" : "Falling edge detector\nThe output produces a single pulse when a falling edge is detected."},

    72

                {"name" : "CTU", "type" : "functionBlock", "extensible" : False, 

    73

                    "inputs" : [("CU","BOOL","rising"),("R","BOOL","none"),("PV","INT","none")], 

    74

                    "outputs" : [("Q","BOOL","none"),("CV","INT","none")],

    75

                    "comment" : "Up-counter\nThe up-counter can be used to signal when a count has reached a maximum value."},

    76

                {"name" : "CTD", "type" : "functionBlock", "extensible" : False, 

    77

                    "inputs" : [("CD","BOOL","rising"),("LD","BOOL","none"),("PV","INT","none")], 

    78

                    "outputs" : [("Q","BOOL","none"),("CV","INT","none")],

    79

                    "comment" : "Down-counter\nThe down-counter can be used to signal when a count has reached zero, on counting down from a preset value."},

    80

                {"name" : "CTUD", "type" : "functionBlock", "extensible" : False, 

    81

                    "inputs" : [("CU","BOOL","rising"),("CD","BOOL","rising"),("R","BOOL","none"),("LD","BOOL","none"),("PV","INT","none")], 

    82

                    "outputs" : [("QU","BOOL","none"),("QD","BOOL","none"),("CV","INT","none")],

    83

                    "comment" : "Up-down counter\nThe up-down counter has two inputs CU and CD. It can be used to both count up on one input ans down on the other."},

    84

                {"name" : "TP", "type" : "functionBlock", "extensible" : False, 

    85

                    "inputs" : [("IN","BOOL","none"),("PT","TIME","none")], 

    86

                    "outputs" : [("Q","BOOL","none"),("ET","TIME","none")],

    87

                    "comment" : "Pulse timer\nThe pulse timer can be used to generate output pulses of a given time duration."},

    88

                {"name" : "TOF", "type" : "functionBlock", "extensible" : False, 

    89

                    "inputs" : [("IN","BOOL","none"),("PT","TIME","none")], 

    90

                    "outputs" : [("Q","BOOL","none"),("ET","TIME","none")],

    91

                    "comment" : "On-delay timer\nThe on-delay timer can be used to delay setting an output true, for fixed period after an input becomes true."},

    92

                {"name" : "TON", "type" : "functionBlock", "extensible" : False, 

    93

                    "inputs" : [("IN","BOOL","none"),("PT","TIME","none")], 

    94

                    "outputs" : [("Q","BOOL","none"),("ET","TIME","none")],

    95

                    "comment" : "Off-delay timer\nThe off-delay timer can be used to delay setting an output false, for fixed period after input goes false."},

    96

                {"name" : "RTC", "type" : "functionBlock", "extensible" : False, 

    97

                    "inputs" : [("EN","BOOL","none"),("PDT","DATE_AND_TIME","none")], 

    98

                    "outputs" : [("Q","BOOL","none"),("CDT","DATE_AND_TIME","none")],

    99

                    "comment" : "Real time clock\nThe real time clock has many uses including time stamping, setting dates and times of day in batch reports, in alarm messages and so on."},

   100

                {"name" : "INTEGRAL", "type" : "functionBlock", "extensible" : False, 

   101

                    "inputs" : [("RUN","BOOL","none"),("R1","BOOL","none"),("XIN","REAL","none"),("X0","REAL","none"),("CYCLE","TIME","none")], 

   102

                    "outputs" : [("Q","BOOL","none"),("XOUT","REAL","none")],

   103

                    "comment" : "Integral\nThe integral function block integrates the value of input XIN over time."},

   104

                {"name" : "DERIVATIVE", "type" : "functionBlock", "extensible" : False, 

   105

                    "inputs" : [("RUN","BOOL","none"),("XIN","REAL","none"),("CYCLE","TIME","none")], 

   106

                    "outputs" : [("XOUT","REAL","none")],

   107

                    "comment" : "Derivative\nThe derivative function block produces an output XOUT proportional to the rate of change of the input XIN."},

   108

                {"name" : "PID", "type" : "functionBlock", "extensible" : False, 

   109

                    "inputs" : [("AUTO","BOOL","none"),("PV","REAL","none"),("SP","REAL","none"),("X0","REAL","none"),("KP","REAL","none"),("TR","REAL","none"),("TD","REAL","none"),("CYCLE","TIME","none")], 

   110

                    "outputs" : [("XOUT","REAL","none")],

   111

                    "comment" : "PID\nThe PID (proportional, Integral, Derivative) function block provides the classical three term controller for closed loop control."},

   112

                {"name" : "RAMP", "type" : "functionBlock", "extensible" : False, 

   113

                    "inputs" : [("RUN","BOOL","none"),("X0","REAL","none"),("X1","REAL","none"),("TR","TIME","none"),("CYCLE","TIME","none"),("HOLDBACK","BOOL","none"),("ERROR","REAL","none"),("PV","REAL","none")], 

   114

                    "outputs" : [("RAMP","BOOL","none"),("XOUT","REAL","none")],

   115

                    "comment" : "Ramp\nThe RAMP function block is modelled on example given in the standard but with the addition of a 'Holdback' feature."},

   116

                {"name" : "HYSTERESIS", "type" : "functionBlock", "extensible" : False, 

   117

                    "inputs" : [("XIN1","REAL","none"),("XIN2","REAL","none"),("EPS","REAL","none")], 

   118

                    "outputs" : [("Q","BOOL","none")],

   119

                    "comment" : "Hysteresis\nThe hysteresis function block provides a hysteresis boolean output driven by the difference of two floating point (REAL) inputs XIN1 and XIN2."},

   120

                {"name" : "RATIO_MONITOR", "type" : "functionBlock", "extensible" : False, 

   121

                    "inputs" : [("PV1","REAL","none"),("PV2","REAL","none"),("RATIO","REAL","none"),("TIMON","TIME","none"),("TIMOFF","TIME","none"),("TOLERANCE","BOOL","none"),("RESET","BOOL","none"),("CYCLE","TIME","none")], 

   122

                    "outputs" : [("ALARM","BOOL","none"),("TOTAL_ERR","BOOL","none")],

   123

                    "comment" : "Ratio monitor\nThe ratio_monitor function block checks that one process value PV1 is always a given ratio (defined by input RATIO) of a second process value PV2."},

   124

               ]}

   125

             ]

   126

   127

"""

   128

Function that returns the block definition associated to the block type given

   129

"""

   130

   131

def GetBlockType(type):

   132

    for category in BlockTypes:

   133

        for blocktype in category["list"]:

   134

            if blocktype["name"] == type:

   135

                return blocktype

   136

    return None

   137

   138

   139

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

   140

#                           Data Types definitions

   141

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

   142

   143

"""

   144

Ordored list of common data types defined in the IEC 61131-3

   145

Each type is associated to his direct parent type. It defines then a hierarchy

   146

between type that permits to make a comparison of two types

   147

"""

   148

TypeHierarchy_list = [

   149

    ("ANY", None),

   150

    ("ANY_DERIVED", "ANY"),

   151

    ("ANY_ELEMENTARY", "ANY"),

   152

    ("ANY_MAGNITUDE", "ANY_ELEMENTARY"),

   153

    ("ANY_BIT", "ANY_ELEMENTARY"),

   155

    ("ANY_STRING", "ANY_ELEMENTARY"),

   156

    ("ANY_DATE", "ANY_ELEMENTARY"),

   157

    ("ANY_NUM", "ANY_MAGNITUDE"),

   158

    ("ANY_REAL", "ANY_NUM"),

   159

    ("ANY_INT", "ANY_NUM"),

   162

    ("REAL", "ANY_REAL"),

   163

    ("LREAL", "ANY_REAL"),

   172

    ("TIME", "ANY_MAGNITUDE"),

   173

    ("BOOL", "ANY_BIT"),

   178

    ("STRING", "ANY_STRING"),

   180

    ("DATE", "ANY_DATE"),

   181

    ("TOD", "ANY_DATE"),

   182

    ("DT", "ANY_DATE")]

   183

   184

TypeHierarchy = dict(TypeHierarchy_list)

   185

   186

"""

   187

returns true if the given data type is the same that "reference" meta-type or one of its types.

   188

"""

   189

   190

def IsOfType(test, reference):

   191

    while test != None:

   192

        if test == reference:

   193

            return True

   194

        test = TypeHierarchy[test]

   195

    return False

   196

   197

"""

   198

returns list of all types that correspont to the ANY* meta type

   199

"""

   200

def GetSubTypes(reference):

   201

    return [ typename for typename, parenttype in TypeHierarchy_list if typename[:3] != "ANY" and IsOfType(typename, reference)]

   202

   203

   204

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

   205

#                             Test identifier

   206

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

   207

   208

   209

   210

# Test if identifier is valid

   211

def TestIdentifier(identifier):

   212

     if identifier[0].isdigit():

   213

        return False

   214

     words = identifier.split('_')

   215

     for i, word in enumerate(words):

   216

         if len(word) == 0 and i != 0:

   217

             return False

   218

         if len(word) != 0 and not word.isalnum():

   219

             return False

   220

     return True

   221

   222

   223

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

   224

#                            Languages Keywords

   225

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

   226

   227

   228

# Keywords for Pou Declaration

   229

POU_KEYWORDS = ["FUNCTION", "END_FUNCTION", "FUNCTION_BLOCK", "END_FUNCTION_BLOCK",

   230

 "PROGRAM", "END_PROGRAM", "EN", "ENO", "F_EDGE", "R_EDGE"]

   231

for category in BlockTypes:

   232

    for block in category["list"]:

   233

        if block["name"] not in POU_KEYWORDS:

   234

            POU_KEYWORDS.append(block["name"])

   235

   236

   237

# Keywords for Type Declaration

   238

TYPE_KEYWORDS = ["TYPE", "END_TYPE", "STRUCT", "END_STRUCT", "ARRAY", "OF", "T",

   239

 "D", "TIME_OF_DAY", "DATE_AND_TIME"]

   240

TYPE_KEYWORDS.extend([keyword for keyword in TypeHierarchy.keys() if keyword not in TYPE_KEYWORDS])

   241

   242

   243

# Keywords for Variable Declaration

   244

VAR_KEYWORDS = ["VAR", "VAR_INPUT", "VAR_OUTPUT", "VAR_IN_OUT", "VAR_TEMP", 

   245

 "VAR_EXTERNAL", "END_VAR", "AT", "CONSTANT", "RETAIN", "NON_RETAIN"]

   246

   247

   248

# Keywords for Configuration Declaration

   249

CONFIG_KEYWORDS = ["CONFIGURATION", "END_CONFIGURATION", "RESOURCE", "ON", "END_RESOURCE",

   250

 "PROGRAM", "WITH", "READ_ONLY", "READ_WRITE", "TASK", "VAR_ACCESS", "VAR_CONFIG", 

   251

 "VAR_GLOBAL", "END_VAR"]

   252

   253

   254

# Keywords for Structured Function Chart

   255

SFC_KEYWORDS = ["ACTION", "END_ACTION", "INITIAL_STEP", "STEP", "END_STEP", "TRANSITION",

   256

 "FROM", "TO", "END_TRANSITION"]

   257

   258

   259

# Keywords for Instruction List

   260

IL_KEYWORDS = ["LD", "LDN", "ST", "STN", "S", "R", "AND", "ANDN", "OR", "ORN",

   261

 "XOR", "XORN", "NOT", "ADD", "SUB", "MUL", "DIV", "MOD", "GT", "GE", "EQ", "NE",

   262

 "LE", "LT", "JMP", "JMPC", "JMPNC", "CAL", "CALC", "CALNC", "RET", "RETC", "RETNC"]

   263

   264

   265

# Keywords for Instruction List and Structured Text

   266

ST_KEYWORDS = ["IF", "THEN", "ELSIF", "ELSE", "END_IF", "CASE", "OF", "END_CASE", 

   267

 "FOR", "TO", "BY", "DO", "END_FOR", "WHILE", "DO", "END_WHILE", "REPEAT", "UNTIL", 

   268

 "END_REPEAT", "EXIT", "RETURN", "NOT", "MOD", "AND", "XOR", "OR"]

   269

   270

   271

# All the keywords of IEC

   272

IEC_KEYWORDS = ["E", "TRUE", "FALSE"]

   273

IEC_KEYWORDS.extend([keyword for keyword in POU_KEYWORDS if keyword not in IEC_KEYWORDS])

   274

IEC_KEYWORDS.extend([keyword for keyword in TYPE_KEYWORDS if keyword not in IEC_KEYWORDS])

   275

IEC_KEYWORDS.extend([keyword for keyword in VAR_KEYWORDS if keyword not in IEC_KEYWORDS])

   276

IEC_KEYWORDS.extend([keyword for keyword in CONFIG_KEYWORDS if keyword not in IEC_KEYWORDS])

   277

IEC_KEYWORDS.extend([keyword for keyword in SFC_KEYWORDS if keyword not in IEC_KEYWORDS])

   278

IEC_KEYWORDS.extend([keyword for keyword in IL_KEYWORDS if keyword not in IEC_KEYWORDS])

   279

IEC_KEYWORDS.extend([keyword for keyword in ST_KEYWORDS if keyword not in IEC_KEYWORDS])

   280

   281

   282

   283

"""

   284

take a .csv file and translate it it a "csv_table"

   285

"""            

   286

def csv_file_to_table(file):

   287

    return [ map(string.strip,line.split(';')) for line in file.xreadlines()]

   288

   289

"""

   290

seek into the csv table to a section ( section_name match 1st field )

   291

return the matching row without first field

   292

"""

   293

def find_section(section_name, table):

   294

    fields = [None]

   295

    while(fields[0] != section_name):

   296

        fields = table.pop(0)

   297

    return fields[1:]

   298

   299

"""

   300

extract the standard functions standard parameter names and types...

   301

return a { ParameterName: Type, ...}

   302

"""

   303

def get_standard_funtions_input_variables(table):

   304

    variables = find_section("Standard_functions_variables_types", table)

   305

    standard_funtions_input_variables = {}

   306

    fields = [True,True]

   307

    while(fields[1]):

   308

        fields = table.pop(0)

   309

        variable_from_csv = dict([(champ, val) for champ, val in zip(variables, fields[1:]) if champ!=''])

   310

        standard_funtions_input_variables[variable_from_csv['name']] = variable_from_csv['type']

   311

    return standard_funtions_input_variables

   312

   313

"""

   314

translate .csv file input declaration into PLCOpenEditor interessting values

   315

in : "(ANY_NUM, ANY_NUM)" and { ParameterName: Type, ...}

   316

return [("IN1","ANY_NUM","none"),("IN2","ANY_NUM","none")] 

   317

"""

   318

def csv_input_translate(str_decl, variables, base):

   319

    decl = str_decl.replace('(','').replace(')','').replace(' ','').split(',')

   320

    params = []

   321

   322

    len_of_not_predifined_variable = len([True for param_type in decl if param_type not in variables])

   323

   324

    for param_type in decl:

   325

        if param_type in variables.keys():

   326

            param_name = param_type

   327

            param_type = variables[param_type]

   328

        elif len_of_not_predifined_variable > 1:

   329

            param_name = "IN%d"%base

   330

            base += 1

   331

        else:

   332

            param_name = "IN"

   333

        params.append((param_name, param_type, "none"))

   334

    return params

   335

   336

   339

        (("ANY_NUM","ANY_BIT"),("ANY_NUM","ANY_BIT"), "(%(return_type)s)%(IN_value)s"),

   382

        outs = reduce(lambda a,b: a or b, map(lambda testtype : IsOfType(fdecl["outputs"][0][1],testtype), OutTypes))

   383

        inps = reduce(lambda a,b: a or b, map(lambda testtype : IsOfType(fdecl["inputs"][0][1],testtype), InTypes))

   384

        if inps and outs and fdecl["outputs"][0][1] != fdecl["inputs"][0][1]:

   385

             return Format

   386

   387

    return None

   388

   389

   390

"""

   391

Returns this kind of declaration for all standard functions

   392

   393

            [{"name" : "Numerical", 'list': [   {   

   394

                'baseinputnumber': 1,

   395

                'comment': 'Addition',

   396

                'extensible': True,

   397

                'inputs': [   ('IN1', 'ANY_NUM', 'none'),

   398

                              ('IN2', 'ANY_NUM', 'none')],

   399

                'name': 'ADD',

   400

                'outputs': [('OUT', 'ANY_NUM', 'none')],

   401

                'type': 'function'}, ...... ] },.....]

   402

"""

   403

def get_standard_funtions(table):

   404

   405

    variables = get_standard_funtions_input_variables(table)

   406

   407

    fonctions = find_section("Standard_functions_type",table)

   408

   409

    Standard_Functions_Decl = []

   410

    Current_section = None

   411

   412

    translate = {

   413

            "extensible" : lambda x: {"yes":True, "no":False}[x],

   414

            "inputs" : lambda x:csv_input_translate(x,variables,baseinputnumber),

   415

            "outputs":lambda x:[("OUT",x,"none")]}

   416

   417

    for fields in table:

   418

        if fields[1]:

   419

            # If function section name given

   420

            if fields[0]:

   421

                Current_section = {"name" : fields[0], "list" : []}

   422

                Standard_Functions_Decl.append(Current_section)

   423

                Function_decl_list = []

   424

            if Current_section:

   425

                Function_decl = dict([(champ, val) for champ, val in zip(fonctions, fields[1:]) if champ])

   426

                baseinputnumber = int(Function_decl.get("baseinputnumber",1))

   427

                Function_decl["baseinputnumber"] = baseinputnumber

   428

                for param, value in Function_decl.iteritems():

   429

                    if param in translate:

   430

                        Function_decl[param] = translate[param](value)

   431

                Function_decl["type"] = "function"

   432

   434

                    input_ovrloading_types = GetSubTypes(Function_decl["inputs"][0][1])

   436

                else:

   437

                    input_ovrloading_types = [None]

   438

                    output_types = [None]

   439

   440

                funcdeclname_orig = Function_decl["name"]

   441

                funcdeclname = Function_decl["name"].strip('*_')

   442

                fdc = Function_decl["inputs"][:]

   443

                for intype in input_ovrloading_types:

   444

                    if intype != None:

   445

                        Function_decl["inputs"] = []

   446

                        for decl_tpl in fdc:

   447

                            if IsOfType(intype, decl_tpl[1]):

   448

                                Function_decl["inputs"] += [(decl_tpl[0], intype, decl_tpl[2])]

   449

                            else:

   450

                                Function_decl["inputs"] += [(decl_tpl)]

   451

   452

                            if funcdeclname_orig.startswith('*'):

   453

                                funcdeclin = intype + '_' + funcdeclname 

   454

                            else:

   455

                                funcdeclin = funcdeclname

   456

                    else:

   457

                        funcdeclin = funcdeclname

   458

   459

                    for outype in output_types:

   460

                        if outype != None:

   461

                            decl_tpl = Function_decl["outputs"][0]

   462

                            Function_decl["outputs"] = [ (decl_tpl[0] , outype,  decl_tpl[2])]

   463

                            if funcdeclname_orig.endswith('*'):

   464

                                funcdeclout =  funcdeclin + '_' + outype

   465

                            else:

   466

                                funcdeclout =  funcdeclin

   467

                        else:

   468

                            funcdeclout =  funcdeclin

   469

                        Function_decl["name"] = funcdeclout

   470

   471

   472

                        fdecl = Function_decl

   473

                        res = eval(Function_decl["python_eval_c_code_format"])

   474

   475

                        if res != None :

   476

                            # create the copy of decl dict to be appended to section

   477

                            Function_decl_copy = Function_decl.copy()

   478

                            # Have to generate type description in comment with freshly redefined types

   479

                            Function_decl_copy["comment"] += (

   480

                                "\n (" +

   481

                                str([ " " + fctdecl[1]+":"+fctdecl[0] for fctdecl in Function_decl["inputs"]]).strip("[]").replace("'",'') +

   482

                                " ) => (" +

   483

                                str([ " " + fctdecl[1]+":"+fctdecl[0] for fctdecl in Function_decl["outputs"]]).strip("[]").replace("'",'') +

   484

                                " )")

   485

                            Current_section["list"].append(Function_decl_copy)

   486

                            #pp.pprint(Function_decl_copy)

   487

            else:

   488

                raise "First function must be in a category"

   489

   490

    return Standard_Functions_Decl

   491