1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz

     5

#

     6

# Copyright (C) 2011-2014: Laurent BESSARD, Edouard TISSERANT

     7

#                          RTES Lab : CRKim, JBLee, youcu

     8

#                          Higen Motor : Donggu Kang

     9

#

    10

# See COPYING file for copyrights details.

    11

    12

import os

    13

import shutil

    14

from lxml import etree

    15

    16

import wx

    17

import csv

    18

    19

from xmlclass import *

    20

    21

from ConfigTreeNode import ConfigTreeNode, XSDSchemaErrorMessage

    22

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

    23

    24

from EthercatSlave import ExtractHexDecValue, ExtractName

    25

from EthercatMaster import _EthercatCTN

    26

from ConfigEditor import LibraryEditor, ETHERCAT_VENDOR, ETHERCAT_GROUP, ETHERCAT_DEVICE

    27

    28

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

    29

    30

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

    31

#                 Ethercat ConfNode

    32

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

    33

    34

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

    35

EtherCATInfo_XPath = lambda xpath: etree.XPath(xpath)

    36

    37

def HexDecValue(context, *args):

    38

    return str(ExtractHexDecValue(args[0][0]))

    39

    40

def EntryName(context, *args):

    41

    return ExtractName(args[0],

    42

        args[1][0] if len(args) > 1 else None)

    43

    44

ENTRY_INFOS_KEYS = [

    45

    ("Index", lambda x: "#x%4.4X" % int(x), "#x0000"),

    46

    ("SubIndex", str, "0"),

    47

    ("Name", str, ""),

    48

    ("Type", str, ""),

    49

    ("BitSize", int, 0),

    50

    ("Access", str, ""),

    51

    ("PDOMapping", str, ""),

    52

    ("PDO index", str, ""),

    53

    ("PDO name", str, ""),

    54

    ("PDO type", str, "")]

    55

    56

class EntryListFactory:

    57

    58

    def __init__(self, entries):

    59

        self.Entries = entries

    60

    61

    def AddEntry(self, context, *args):

    62

        index, subindex = map(lambda x: int(x[0]), args[:2])

    63

        new_entry_infos = {

    64

            key: translate(arg[0]) if len(arg) > 0 else default

    65

            for (key, translate, default), arg

    66

            in zip(ENTRY_INFOS_KEYS, args)}

    67

    68

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

    69

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

    70

            if entry_infos is not None:

    71

                for param in ["PDO index", "PDO name", "PDO type"]:

    72

                    value = new_entry_infos.get(param)

    73

                    if value is not None:

    74

                        entry_infos[param] = value

    75

            else:

    76

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

    77

    78

