1

#!/usr/bin/env python

     2

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

     3

import shutil

     4

import socket

     5

     6

__version__ = "$Revision$"

     7

     8

import os, sys, getopt, wx, tempfile

     9

from types import TupleType, StringType, UnicodeType

    10

    11

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

    12

    13

def Bpath(*args):

    14

    return os.path.join(CWD,*args)

    15

    16

if __name__ == '__main__':

    17

    def usage():

    18

        print "\nUsage of LPCBeremiz.py :"

    19

        print "\n   %s Projectpath Buildpath port\n"%sys.argv[0]

    20

    21

    try:

    22

        opts, args = getopt.getopt(sys.argv[1:], "h", ["help"])

    23

    except getopt.GetoptError:

    24

        # print help information and exit:

    25

        usage()

    26

        sys.exit(2)

    27

    28

    for o, a in opts:

    29

        if o in ("-h", "--help"):

    30

            usage()

    31

            sys.exit()

    32

    33

    if len(args) != 3:

    34

        usage()

    35

        sys.exit()

    36

    else:

    37

        projectOpen = args[0]

    38

        buildpath = args[1]

    39

        try:

    40

            port = int(args[2])

    41

        except:

    42

            usage()

    43

            sys.exit()

    44

    45

    if os.path.exists("LPC_DEBUG"):

    46

        __builtins__.BMZ_DBG = True

    47

    else :

    48

        __builtins__.BMZ_DBG = False

    49

    50

app = wx.PySimpleApp(redirect=BMZ_DBG)

    51

app.SetAppName('beremiz')

    52

wx.InitAllImageHandlers()

    53

    54

# Import module for internationalization

    55

import gettext

    56

import __builtin__

    57

    58

if __name__ == '__main__':

    59

    __builtin__.__dict__['_'] = wx.GetTranslation#unicode_translation

    60

    61

from Beremiz import *

    62

from plugger import PluginsRoot, PlugTemplate, opjimg, connectors

    63

from plcopen.structures import LOCATIONDATATYPES

    64

from PLCControler import LOCATION_PLUGIN, LOCATION_MODULE, LOCATION_GROUP,\

    65

                         LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY

    66

from PLCOpenEditor import IDEFrame, ProjectDialog

    67

    68

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

    69

#                          CANFESTIVAL PLUGIN HACK

    70

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

    71

from plugins.canfestival import canfestival

    72

class LPC_canfestival_config:

    73

    def getCFLAGS(self, *args):

    74

        return ""

    75

    76

    def getLDFLAGS(self, *args):

    77

        return ""

    78

    79

canfestival.local_canfestival_config = LPC_canfestival_config() 

    80

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

    81

#                              LPCModule Class

    82

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

    83

    84

LOCATION_TYPES = {"I": LOCATION_VAR_INPUT,

    85

                  "Q": LOCATION_VAR_OUTPUT,

    86

                  "M": LOCATION_VAR_MEMORY}

    87

    88

LOCATION_DIRS = dict([(dir, size) for size, dir in LOCATION_TYPES.iteritems()])

    89

    90

LOCATION_SIZES = {}

    91

for size, types in LOCATIONDATATYPES.iteritems():

    92

    for type in types:

    93

        LOCATION_SIZES[type] = size

    94

    95

def _GetModuleChildren(module):

    96

    children = []

    97

    for child in module["children"]:

    98

        if child["type"] == LOCATION_GROUP:

    99

            children.extend(child["children"])

   100

        else:

   101

            children.append(child)

   102

    return children

   103

   104

def _GetVariables(module):

   105

    variables = []

   106

    for child in module["children"]:

   107

        if child["type"] in [LOCATION_GROUP, LOCATION_MODULE]:

   108

            variables.extend(_GetVariables(child))

   109

        else:

   110

            variables.append(child)

   111

    return variables

   112

   113

