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"))

    39

    40

    41

def HexDecValue(context, *args):

    42

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

    43

    44

    45

def EntryName(context, *args):

    46

    return ExtractName(args[0],

    47

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

    48

    49

    50

ENTRY_INFOS_KEYS = [

    51

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

    52

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

    53

    ("Name", str, ""),

    54

    ("Type", str, ""),

    55

    ("BitSize", int, 0),

    56

    ("Access", str, ""),

    57

    ("PDOMapping", str, ""),

    58

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

    59

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

    60

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

    61

    62

    63

class EntryListFactory:

    64

    65

    def __init__(self, entries):

    66

        self.Entries = entries

    67

    68

    def AddEntry(self, context, *args):

    69

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

    70

        new_entry_infos = {

    71

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

    72

            for (key, translate, default), arg

    73

            in zip(ENTRY_INFOS_KEYS, args)}

    74

    75

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

    76

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

    77

            if entry_infos is not None:

    78

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

    79

                    value = new_entry_infos.get(param)

    80

                    if value is not None:

    81

                        entry_infos[param] = value

    82

            else:

    83

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

    84

    85

    86

entries_list_xslt = etree.parse(

    87

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

    88

    89

cls = EtherCATInfoParser.GetElementClass("DeviceType")

    90

if cls:

    91

    92

    profile_numbers_xpath = EtherCATInfo_XPath("Profile/ProfileNo")

    93

    def GetProfileNumbers(self):

    94

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

    95

    setattr(cls, "GetProfileNumbers", GetProfileNumbers)

    96

    97

    def getCoE(self):

    98

        mailbox = self.getMailbox()

    99

        if mailbox is not None:

   100

            return mailbox.getCoE()

   101

        return None

   102

    setattr(cls, "getCoE", getCoE)

   103

   104

    def GetEntriesList(self, limits=None):

   105

        entries = {}

   106

   107

        factory = EntryListFactory(entries)

   108

   109

        entries_list_xslt_tree = etree.XSLT(

   110

            entries_list_xslt, extensions={

   111

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

   112

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

   113

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

   114

        entries_list_xslt_tree(self, **dict(zip(

   115

            ["min_index", "max_index"],

   116

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

   117

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

   118

            )))

   119

   120

        return entries

   121

    setattr(cls, "GetEntriesList", GetEntriesList)

   122

   123

    def GetSyncManagers(self):

   124

        sync_managers = []

   125

        for sync_manager in self.getSm():

   126

            sync_manager_infos = {}

   127

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

   128

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

   129

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

   130

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

   131

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

   132

                if value is None:

   133

                    value = ""

   134

                sync_manager_infos[name] = value

   135

            sync_managers.append(sync_manager_infos)

   136

        return sync_managers

   137

    setattr(cls, "GetSyncManagers", GetSyncManagers)

   138

   139

   140

def GroupItemCompare(x, y):

   141

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

   142

        if x["type"] == ETHERCAT_GROUP:

   143

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

   144

        else:

   145

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

   146

    elif x["type"] == ETHERCAT_GROUP:

   147

        return -1

   148

    return 1

   149

   150

   151

def SortGroupItems(group):

   152

    for item in group["children"]:

   153

        if item["type"] == ETHERCAT_GROUP:

   154

            SortGroupItems(item)

   155

    group["children"].sort(GroupItemCompare)

   156

   157

   158

class ModulesLibrary:

   159

   160

    MODULES_EXTRA_PARAMS = [

   161

        ("pdo_alignment", {

   162

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

   163

            "column_size": 150,

   164

            "default": 8,

   165

            "description": _(

   166

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

   167

        ("max_pdo_size", {

   168

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

   169

            "column_size": 150,

   170

            "default": 255,

   171

            "description": _(

   172

"""Maximal number of entries mapped in a PDO

   173

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

   174

        ("add_pdo", {

   175

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

   176

            "column_size": 150,

   177

            "default": 0,

   178

            "description": _(

   179

"""Adding a PDO not defined in default configuration

   180

for mapping needed location variables

   181

(1 if possible)""")})

   182

    ]

   183

   184

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

   185

        self.Path = path

   186

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

   187

            os.makedirs(self.Path)

   188

        self.ParentLibrary = parent_library

   189

   190

        if parent_library is not None:

   191

            self.LoadModules()

   192

        else:

   193

            self.Library = None

   194

        self.LoadModulesExtraParams()

   195

   196

    def GetPath(self):

   197

        return self.Path

   198

   199

    def GetModulesExtraParamsFilePath(self):

   200

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

   201

   202

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

   203

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

   204

    def LoadModules(self):

   205

        self.Library = {}

   206

   207

        files = os.listdir(self.Path)

   208

        for file in files:

   209

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

   210

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

   211

                self.modules_infos = None

   212

   213

                xmlfile = open(filepath, 'r')

   214

                try:

   215

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

   216

                    if error is not None:

   217

                        self.GetCTRoot().logger.write_warning(

   218

                            XSDSchemaErrorMessage % (filepath + error))

   219

                except Exception, exc:

   220

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

   221

                xmlfile.close()

   222

   223

                if self.modules_infos is not None:

   224

                    vendor = self.modules_infos.getVendor()

   225

   226

                    vendor_category = self.Library.setdefault(

   227

                        ExtractHexDecValue(vendor.getId()),

   228

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

   229

                         "groups": {}})

   230

   231

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

   232

                        group_type = group.getType()

   233

   234

                        vendor_category["groups"].setdefault(group_type,

   235

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

   236

                             "parent": group.getParentGroup(),

   237

                             "order": group.getSortOrder(),

   238

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

   239

                             "devices": []})

   240

   241

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

   242

                        device_group = device.getGroupType()

   243

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

   244

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

   245

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

   246

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

   247

   248

                else:

   249

   250

                    self.GetCTRoot().logger.write_error(

   251

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

   252

   253

        return self.Library

   254

   255

    def GetModulesLibrary(self, profile_filter=None):

   256

        if self.Library is None:

   257

            self.LoadModules()

   258

        library = []

   259

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

   260

            groups = []

   261

            children_dict = {}

   262

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

   263

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

   264

                               "order": group["order"],

   265

                               "type": ETHERCAT_GROUP,

   266

                               "infos": None,

   267

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

   268

                device_dict = {}

   269

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

   270

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

   271

                        product_code = device.getType().getProductCode()

   272

                        revision_number = device.getType().getRevisionNo()

   273

                        module_infos = {"device_type": device_type,

   274

                                        "vendor": vendor_id,

   275

                                        "product_code": product_code,

   276

                                        "revision_number": revision_number}

   277

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

   278

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

   279

                                        "type": ETHERCAT_DEVICE,

   280

                                        "infos": module_infos,

   281

                                        "children": []}

   282

                        group_infos["children"].append(device_infos)

   283

                        device_type_occurrences = device_dict.setdefault(device_type, [])

   284

                        device_type_occurrences.append(device_infos)

   285

                for device_type_occurrences in device_dict.itervalues():

   286

                    if len(device_type_occurrences) > 1:

   287

                        for occurrence in device_type_occurrences:

   288

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

   289

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

   290

                    if group["parent"] is not None:

   291

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

   292

                        parent_children.append(group_infos)

   293

                    else:

   294

                        groups.append(group_infos)

   295

            if len(groups) > 0:

   296

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

   297

                                "type": ETHERCAT_VENDOR,

   298

                                "infos": None,

   299

                                "children": groups})

   300

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

   301

        return library

   302

   303

    def GetVendors(self):

   304

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

   305

   306

    def GetModuleInfos(self, module_infos):

   307

        vendor = ExtractHexDecValue(module_infos["vendor"])

   308

        vendor_infos = self.Library.get(vendor)

   309

        if vendor_infos is not None:

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

                        self.cntdevice = device_infos

   317

                        self.cntdeviceType = device_type

   318

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

   319

        return None, None

   320

   321

    def ImportModuleLibrary(self, filepath):

   322

        if os.path.isfile(filepath):

   323

            shutil.copy(filepath, self.Path)

   324

            self.LoadModules()

   325

            return True

   326

        return False

   327

   328

    def LoadModulesExtraParams(self):

   329

        self.ModulesExtraParams = {}

   330

   331

        csvfile_path = self.GetModulesExtraParamsFilePath()

   332

        if os.path.exists(csvfile_path):

   333

            csvfile = open(csvfile_path, "rb")

   334

            sample = csvfile.read(1024)

   335

            csvfile.seek(0)

   336

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

   337

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

   338

            reader = csv.reader(csvfile, dialect)

   339

            for row in reader:

   340

                if has_header:

   341

                    has_header = False

   342

                else:

   343

                    params_values = {}

   344

                    for (param, param_infos), value in zip(

   345

                        self.MODULES_EXTRA_PARAMS, row[3:]):

   346

                        if value != "":

   347

                            params_values[param] = int(value)

   348

                    self.ModulesExtraParams[

   349

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

   350

            csvfile.close()

   351

   352

    def SaveModulesExtraParams(self):

   353

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

   354

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

   355

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

   356

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

   357

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

   358

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

   359

                            [module_extra_params.get(param, '')

   360

                             for param in extra_params])

   361

        csvfile.close()

   362

   363

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

   364

        vendor = ExtractHexDecValue(vendor)

   365

        product_code = ExtractHexDecValue(product_code)

   366

        revision_number = ExtractHexDecValue(revision_number)

   367

   368

        module_infos = (vendor, product_code, revision_number)

   369

        self.ModulesExtraParams.setdefault(module_infos, {})

   370

        self.ModulesExtraParams[module_infos][param] = value

   371

   372

        self.SaveModulesExtraParams()

   373

   374

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

   375

        vendor = ExtractHexDecValue(vendor)

   376

        product_code = ExtractHexDecValue(product_code)

   377

        revision_number = ExtractHexDecValue(revision_number)

   378

   379

        if self.ParentLibrary is not None:

   380

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

   381

        else:

   382

            extra_params = {}

   383

   384

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

   385

   386

        for param, param_infos in self.MODULES_EXTRA_PARAMS:

   387

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

   388

   389

        return extra_params

   390

   391

   392

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

   393

if wx.Platform != '__WXMSW__':

   394

    USERDATA_DIR += '_files'

   395

   396

ModulesDatabase = ModulesLibrary(

   397

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

   398

   399

   400

class RootClass:

   401

   402

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

   403

    EditorType = LibraryEditor

   404

   405

    def __init__(self):

   406

        self.ModulesLibrary = None

   407

        self.LoadModulesLibrary()

   408

   409

    def GetIconName(self):

   410

        return "Ethercat"

   411

   412

    def GetModulesLibraryPath(self, project_path=None):

   413

        if project_path is None:

   414

            project_path = self.CTNPath()

   415

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

   416

   417

    def OnCTNSave(self, from_project_path=None):

   418

        if from_project_path is not None:

   419

            shutil.copytree(self.GetModulesLibraryPath(from_project_path),

   420

                            self.GetModulesLibraryPath())

   421

        return True

   422

   423

    def CTNGenerate_C(self, buildpath, locations):

   424

        return [], "", False

   425

   426

    def LoadModulesLibrary(self):

   427

        if self.ModulesLibrary is None:

   428

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

   429

        else:

   430

            self.ModulesLibrary.LoadModulesLibrary()

   431

   432

    def GetModulesDatabaseInstance(self):

   433

        return ModulesDatabase

   434

   435

    def GetModulesLibraryInstance(self):

   436

        return self.ModulesLibrary

   437

   438

    def GetModulesLibrary(self, profile_filter=None):

   439

        return self.ModulesLibrary.GetModulesLibrary(profile_filter)

   440

   441

    def GetVendors(self):

   442

        return self.ModulesLibrary.GetVendors()

   443

   444

    def GetModuleInfos(self, module_infos):

   445

        return self.ModulesLibrary.GetModuleInfos(module_infos)