1

import os, shutil

     2

from lxml import etree

     3

     4

import wx

     5

import csv

     6

     7

from xmlclass import *

     8

     9

from ConfigTreeNode import ConfigTreeNode, XSDSchemaErrorMessage

    10

from PLCControler import UndoBuffer, LOCATION_CONFNODE, LOCATION_MODULE, LOCATION_GROUP, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY

    11

    12

from EthercatSlave import ExtractHexDecValue, ExtractName

    13

from EthercatMaster import _EthercatCTN

    14

from ConfigEditor import LibraryEditor, ETHERCAT_VENDOR, ETHERCAT_GROUP, ETHERCAT_DEVICE

    15

    16

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

    17

    18

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

    19

#                 Ethercat ConfNode

    20

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

    21

    22

EtherCATInfoParser = GenerateParserFromXSD(os.path.join(os.path.dirname(__file__), "EtherCATInfo.xsd")) 

    23

EtherCATInfo_XPath = lambda xpath: etree.XPath(xpath)

    24

    45

    46

    def __init__(self, entries):

    47

        self.Entries = entries

    48

    51

        new_entry_infos = {

    56

        if (index, subindex) != (0, 0):

    57

            entry_infos = self.Entries.get((index, subindex))

    58

            if entry_infos is not None:

    63

            else:

    64

                self.Entries[(index, subindex)] = new_entry_infos

    65

    66

entries_list_xslt = etree.parse(

    67

    os.path.join(ScriptDirectory, "entries_list.xslt"))

    68

    69

cls = EtherCATInfoParser.GetElementClass("DeviceType")

    70

if cls:

    71

    72

    profile_numbers_xpath = EtherCATInfo_XPath("Profile/ProfileNo")

    73

    def GetProfileNumbers(self):

    74

        return [number.text for number in profile_numbers_xpath(self)]

    75

    setattr(cls, "GetProfileNumbers", GetProfileNumbers)

    76

    77

    def getCoE(self):

    78

        mailbox = self.getMailbox()

    79

        if mailbox is not None:

    80

            return mailbox.getCoE()

    81

        return None

    82

    setattr(cls, "getCoE", getCoE)

    83

    84

    def GetEntriesList(self, limits=None):

    85

        entries = {}

    86

    89

        entries_list_xslt_tree = etree.XSLT(

    90

            entries_list_xslt, extensions = {

    92

                ("entries_list_ns", "HexDecValue"): HexDecValue,

    93

                ("entries_list_ns", "EntryName"): EntryName})

    94

        entries_list_xslt_tree(self, **dict(zip(

    95

            ["min_index", "max_index"], 

    96

            map(lambda x: etree.XSLT.strparam(str(x)),

    97

                limits if limits is not None else [0x0000, 0xFFFF])

    98

            )))

    99

   100

        return entries

   101

    setattr(cls, "GetEntriesList", GetEntriesList)

   102

   103

    def GetSyncManagers(self):

   104

        sync_managers = []

   105

        for sync_manager in self.getSm():

   106

            sync_manager_infos = {}

   107

            for name, value in [("Name", sync_manager.getcontent()),

   108

                                ("Start Address", sync_manager.getStartAddress()),

   109

                                ("Default Size", sync_manager.getDefaultSize()),

   110

                                ("Control Byte", sync_manager.getControlByte()),

   111

                                ("Enable", sync_manager.getEnable())]:

   112

                if value is None:

   113

                    value =""

   114

                sync_manager_infos[name] = value

   115

            sync_managers.append(sync_manager_infos)

   116

        return sync_managers

   117

    setattr(cls, "GetSyncManagers", GetSyncManagers)

   118

   119

def GroupItemCompare(x, y):

   120

    if x["type"] == y["type"]:

   121

        if x["type"] == ETHERCAT_GROUP:

   122

            return cmp(x["order"], y["order"])

   123

        else:

   124

            return cmp(x["name"], y["name"])

   125

    elif x["type"] == ETHERCAT_GROUP:

   126

        return -1

   127

    return 1

   128

   129

def SortGroupItems(group):

   130

    for item in group["children"]:

   131

        if item["type"] == ETHERCAT_GROUP:

   132

            SortGroupItems(item)

   133

    group["children"].sort(GroupItemCompare)

   134

   135

class ModulesLibrary:

   136

   137

    MODULES_EXTRA_PARAMS = [

   138

        ("pdo_alignment", {

   139

            "column_label": _("PDO alignment"), 

   140

            "column_size": 150,

   141

            "default": 8,

   142

            "description": _(

   143

"Minimal size in bits between 2 pdo entries")}),

   144

        ("max_pdo_size", {

   145

            "column_label": _("Max entries by PDO"),

   146

            "column_size": 150,

   147

            "default": 255,

   148

            "description": _(

   149

"""Maximal number of entries mapped in a PDO

   150

including empty entries used for PDO alignment""")}),

   151

        ("add_pdo", {

   152

            "column_label": _("Creating new PDO"), 

   153

            "column_size": 150,

   154

            "default": 0,

   155

            "description": _(

   156

"""Adding a PDO not defined in default configuration

   157

for mapping needed location variables

   158

(1 if possible)""")})

   159

    ]

   160

   161

    def __init__(self, path, parent_library=None):

   162

        self.Path = path

   163

        if not os.path.exists(self.Path):

   164

            os.makedirs(self.Path)

   165

        self.ParentLibrary = parent_library

   166

   167

        if parent_library is not None:

   168

            self.LoadModules()

   169

        else:

   170

            self.Library = None

   171

        self.LoadModulesExtraParams()

   172

   173

    def GetPath(self):

   174

        return self.Path

   175

   176

    def GetModulesExtraParamsFilePath(self):

   177

        return os.path.join(self.Path, "modules_extra_params.cfg")

   178

   179

    groups_xpath = EtherCATInfo_XPath("Descriptions/Groups/Group")

   180

    devices_xpath = EtherCATInfo_XPath("Descriptions/Devices/Device")

   181

    def LoadModules(self):

   182

        self.Library = {}

   183

   184

        files = os.listdir(self.Path)

   185

        for file in files:

   186

            filepath = os.path.join(self.Path, file)

   187

            if os.path.isfile(filepath) and os.path.splitext(filepath)[-1] == ".xml":

   188

                self.modules_infos = None

   189

   190

                xmlfile = open(filepath, 'r')

   191

                try:

   192

                    self.modules_infos, error = EtherCATInfoParser.LoadXMLString(xmlfile.read())

   193

                    if error is not None:

   194

                        self.GetCTRoot().logger.write_warning(

   195

                            XSDSchemaErrorMessage % (filepath + error))

   196

                except Exception, exc:

   197

                    self.modules_infos, error = None, unicode(exc)

   198

                xmlfile.close()

   199

   200

                if self.modules_infos is not None:

   201

                    vendor = self.modules_infos.getVendor()

   202

   203

                    vendor_category = self.Library.setdefault(

   204

                        ExtractHexDecValue(vendor.getId()), 

   205

                        {"name": ExtractName(vendor.getName(), _("Miscellaneous")), 

   206

                         "groups": {}})

   207

   208

                    for group in self.groups_xpath(self.modules_infos):

   209

                        group_type = group.getType()

   210

   211

                        vendor_category["groups"].setdefault(group_type, 

   212

                            {"name": ExtractName(group.getName(), group_type), 

   213

                             "parent": group.getParentGroup(),

   214

                             "order": group.getSortOrder(), 

   215

                             #"value": group.getcontent()["value"],

   216

                             "devices": []})

   217

   218

                    for device in self.devices_xpath(self.modules_infos):

   219

                        device_group = device.getGroupType()

   220

                        if not vendor_category["groups"].has_key(device_group):

   221

                            raise ValueError, "Not such group \"%\"" % device_group

   222

                        vendor_category["groups"][device_group]["devices"].append(

   223

                            (device.getType().getcontent(), device))

   224

   225

                else:

   226

   227

                    self.GetCTRoot().logger.write_error(

   228

                        _("Couldn't load %s XML file:\n%s") % (filepath, error))

   229

   230

        return self.Library

   231

   232

    def GetModulesLibrary(self, profile_filter=None):

   233

        if self.Library is None:

   234

            self.LoadModules()

   235

        library = []

   236

        for vendor_id, vendor in self.Library.iteritems():

   237

            groups = []

   238

            children_dict = {}

   239

            for group_type, group in vendor["groups"].iteritems():

   240

                group_infos = {"name": group["name"],

   241

                               "order": group["order"],

   242

                               "type": ETHERCAT_GROUP,

   243

                               "infos": None,

   244

                               "children": children_dict.setdefault(group_type, [])}

   245

                device_dict = {}

   246

                for device_type, device in group["devices"]:

   247

                    if profile_filter is None or profile_filter in device.GetProfileNumbers():

   248

                        product_code = device.getType().getProductCode()

   249

                        revision_number = device.getType().getRevisionNo()

   250

                        module_infos = {"device_type": device_type,

   251

                                        "vendor": vendor_id,

   252

                                        "product_code": product_code,

   253

                                        "revision_number": revision_number}

   254

                        module_infos.update(self.GetModuleExtraParams(vendor_id, product_code, revision_number))

   255

                        device_infos = {"name": ExtractName(device.getName()),

   256

                                        "type": ETHERCAT_DEVICE,

   257

                                        "infos": module_infos,

   258

                                        "children": []}

   259

                        group_infos["children"].append(device_infos)

   260

                        device_type_occurrences = device_dict.setdefault(device_type, [])

   261

                        device_type_occurrences.append(device_infos)

   262

                for device_type_occurrences in device_dict.itervalues():

   263

                    if len(device_type_occurrences) > 1:

   264

                        for occurrence in device_type_occurrences:

   265

                            occurrence["name"] += _(" (rev. %s)") % occurrence["infos"]["revision_number"]

   266

                if len(group_infos["children"]) > 0:

   267

                    if group["parent"] is not None:

   268

                        parent_children = children_dict.setdefault(group["parent"], [])

   269

                        parent_children.append(group_infos)

   270

                    else:

   271

                        groups.append(group_infos)

   272

            if len(groups) > 0:

   273

                library.append({"name": vendor["name"],

   274

                                "type": ETHERCAT_VENDOR,

   275

                                "infos": None,

   276

                                "children": groups})

   277

        library.sort(lambda x, y: cmp(x["name"], y["name"]))

   278

        return library

   279

   280

    def GetVendors(self):

   281

        return [(vendor_id, vendor["name"]) for vendor_id, vendor in self.Library.items()]

   282

   283

    def GetModuleInfos(self, module_infos):

   284

        vendor = ExtractHexDecValue(module_infos["vendor"])

   285

        vendor_infos = self.Library.get(vendor)

   286

        if vendor_infos is not None:

   287

            for group_name, group_infos in vendor_infos["groups"].iteritems():

   288

                for device_type, device_infos in group_infos["devices"]:

   289

                    product_code = ExtractHexDecValue(device_infos.getType().getProductCode())

   290

                    revision_number = ExtractHexDecValue(device_infos.getType().getRevisionNo())

   291

                    if (product_code == ExtractHexDecValue(module_infos["product_code"]) and

   292

                        revision_number == ExtractHexDecValue(module_infos["revision_number"])):

   293

                        self.cntdevice = device_infos 

   294

                        self.cntdeviceType = device_type  

   295

                        return device_infos, self.GetModuleExtraParams(vendor, product_code, revision_number)

   296

        return None, None

   297

   298

    def ImportModuleLibrary(self, filepath):

   299

        if os.path.isfile(filepath):

   300

            shutil.copy(filepath, self.Path)

   301

            self.LoadModules()

   302

            return True

   303

        return False

   304

   305

    def LoadModulesExtraParams(self):

   306

        self.ModulesExtraParams = {}

   307

   308

        csvfile_path = self.GetModulesExtraParamsFilePath()

   309

        if os.path.exists(csvfile_path):

   310

            csvfile = open(csvfile_path, "rb")

   311

            sample = csvfile.read(1024)

   312

            csvfile.seek(0)

   313

            dialect = csv.Sniffer().sniff(sample)

   314

            has_header = csv.Sniffer().has_header(sample)

   315

            reader = csv.reader(csvfile, dialect)

   316

            for row in reader:

   317

                if has_header:

   318

                    has_header = False

   319

                else:

   320

                    params_values = {}

   321

                    for (param, param_infos), value in zip(

   322

                        self.MODULES_EXTRA_PARAMS, row[3:]):

   323

                        if value != "":

   324

                            params_values[param] = int(value)

   325

                    self.ModulesExtraParams[

   326

                        tuple(map(int, row[:3]))] = params_values

   327

            csvfile.close()

   328

   329

    def SaveModulesExtraParams(self):

   330

        csvfile = open(self.GetModulesExtraParamsFilePath(), "wb")

   331

        extra_params = [param for param, params_infos in self.MODULES_EXTRA_PARAMS]

   332

        writer = csv.writer(csvfile, delimiter=';')

   333

        writer.writerow(['Vendor', 'product_code', 'revision_number'] + extra_params)

   334

        for (vendor, product_code, revision_number), module_extra_params in self.ModulesExtraParams.iteritems():

   335

            writer.writerow([vendor, product_code, revision_number] + 

   336

                            [module_extra_params.get(param, '') 

   337

                             for param in extra_params])

   338

        csvfile.close()

   339

   340

    def SetModuleExtraParam(self, vendor, product_code, revision_number, param, value):

   341

        vendor = ExtractHexDecValue(vendor)

   342

        product_code = ExtractHexDecValue(product_code)

   343

        revision_number = ExtractHexDecValue(revision_number)

   344

   345

        module_infos = (vendor, product_code, revision_number)

   346

        self.ModulesExtraParams.setdefault(module_infos, {})

   347

        self.ModulesExtraParams[module_infos][param] = value

   348

   349

        self.SaveModulesExtraParams()

   350

   351

    def GetModuleExtraParams(self, vendor, product_code, revision_number):

   352

        vendor = ExtractHexDecValue(vendor)

   353

        product_code = ExtractHexDecValue(product_code)

   354

        revision_number = ExtractHexDecValue(revision_number)

   355

   356

        if self.ParentLibrary is not None:

   357

            extra_params = self.ParentLibrary.GetModuleExtraParams(vendor, product_code, revision_number)

   358

        else:

   359

            extra_params = {}

   360

   361

        extra_params.update(self.ModulesExtraParams.get((vendor, product_code, revision_number), {}))

   362

   363

        for param, param_infos in self.MODULES_EXTRA_PARAMS:

   364

            extra_params.setdefault(param, param_infos["default"])

   365

   366

        return extra_params

   367

   368

USERDATA_DIR = wx.StandardPaths.Get().GetUserDataDir()

   369

if wx.Platform != '__WXMSW__':

   370

    USERDATA_DIR += '_files'

   371

   372

ModulesDatabase = ModulesLibrary(

   373

    os.path.join(USERDATA_DIR, "ethercat_modules"))

   374

   375

class RootClass:

   376

   377

    CTNChildrenTypes = [("EthercatNode",_EthercatCTN,"Ethercat Master")]

   378

    EditorType = LibraryEditor

   379

   380

   381

    def __init__(self):

   382

        self.ModulesLibrary = None

   383

        self.LoadModulesLibrary()

   384

   385

    def GetIconName(self):

   386

        return "Ethercat"

   387

   388

    def GetModulesLibraryPath(self, project_path=None):

   389

        if project_path is None:

   390

            project_path = self.CTNPath()

   391

        return os.path.join(project_path, "modules") 

   392

   393

    def OnCTNSave(self, from_project_path=None):

   394

        if from_project_path is not None:

   395

            shutil.copytree(self.GetModulesLibraryPath(from_project_path),

   396

                            self.GetModulesLibraryPath())

   397

        return True

   398

   399

    def CTNGenerate_C(self, buildpath, locations):

   400

        return [],"",False

   401

   402

    def LoadModulesLibrary(self):

   403

        if self.ModulesLibrary is None:

   404

            self.ModulesLibrary = ModulesLibrary(self.GetModulesLibraryPath(), ModulesDatabase)

   405

        else:

   406

            self.ModulesLibrary.LoadModulesLibrary()

   407

   408

    def GetModulesDatabaseInstance(self):

   409

        return ModulesDatabase

   410

   411

    def GetModulesLibraryInstance(self):

   412

        return self.ModulesLibrary

   413

   414

    def GetModulesLibrary(self, profile_filter=None):

   415

        return self.ModulesLibrary.GetModulesLibrary(profile_filter)

   416

   417

    def GetVendors(self):

   418

        return self.ModulesLibrary.GetVendors()

   419

   420

    def GetModuleInfos(self, module_infos):

   421

        return self.ModulesLibrary.GetModuleInfos(module_infos)

   422