entries_list_xslt = etree.parse(

    79

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

    80

    81

cls = EtherCATInfoParser.GetElementClass("DeviceType")

    82

if cls:

    83

    84

    profile_numbers_xpath = EtherCATInfo_XPath("Profile/ProfileNo")

    85

    def GetProfileNumbers(self):

    86

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

    87

    setattr(cls, "GetProfileNumbers", GetProfileNumbers)

    88

    89

    def getCoE(self):

    90

        mailbox = self.getMailbox()

    91

        if mailbox is not None:

    92

            return mailbox.getCoE()

    93

        return None

    94

    setattr(cls, "getCoE", getCoE)

    95

    96

    def GetEntriesList(self, limits=None):

    97

        entries = {}

    98

    99

        factory = EntryListFactory(entries)

   100

   101

        entries_list_xslt_tree = etree.XSLT(

   102

            entries_list_xslt, extensions = {

   103

                ("entries_list_ns", "AddEntry"): factory.AddEntry,

   104

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

   105

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

   106

        entries_list_xslt_tree(self, **dict(zip(

   107

            ["min_index", "max_index"],

   108

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

   109

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

   110

            )))

   111

   112

        return entries

   113

    setattr(cls, "GetEntriesList", GetEntriesList)

   114

   115

    def GetSyncManagers(self):

   116

        sync_managers = []

   117

        for sync_manager in self.getSm():

   118

            sync_manager_infos = {}

   119

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

   120

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

   121

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

   122

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

   123

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

   124

                if value is None:

   125

                    value =""

   126

                sync_manager_infos[name] = value

   127

            sync_managers.append(sync_manager_infos)

   128

        return sync_managers

   129

    setattr(cls, "GetSyncManagers", GetSyncManagers)

   130

   131

def GroupItemCompare(x, y):

   132

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

   133

        if x["type"] == ETHERCAT_GROUP:

   134

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

   135

        else:

   136

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

   137

    elif x["type"] == ETHERCAT_GROUP:

   138

        return -1

   139

    return 1

   140

   141

def SortGroupItems(group):

   142

    for item in group["children"]:

   143

        if item["type"] == ETHERCAT_GROUP:

   144

            SortGroupItems(item)

   145

    group["children"].sort(GroupItemCompare)

   146

   147

class ModulesLibrary:

   148

   149

    MODULES_EXTRA_PARAMS = [

   150

        ("pdo_alignment", {

   151

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

   152

            "column_size": 150,

   153

            "default": 8,

   154

            "description": _(

   155

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

   156

        ("max_pdo_size", {

   157

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

   158

            "column_size": 150,

   159

            "default": 255,

   160

            "description": _(

   161

"""Maximal number of entries mapped in a PDO

   162

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

   163

        ("add_pdo", {

   164

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

   165

            "column_size": 150,

   166

            "default": 0,

   167

            "description": _(

   168

"""Adding a PDO not defined in default configuration

   169

for mapping needed location variables

   170

(1 if possible)""")})

   171

    ]

   172

   173

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

   174

        self.Path = path

   175

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

   176

            os.makedirs(self.Path)

   177

        self.ParentLibrary = parent_library

   178

   179

        if parent_library is not None:

   180

            self.LoadModules()

   181

        else:

   182

            self.Library = None

   183

        self.LoadModulesExtraParams()

   184

   185

    def GetPath(self):

   186

        return self.Path

   187

   188

    def GetModulesExtraParamsFilePath(self):

   189

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

   190

   191

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

   192

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

   193

    def LoadModules(self):

   194

        self.Library = {}

   195

   196

        files = os.listdir(self.Path)

   197

        for file in files:

   198

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

   199

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

   200

                self.modules_infos = None

   201

   202

                xmlfile = open(filepath, 'r')

   203

                try:

   204

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

   205

                    if error is not None:

   206

                        self.GetCTRoot().logger.write_warning(

   207

                            XSDSchemaErrorMessage % (filepath + error))

   208

                except Exception, exc:

   209

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

   210

                xmlfile.close()

   211

   212

                if self.modules_infos is not None:

   213

                    vendor = self.modules_infos.getVendor()

   214

   215

                    vendor_category = self.Library.setdefault(

   216

                        ExtractHexDecValue(vendor.getId()),

   217

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

   218

                         "groups": {}})

   219

   220

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

   221

                        group_type = group.getType()

   222

   223

                        vendor_category["groups"].setdefault(group_type,

   224

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

   225

                             "parent": group.getParentGroup(),

   226

                             "order": group.getSortOrder(),

   227

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

   228

                             "devices": []})

   230

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

   231

                        device_group = device.getGroupType()

   232

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

   233

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

   234

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

   235

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

   236

   237

                else:

   238

   239

                    self.GetCTRoot().logger.write_error(

   240

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

   241

   242

        return self.Library

   243

   244

    def GetModulesLibrary(self, profile_filter=None):

   245

        if self.Library is None:

   246

            self.LoadModules()

   247

        library = []

   248

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

   249

            groups = []

   250

            children_dict = {}

   251

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

   252

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

   253

                               "order": group["order"],

   254

                               "type": ETHERCAT_GROUP,

   255

                               "infos": None,

   256

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

   257

                device_dict = {}

   258

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

   259

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

   260

                        product_code = device.getType().getProductCode()

   261

                        revision_number = device.getType().getRevisionNo()

   262

                        module_infos = {"device_type": device_type,

   263

                                        "vendor": vendor_id,

   264

                                        "product_code": product_code,

   265

                                        "revision_number": revision_number}

   266

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

   267

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

   268

                                        "type": ETHERCAT_DEVICE,

   269

                                        "infos": module_infos,

   270

                                        "children": []}

   271

                        group_infos["children"].append(device_infos)

   272

                        device_type_occurrences = device_dict.setdefault(device_type, [])

   273

                        device_type_occurrences.append(device_infos)

   274

                for device_type_occurrences in device_dict.itervalues():

   275

                    if len(device_type_occurrences) > 1:

   276

                        for occurrence in device_type_occurrences:

   277

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

   278

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

   279

                    if group["parent"] is not None:

   280

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

   281

                        parent_children.append(group_infos)

   282

                    else:

   283

                        groups.append(group_infos)

   284

            if len(groups) > 0:

   285

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

   286

                                "type": ETHERCAT_VENDOR,

   287

                                "infos": None,

   288

                                "children": groups})

   289

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

   290

        return library

   291

   292

    def GetVendors(self):

   293

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

   294

   295

    def GetModuleInfos(self, module_infos):

   296

        vendor = ExtractHexDecValue(module_infos["vendor"])

   297

        vendor_infos = self.Library.get(vendor)

   298

        if vendor_infos is not None:

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

                        self.cntdevice = device_infos

   306

                        self.cntdeviceType = device_type

   307

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

   308

        return None, None

   309

   310

    def ImportModuleLibrary(self, filepath):

   311

        if os.path.isfile(filepath):

   312

            shutil.copy(filepath, self.Path)

   313

            self.LoadModules()

   314

            return True

   315

        return False

   316

   317

    def LoadModulesExtraParams(self):

   318

        self.ModulesExtraParams = {}

   319

   320

        csvfile_path = self.GetModulesExtraParamsFilePath()

   321

        if os.path.exists(csvfile_path):

   322

            csvfile = open(csvfile_path, "rb")

   323

            sample = csvfile.read(1024)

   324

            csvfile.seek(0)

   325

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

   326

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

   327

            reader = csv.reader(csvfile, dialect)

   328

            for row in reader:

   329

                if has_header:

   330

                    has_header = False

   331

                else:

   332

                    params_values = {}

   333

                    for (param, param_infos), value in zip(

   334

                        self.MODULES_EXTRA_PARAMS, row[3:]):

   335

                        if value != "":

   336

                            params_values[param] = int(value)

   337

                    self.ModulesExtraParams[

   338

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

   339

            csvfile.close()

   340

   341

    def SaveModulesExtraParams(self):

   342

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

   343

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

   344

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

   345

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

   346

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

   347

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

   348

                            [module_extra_params.get(param, '')

   349

                             for param in extra_params])

   350

        csvfile.close()

   351

   352

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

   353

        vendor = ExtractHexDecValue(vendor)

   354

        product_code = ExtractHexDecValue(product_code)

   355

        revision_number = ExtractHexDecValue(revision_number)

   356

   357

        module_infos = (vendor, product_code, revision_number)

   358

        self.ModulesExtraParams.setdefault(module_infos, {})

   359

        self.ModulesExtraParams[module_infos][param] = value

   360

   361

        self.SaveModulesExtraParams()

   362

   363

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

   364

        vendor = ExtractHexDecValue(vendor)

   365

        product_code = ExtractHexDecValue(product_code)

   366

        revision_number = ExtractHexDecValue(revision_number)

   367

   368

        if self.ParentLibrary is not None:

   369

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

   370

        else:

   371

            extra_params = {}

   372

   373

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

   374

   375

        for param, param_infos in self.MODULES_EXTRA_PARAMS:

   376

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

   377

   378

        return extra_params

   379

   380

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

   381

if wx.Platform != '__WXMSW__':

   382

    USERDATA_DIR += '_files'

   383

   384

ModulesDatabase = ModulesLibrary(

   385

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

   386

   387

class RootClass:

   388

   389

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

   390

    EditorType = LibraryEditor

   391

   392

   393

    def __init__(self):

   394

        self.ModulesLibrary = None

   395

        self.LoadModulesLibrary()

   396

   397

    def GetIconName(self):

   398

        return "Ethercat"

   399

   400

    def GetModulesLibraryPath(self, project_path=None):

   401

        if project_path is None:

   402

            project_path = self.CTNPath()

   403

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

   404

   405

    def OnCTNSave(self, from_project_path=None):

   406

        if from_project_path is not None:

   407

            shutil.copytree(self.GetModulesLibraryPath(from_project_path),

   408

                            self.GetModulesLibraryPath())

   409

        return True

   410

   411

    def CTNGenerate_C(self, buildpath, locations):

   412

        return [],"",False

   413

   414

    def LoadModulesLibrary(self):

   415

        if self.ModulesLibrary is None:

   416

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

   417

        else:

   418

            self.ModulesLibrary.LoadModulesLibrary()

   419

   420

    def GetModulesDatabaseInstance(self):

   421

        return ModulesDatabase

   422

   423

    def GetModulesLibraryInstance(self):

   424

        return self.ModulesLibrary

   425

   426

    def GetModulesLibrary(self, profile_filter=None):

   427

        return self.ModulesLibrary.GetModulesLibrary(profile_filter)

   428

   429

    def GetVendors(self):

   430

        return self.ModulesLibrary.GetVendors()

   431

   432

    def GetModuleInfos(self, module_infos):

   433

        return self.ModulesLibrary.GetModuleInfos(module_infos)