def _GetLastModuleGroup(module):

   114

    group = module

   115

    for child in module["children"]:

   116

        if child["type"] == LOCATION_GROUP:

   117

            group = child

   118

    return group["children"]

   119

   120

def _GetModuleBySomething(module, something, toks):

   121

    for child in _GetModuleChildren(module):

   122

        if child.get(something) == toks[0]:

   123

            if len(toks) > 1:

   124

                return _GetModuleBySomething(child, something, toks[1:])

   125

            return child

   126

    return None

   127

   128

def _GetModuleVariable(module, location, direction):

   129

    for child in _GetModuleChildren(module):

   130

        if child["location"] == location and child["type"] == LOCATION_TYPES[direction]:

   131

            return child

   132

    return None

   133

   134

def _RemoveModuleChild(module, child):

   135

    if child in module["children"]:

   136

        module["children"].remove(child)

   137

    else:

   138

        for group in module["children"]:

   139

            if group["type"] == LOCATION_GROUP and child in group["children"]:

   140

                group["children"].remove(child)

   141

   142

BUS_TEXT = """/* Code generated by LPCBus plugin */

   143

   144

/* LPCBus plugin includes */

   145

#include "app_glue.h"

   146

#ifdef _WINDOWS_H

   147

  #include "iec_types.h"

   148

#else

   149

  #include "iec_std_lib.h"

   150

#endif

   151

   152

%(declare_code)s

   153

   154

/* LPCBus plugin user variables definition */

   155

%(var_decl)s

   156

   157

/* LPCBus plugin functions */

   158

int __init_%(location_str)s(int argc,char **argv)

   159

{

   160

%(init_code)s

   161

  return 0;

   162

}

   163

   164

void __cleanup_%(location_str)s(void)

   165

{

   166

}

   167

   168

void __retrieve_%(location_str)s(void)

   169

{

   170

%(retrieve_code)s

   171

}

   172

   173

void __publish_%(location_str)s(void)

   174

{

   175

%(publish_code)s

   176

}

   177

"""

   178

   179

class LPCBus(object):

   180

   181

    def __init__(self):

   182

        self.VariableLocationTree = []

   183

        self.ResetUsedLocations()

   184

        self.Icon = None

   185

   186

    def __getitem__(self, key):

   187

        if key == "children":

   188

            return self.VariableLocationTree

   189

        raise KeyError, "Only 'children' key is available"

   190

   191

    def SetIcon(self, icon):

   192

        self.Icon = icon

   193

   194

    def _GetChildBySomething(self, something, toks):

   195

        return _GetModuleBySomething({"children" : self.VariableLocationTree}, something, toks)

   196

   197

    def GetBaseTypes(self):

   198

        return self.GetPlugRoot().GetBaseTypes()

   199

   200

    def GetSizeOfType(self, type):

   201

        return LOCATION_SIZES[self.GetPlugRoot().GetBaseType(type)]

   202

   203

    def _GetVariableLocationTree(self, current_location, infos):

   204

        if infos["type"] == LOCATION_MODULE:

   205

            location = current_location + (infos["IEC_Channel"],)

   206

            return {"name": infos["name"],

   207

                    "type": infos["type"],

   208

                    "location": ".".join(map(str, location + ("x",))), 

   209

                    "icon": infos["icon"], 

   210

                    "children": [self._GetVariableLocationTree(location, child) for child in infos["children"]]}

   211

        elif infos["type"] == LOCATION_GROUP:

   212

            return {"name": infos["name"],

   213

                    "type": infos["type"],

   214

                    "location": "", 

   215

                    "icon": infos["icon"], 

   216

                    "children": [self._GetVariableLocationTree(current_location, child) for child in infos["children"]]}

   217

        else:

   218

            size = self.GetSizeOfType(infos["IEC_type"])

   219

            location = "%" + LOCATION_DIRS[infos["type"]] + size + ".".join(map(str, current_location + infos["location"]))

   220

            return {"name": infos["name"],

   221

                    "type": infos["type"],

   222

                    "size": size,

   223

                    "IEC_type": infos["IEC_type"],

   224

                    "location": location,

   225

                    "description": infos["description"],

   226

                    "children": []}

   227

   228

    def GetVariableLocationTree(self):

   229

        return {"name": self.BaseParams.getName(),

   230

                "type": LOCATION_PLUGIN,

   231

                "location": self.GetFullIEC_Channel(),

   232

                "icon": self.Icon, 

   233

                "children": [self._GetVariableLocationTree(self.GetCurrentLocation(), child) 

   234

                             for child in self.VariableLocationTree]}

   235

   236

    def PlugTestModified(self):

   237

        return False

   238

   239

    def PlugMakeDir(self):

   240

        pass

   241

   242

    def PlugRequestSave(self):

   243

        return None

   244

   245

    def ResetUsedLocations(self):

   246

        self.UsedLocations = {}

   247

   248

    def _AddUsedLocation(self, parent, location):

   249

        num = location.pop(0)

   250

        if not parent.has_key(num):

   251

            parent[num] = {"used": False, "children": {}}

   252

        if len(location) > 0:

   253

            self._AddUsedLocation(parent[num]["children"], location)

   254

        else:

   255

            parent[num]["used"] = True

   256

   257

    def AddUsedLocation(self, location):

   258

        if len(location) > 0:

   259

            self._AddUsedLocation(self.UsedLocations, list(location))

   260

   261

    def _CheckLocationConflicts(self, parent, location):

   262

        num = location.pop(0)

   263

        if not parent.has_key(num):

   264

            return False

   265

        if len(location) > 0:

   266

            if parent[num]["used"]:

   267

                return True

   268

            return self._CheckLocationConflicts(parent[num]["children"], location)

   269

        elif len(parent[num]["children"]) > 0:

   270

            return True

   271

        return False

   272

   273

    def CheckLocationConflicts(self, location):

   274

        if len(location) > 0:

   275

            return self._CheckLocationConflicts(self.UsedLocations, list(location))

   276

        return False

   277

   278

    def PlugGenerate_C(self, buildpath, locations):

   279

        """

   280

        Generate C code

   281

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

   282

        @param locations: List of complete variables locations \

   283

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

   284

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

   285

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

   286

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

   287

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

   288

            }, ...]

   289

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

   290

        """

   291

        current_location = self.GetCurrentLocation()

   292

        # define a unique name for the generated C file

   293

        location_str = "_".join(map(str, current_location))

   294

   295

        code_str = {"location_str": location_str,

   296

                    "var_decl": "",

   297

                    "declare_code": "",

   298

                    "init_code": "",

   299

                    "retrieve_code": "",

   300

                    "publish_code": "",

   301

                   }

   302

   303

        for module in _GetModuleChildren(self):

   304

            if module["init"] != "":

   305

                code_str["init_code"] += "  %s\n" % module["init"]

   306

   307

        # Adding variables

   308

        vars = []

   309

        self.ResetUsedLocations()

   310

        for location in locations:

   311

            loc = location["LOC"][len(current_location):]

   312

            group = next = self

   313

            i = 0

   314

            while next is not None and i < len(loc):

   315

                next = self._GetChildBySomething("IEC_Channel", loc[:i + 1])

   316

                if next is not None:

   317

                    i += 1

   318

                    group = next

   319

            var_loc = loc[i:]

   320

            for variable in _GetModuleChildren(group):

   321

                if variable["location"] == var_loc and location["DIR"] == LOCATION_DIRS[variable["type"]]:

   322

#                    if location["DIR"] != LOCATION_DIRS[variable["type"]]:

   323

#                        raise Exception, "Direction conflict in variable definition"

   324

#                    if location["IEC_TYPE"] != variable["IEC_type"]:

   325

#                        raise Exception, "Type conflict in variable definition"

   326

                    if location["DIR"] == "Q":

   327

                        if self.CheckLocationConflicts(location["LOC"]):

   328

                            raise Exception, "BYTE and BIT from the same BYTE can't be used together"

   329

                        self.AddUsedLocation(location["LOC"])

   330

                    vars.append({"location": location["NAME"],

   331

                                 "Type": variable["IEC_type"],

   332

                                 "Retrieve": variable["retrieve"],

   333

                                 "Publish": variable["publish"],

   334

                                })

   335

                    break

   336

        base_types = self.GetPlugRoot().GetBaseTypes()

   337

        for var in vars:

   338

            prefix = ""

   339

            if var["Type"] in base_types:

   340

                prefix = "IEC_"

   341

            code_str["var_decl"] += "%s%s beremiz%s;\n"%(prefix, var["Type"], var["location"])

   342

            code_str["var_decl"] += "%s%s *%s = &beremiz%s;\n"%(prefix, var["Type"], var["location"], var["location"])

   343

            if var["Retrieve"] != "":

   344

                code_str["retrieve_code"] += "  " + var["Retrieve"] % ("*" + var["location"]) + "\n"

   345

            if var["Publish"] != "":

   346

                code_str["publish_code"] += "  " + var["Publish"] % ("*" + var["location"]) + "\n"

   347

   348

        Gen_Module_path = os.path.join(buildpath, "Bus_%s.c"%location_str)

   349

        module = open(Gen_Module_path,'w')

   350

        module.write(BUS_TEXT % code_str)

   351

        module.close()

   352

   353

        matiec_flags = '"-I%s"'%os.path.abspath(self.GetPlugRoot().GetIECLibPath())

   354

        return [(Gen_Module_path, matiec_flags)],"",True

   355

   356

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

   357

#                              LPCPluginsRoot Class

   358

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

   359

   360

def mycopytree(src, dst):

   361

    """

   362

    Copy content of a directory to an other, omit hidden files

   363

    @param src: source directory

   364

    @param dst: destination directory

   365

    """

   366

    for i in os.listdir(src):

   367

        if not i.startswith('.'):

   368

            srcpath = os.path.join(src,i)

   369

            dstpath = os.path.join(dst,i)

   370

            if os.path.isdir(srcpath):

   371

                if os.path.exists(dstpath):

   372

                    shutil.rmtree(dstpath)

   373

                os.makedirs(dstpath)

   374

                mycopytree(srcpath, dstpath)

   375

            elif os.path.isfile(srcpath):

   376

                shutil.copy2(srcpath, dstpath)

   377

   378

[SIMULATION_MODE, TRANSFER_MODE] = range(2)

   379

   380

class LPCPluginsRoot(PluginsRoot):

   381

   382

    PluginMethods = [

   383

        {"bitmap" : opjimg("Debug"),

   384

         "name" : _("Simulate"),

   385

         "tooltip" : _("Simulate PLC"),

   386

         "method" : "_Simulate"},

   387

        {"bitmap" : opjimg("Run"),

   388

         "name" : _("Run"),

   389

         "shown" : False,

   390

         "tooltip" : _("Start PLC"),

   391

         "method" : "_Run"},

   392

        {"bitmap" : opjimg("Stop"),

   393

         "name" : _("Stop"),

   394

         "shown" : False,

   395

         "tooltip" : _("Stop Running PLC"),

   396

         "method" : "_Stop"},

   397

        {"bitmap" : opjimg("Build"),

   398

         "name" : _("Build"),

   399

         "tooltip" : _("Build project into build folder"),

   400

         "method" : "_build"},

   401

        {"bitmap" : opjimg("Transfer"),

   402

         "name" : _("Transfer"),

   403

         "shown" : False,

   404

         "tooltip" : _("Transfer PLC"),

   405

         "method" : "_Transfer"},

   406

    ]

   407

   408

    def __init__(self, frame, logger):

   409

        PluginsRoot.__init__(self, frame, logger)

   410

   411

        self.PlugChildsTypes += [("LPCBus", LPCBus, "LPC bus")]

   412

   413

        self.OnlineMode = "OFF"

   414

        self.LPCConnector = None

   415

   416

        self.CurrentMode = None

   417

        self.previous_mode = None

   418

   419

        self.SimulationBuildPath = None

   420

   421

        self.AbortTransferTimer = None

   422

   423

    def GetProjectName(self):

   424

        return self.Project.getname()

   425

   426

    def GetDefaultTargetName(self):

   427

        if self.CurrentMode == SIMULATION_MODE:

   428

            return PluginsRoot.GetDefaultTargetName(self)

   429

        else:

   430

            return "LPC"

   431

   432

    def GetTarget(self):

   433

        target = PluginsRoot.GetTarget(self)

   434

        if self.CurrentMode != SIMULATION_MODE:

   435

            target.getcontent()["value"].setBuildPath(self.BuildPath)

   436

        return target

   437

   438

    def _getBuildPath(self):

   439

        if self.CurrentMode == SIMULATION_MODE:

   440

            if self.SimulationBuildPath is None:

   441

                self.SimulationBuildPath = os.path.join(tempfile.mkdtemp(), os.path.basename(self.ProjectPath), "build")

   442

            return self.SimulationBuildPath

   443

        else:

   444

            return PluginsRoot._getBuildPath(self)

   445

   446

    def _build(self):

   447

        if self.BuildPath is not None:

   448

            mycopytree(self.OrigBuildPath, self.BuildPath)

   449

        PluginsRoot._build(self)

   450

   451

    def SetProjectName(self, name):

   452

        return self.Project.setname(name)

   453

   454

    def SetOnlineMode(self, mode, path=None):

   455

        if self.OnlineMode != mode.upper():

   456

            self.OnlineMode = mode.upper()

   457

   458

            if self.OnlineMode != "OFF":

   459

                uri = "LPC://%s/%s" % (self.OnlineMode,path)

   460

                try:

   461

                    self.LPCConnector = connectors.ConnectorFactory(uri, self)

   462

                except Exception, msg:

   463

                    self.logger.write_error(_("Exception while connecting %s!\n")%uri)

   464

                    self.logger.write_error(traceback.format_exc())

   465

   466

                # Did connection success ?

   467

                if self.LPCConnector is None:

   468

                    # Oups.

   469

                    self.logger.write_error(_("Connection failed to %s!\n")%uri)

   470

   471

            else:

   472

                self.LPCConnector = None

   473

   474

            self.ApplyOnlineMode()

   475

   476

    def ApplyOnlineMode(self):

   477

        if self.CurrentMode != SIMULATION_MODE:

   478

            self.KillDebugThread()

   479

   480

            self._connector = self.LPCConnector

   481

   482

            # Init with actual PLC status and print it

   483

            self.UpdateMethodsFromPLCStatus()

   484

   485

            if self.LPCConnector is not None and self.OnlineMode == "APPLICATION":

   486

   487

                self.CompareLocalAndRemotePLC()

   488

   489

                if self.previous_plcstate is not None:

   490

                    status = _(self.previous_plcstate)

   491

                else:

   492

                    status = ""

   493

                self.logger.write(_("PLC is %s\n")%status)

   494

   495

                if self.StatusTimer and not self.StatusTimer.IsRunning():

   496

                    # Start the status Timer

   497

                    self.StatusTimer.Start(milliseconds=2000, oneShot=False)

   498

   499

                if self.previous_plcstate=="Started":

   500

                    if self.DebugAvailable() and self.GetIECProgramsAndVariables():

   501

                        self.logger.write(_("Debug connect matching running PLC\n"))

   502

                        #TODO re-enable

   503

                        #self._connect_debug()

   504

                    else:

   505

                        self.logger.write_warning(_("Debug do not match PLC - stop/transfert/start to re-enable\n"))

   506

   507

            elif self.StatusTimer and self.StatusTimer.IsRunning():

   508

                self.StatusTimer.Stop()

   509

   510