1

#!/usr/bin/env python

     2

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

     3

     4

     5

# This file is part of Beremiz

     6

#

     7

# Copyright (C) 2013: Real-Time & Embedded Systems (RTES) Lab. University of Seoul, Korea

     8

#

     9

# See COPYING file for copyrights details.

    10

    11

from __future__ import absolute_import

    12

from __future__ import division

    13

from builtins import str as text

    14

import codecs

    15

import wx

    16

    17

    18

mailbox_protocols = ["AoE", "EoE", "CoE", "FoE", "SoE", "VoE"]

    19

    20

    21

def ExtractHexDecValue(value):

    22

    """

    23

     convert numerical value in string format into decimal or hex format.

    24

     @param value : hex or decimal data

    25

     @return integer data

    26

    """

    27

    try:

    28

        return int(value)

    29

    except Exception:

    30

        pass

    31

    try:

    32

        return int(value.replace("#", "0"), 16)

    33

    34

    except Exception:

    35

        raise ValueError(_("Invalid value for HexDecValue \"%s\"") % value)

    36

    37

    38

def ExtractName(names, default=None):

    39

    """

    40

     Extract "name" field from XML entries.

    41

     @param names : XML entry

    42

     @default : if it fails to extract from the designated XML entry, return the default value ("None").

    43

     @return default or the name extracted

    44

    """

    45

    if len(names) == 1:

    46

        return names[0].getcontent()

    47

    else:

    48

        for name in names:

    49

            if name.getLcId() == 1033:

    50

                return name.getcontent()

    51

    return default

    52

    53

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

    54

#         Remote Exec Etherlab Commands

    55

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

    56

    57

    58

# --------------------- for master ---------------------------

    59

MASTER_STATE = """

    60

import commands

    61

result = commands.getoutput("ethercat master")

    62

returnVal =result

    63

"""

    64

    65

# --------------------- for slave ----------------------------

    66

# ethercat state -p (slave position) (state (INIT, PREOP, SAFEOP, OP))

    67

SLAVE_STATE = """

    68

import commands

    69

result = commands.getoutput("ethercat state -p %d %s")

    70

returnVal = result

    71

"""

    72

    73

# ethercat slave

    74

GET_SLAVE = """

    75

import commands

    76

result = commands.getoutput("ethercat slaves")

    77

returnVal =result

    78

"""

    79

    80

# ethercat xml -p (slave position)

    81

SLAVE_XML = """

    82

import commands

    83

result = commands.getoutput("ethercat xml -p %d")

    84

returnVal = result

    85

"""

    86

    87

# ethercat sdos -p (slave position)

    88

SLAVE_SDO = """

    89

import commands

    90

result = commands.getoutput("ethercat sdos -p %d")

    91

returnVal =result

    92

"""

    93

    94

# ethercat upload -p (slave position) (main index) (sub index)

    95

GET_SLOW_SDO = """

    96

import commands

    97

result = commands.getoutput("ethercat upload -p %d %s %s")

    98

returnVal =result

    99

"""

   100

   101

# ethercat download -p (slave position) (main index) (sub index) (value)

   102

SDO_DOWNLOAD = """

   103

import commands

   104

result = commands.getoutput("ethercat download --type %s -p %d %s %s %s")

   105

returnVal =result

   106

"""

   107

   108

# ethercat sii_read -p (slave position)

   109

SII_READ = """

   110

import commands

   111

result = commands.getoutput("ethercat sii_read -p %d")

   112

returnVal =result

   113

"""

   114

   115

# ethercat reg_read -p (slave position) (address) (size)

   116

REG_READ = """

   117

import commands

   118

result = commands.getoutput("ethercat reg_read -p %d %s %s")

   119

returnVal =result

   120

"""

   121

   122

# ethercat sii_write -p (slave position) - (contents)

   123

SII_WRITE = """

   124

import subprocess

   125

process = subprocess.Popen(

   126

    ["ethercat", "-f", "sii_write", "-p", "%d", "-"],

   127

    stdin=subprocess.PIPE)

   128

process.communicate(sii_data)

   129

returnVal = process.returncode

   130

"""

   131

   132

# ethercat reg_write -p (slave position) -t (uinit16) (address) (data)

   133

REG_WRITE = """

   134

import commands

   135

result = commands.getoutput("ethercat reg_write -p %d -t uint16 %s %s")

   136

returnVal =result

   137

"""

   138

   139

# ethercat rescan -p (slave position)

   140

RESCAN = """

   141

import commands

   142

result = commands.getoutput("ethercat rescan -p %d")

   143

returnVal =result

   144

"""

   145

   146

   147

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

   148

#    Common Method For EtherCAT Management

   149

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

   150

class _CommonSlave(object):

   151

   152

    # ----- Data Structure for ethercat management ----

   153

    SlaveState = ""

   154

   155

    # category of SDO data

   156

    DatatypeDescription, CommunicationObject, ManufacturerSpecific, \

   157

        ProfileSpecific, Reserved, AllSDOData = range(6)

   158

   159

    # store the execution result of "ethercat sdos" command into SaveSDOData.

   160

    SaveSDOData = []

   161

   162

    # Flags for checking "write" permission of OD entries

   163

    CheckPREOP = False

   164

    CheckSAFEOP = False

   165

    CheckOP = False

   166

   167

    # Save PDO Data

   168

    TxPDOInfo = []

   169

    TxPDOCategory = []

   170

    RxPDOInfo = []

   171

    RxPDOCategory = []

   172

   173

    # Save EEPROM Data

   174

    SiiData = ""

   175

   176

    # Save Register Data

   177

    RegData = ""

   178

    CrtRegSpec = {"ESCType": "",

   179

                  "FMMUNumber": "",

   180

                  "SMNumber": "",

   181

                  "PDIType": ""}

   182

   183

    def __init__(self, controler):

   184

        """

   185

        Constructor

   186

        @param controler: _EthercatSlaveCTN class in EthercatSlave.py

   187

        """

   188

        self.Controler = controler

   189

        self.HexDecode = codecs.getdecoder("hex_codec")

   190

        self.ClearSDODataSet()

   191

   192

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

   193

    #                        Used Master State

   194

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

   195

    def GetMasterState(self):

   196

        """

   197

        Execute "ethercat master" command and parse the execution result

   198

        @return MasterState

   199

        """

   200

   201

        # exectute "ethercat master" command

   202

        _error, return_val = self.Controler.RemoteExec(MASTER_STATE, return_val=None)

   203

        master_state = {}

   204

        # parse the reslut

   205

        for each_line in return_val.splitlines():

   206

            if len(each_line) > 0:

   207

                chunks = each_line.strip().split(':', 1)

   208

                key = chunks[0]

   209

                value = []

   210

                if len(chunks) > 1:

   211

                    value = chunks[1].split()

   212

                if '(attached)' in value:

   213

                    value.remove('(attached)')

   214

                master_state[key] = value

   215

   216

        return master_state

   217

   218

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

   219

    #                        Used Slave State

   220

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

   221

    def RequestSlaveState(self, command):

   222

        """

   223

        Set slave state to the specified one using "ethercat states -p %d %s" command.

   224

        Command example : "ethercat states -p 0 PREOP" (target slave position and target state are given.)

   225

        @param command : target slave state

   226

        """

   227

        _error, _return_val = self.Controler.RemoteExec(

   228

            SLAVE_STATE % (self.Controler.GetSlavePos(), command),

   229

            return_val=None)

   230

   231

    def GetSlaveStateFromSlave(self):

   232

        """

   233

        Get slave information using "ethercat slaves" command and store the information into internal data structure

   234

        (self.SlaveState) for "Slave State"

   235

        return_val example : 0  0:0  PREOP  +  EL9800 (V4.30) (PIC24, SPI, ET1100)

   236

        """

   237

        _error, return_val = self.Controler.RemoteExec(GET_SLAVE, return_val=None)

   238

        self.SlaveState = return_val

   239

        return return_val

   240

   241

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

   242

    #                        Used SDO Management

   243

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

   244

    def GetSlaveSDOFromSlave(self):

   245

        """

   246

        Get SDO objects information of current slave using "ethercat sdos -p %d" command.

   247

        Command example : "ethercat sdos -p 0"

   248

        @return return_val : execution results of "ethercat sdos" command (need to be parsed later)

   249

        """

   250

        _error, return_val = self.Controler.RemoteExec(SLAVE_SDO % (self.Controler.GetSlavePos()), return_val=None)

   251

        return return_val

   252

   253

    def SDODownload(self, data_type, idx, sub_idx, value):

   254

        """

   255

        Set an SDO object value to user-specified value using "ethercat download" command.

   256

        Command example : "ethercat download --type int32 -p 0 0x8020 0x12 0x00000000"

   257

        @param data_type : data type of SDO entry

   258

        @param idx : index of the SDO entry

   259

        @param sub_idx : subindex of the SDO entry

   260

        @param value : value of SDO entry

   261

        """

   262

        _error, _return_val = self.Controler.RemoteExec(

   263

            SDO_DOWNLOAD % (data_type, self.Controler.GetSlavePos(), idx, sub_idx, value),

   264

            return_val=None)

   265

   266

    def BackupSDODataSet(self):

   267

        """

   268

        Back-up current SDO entry information to restore the SDO data

   269

        in case that the user cancels SDO update operation.

   270

        """

   271

        self.BackupDatatypeDescription = self.SaveDatatypeDescription

   272

        self.BackupCommunicationObject = self.SaveCommunicationObject

   273

        self.BackupManufacturerSpecific = self.SaveManufacturerSpecific

   274

        self.BackupProfileSpecific = self.SaveProfileSpecific

   275

        self.BackupReserved = self.SaveReserved

   276

        self.BackupAllSDOData = self.SaveAllSDOData

   277

   278

    def ClearSDODataSet(self):

   279

        """

   280

        Clear the specified SDO entry information.

   281

        """

   282

        for dummy in range(6):

   283

            self.SaveSDOData.append([])

   284

   285

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

   286

    #                        Used PDO Monitoring

   287

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

   288

    def RequestPDOInfo(self):

   289

        """

   290

        Load slave information from RootClass (XML data) and parse the information (calling SlavePDOData() method).

   291

        """

   292

        # Load slave information from ESI XML file (def EthercatMaster.py)

   293

        slave = self.Controler.CTNParent.GetSlave(self.Controler.GetSlavePos())

   294

   295

        type_infos = slave.getType()

   296

        device, _alignment = self.Controler.CTNParent.GetModuleInfos(type_infos)

   297

        # Initialize PDO data set

   298

        self.ClearDataSet()

   299

   300

        # if 'device' object is valid, call SavePDOData() to parse PDO data

   301

        if device is not None:

   302

            self.SavePDOData(device)

   303

   304

    def SavePDOData(self, device):

   305

        """

   306

        Parse PDO data and store the results in TXPDOCategory and RXPDOCategory

   307

        Tx(Rx)PDOCategory : index, name, entry number

   308

        Tx(Rx)Info : entry index, sub index, name, length, type

   309

        @param device : Slave information extracted from ESI XML file

   310

        """

   311

        # Parsing TXPDO entries

   312

        for pdo, _pdo_info in ([(pdo, "Inputs") for pdo in device.getTxPdo()]):

   313

            # Save pdo_index, entry, and name of each entry

   314

            pdo_index = ExtractHexDecValue(pdo.getIndex().getcontent())

   315

            entries = pdo.getEntry()

   316

            pdo_name = ExtractName(pdo.getName())

   317

   318

            # Initialize entry number count

   319

            count = 0

   320

   321

            # Parse entries

   322

            for entry in entries:

   323

                # Save index and subindex

   324

                index = ExtractHexDecValue(entry.getIndex().getcontent())

   325

                subindex = ExtractHexDecValue(entry.getSubIndex())

   326

                # if entry name exists, save entry data

   327

                if ExtractName(entry.getName()) is not None:

   328

                    entry_infos = {

   329

                        "entry_index": index,

   330

                        "subindex": subindex,

   331

                        "name": ExtractName(entry.getName()),

   332

                        "bitlen": entry.getBitLen(),

   333

                        "type": entry.getDataType().getcontent()

   334

                    }

   335

                    self.TxPDOInfo.append(entry_infos)

   336

                    count += 1

   337

   338

            categorys = {"pdo_index": pdo_index, "name": pdo_name, "number_of_entry": count}

   339

            self.TxPDOCategory.append(categorys)

   340

   341

        # Parsing RxPDO entries

   342

        for pdo, _pdo_info in ([(rxpdo, "Outputs") for rxpdo in device.getRxPdo()]):

   343

            # Save pdo_index, entry, and name of each entry

   344

            pdo_index = ExtractHexDecValue(pdo.getIndex().getcontent())

   345

            entries = pdo.getEntry()

   346

            pdo_name = ExtractName(pdo.getName())

   347

   348

            # Initialize entry number count

   349

            count = 0

   350

   351

            # Parse entries

   352

            for entry in entries:

   353

                # Save index and subindex

   354

                index = ExtractHexDecValue(entry.getIndex().getcontent())

   355

                subindex = ExtractHexDecValue(entry.getSubIndex())

   356

                # if entry name exists, save entry data

   357

                if ExtractName(entry.getName()) is not None:

   358

                    entry_infos = {

   359

                        "entry_index": index,

   360

                        "subindex": subindex,

   361

                        "name": ExtractName(entry.getName()),

   362

                        "bitlen": str(entry.getBitLen()),

   363

                        "type": entry.getDataType().getcontent()

   364

                    }

   365

                    self.RxPDOInfo.append(entry_infos)

   366

                    count += 1

   367

   368

            categorys = {"pdo_index": pdo_index, "name": pdo_name, "number_of_entry": count}

   369

            self.RxPDOCategory.append(categorys)

   370

   371

    def GetTxPDOCategory(self):

   372

        """

   373

        Get TxPDOCategory data structure (Meta informaton of TxPDO).

   374

        TxPDOCategorys : index, name, number of entries

   375

        @return TxPDOCategorys

   376

        """

   377

        return self.TxPDOCategory

   378

   379

    def GetRxPDOCategory(self):

   380

        """

   381

        Get RxPDOCategory data structure (Meta information of RxPDO).

   382

        RxPDOCategorys : index, name, number of entries

   383

        @return RxPDOCategorys

   384

        """

   385

        return self.RxPDOCategory

   386

   387

    def GetTxPDOInfo(self):

   388

        """

   389

        Get TxPDOInfo data structure (Detailed information on TxPDO entries).

   390

        TxPDOInfos : entry index, sub index, name, length, type

   391

        @return TxPDOInfos

   392

        """

   393

        return self.TxPDOInfo

   394

   395

    def GetRxPDOInfo(self):

   396

        """

   397

        Get RxPDOInfo data structure (Detailed information on RxPDO entries).

   398

        RxPDOInfos : entry index, sub index, name, length, type

   399

        @return RxPDOInfos

   400

        """

   401

        return self.RxPDOInfo

   402

   403

    def ClearDataSet(self):

   404

        """

   405

        Initialize PDO management data structure.

   406

        """

   407

        self.TxPDOInfos = []

   408

        self.TxPDOCategorys = []

   409

        self.RxPDOInfos = []

   410

        self.RxPDOCategorys = []

   411

   412

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

   413

    #                        Used EEPROM Management

   414

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

   415

    # Base data types in ETG2000; format = {"Name": "BitSize"}

   416

    BaseDataTypeDict = {"BOOL": "01",

   417

                        "SINT": "02",

   418

                        "INT": "03",

   419

                        "DINT": "04",

   420

                        "USINT": "05",

   421

                        "UINT": "06",

   422

                        "UDINT": "07",

   423

                        "REAL": "08",

   424

                        "INT24": "10",

   425

                        "LREAL": "11",

   426

                        "INT40": "12",

   427

                        "INT48": "13",

   428

                        "INT56": "14",

   429

                        "LINT": "15",

   430

                        "UINT24": "16",

   431

                        "UINT40": "18",

   432

                        "UINT48": "19",

   433

                        "UINT56": "1a",

   434

                        "ULINT": "1b",

   435

                        "BITARR8": "2d",

   436

                        "BITARR16": "2e",

   437

                        "BITARR32": "2f",

   438

                        "BIT1": "30",

   439

                        "BIT2": "31",

   440

                        "BIT3": "32",

   441

                        "BIT4": "33",

   442

                        "BIT5": "34",

   443

                        "BIT6": "35",

   444

                        "BIT7": "36",

   445

                        "BIT8": "37"}

   446

   447

    def GetSmartViewInfos(self):

   448

        """

   449

        Parse XML data for "Smart View" of EEPROM contents.

   450

        @return smartview_infos : EEPROM contents dictionary

   451

        """

   452

   453

        smartview_infos = {"eeprom_size": 128,

   454

                           "pdi_type": 0,

   455

                           "device_emulation": "False",

   456

                           "vendor_id": '0x00000000',

   457

                           "product_code": '0x00000000',

   458

                           "revision_no": '0x00000000',

   459

                           "serial_no": '0x00000000',

   460

                           "supported_mailbox": "",

   461

                           "mailbox_bootstrapconf_outstart": '0',

   462

                           "mailbox_bootstrapconf_outlength": '0',

   463

                           "mailbox_bootstrapconf_instart": '0',

   464

                           "mailbox_bootstrapconf_inlength": '0',

   465

                           "mailbox_standardconf_outstart": '0',

   466

                           "mailbox_standardconf_outlength": '0',

   467

                           "mailbox_standardconf_instart": '0',

   468

                           "mailbox_standardconf_inlength": '0'}

   469

   470

        slave = self.Controler.CTNParent.GetSlave(self.Controler.GetSlavePos())

   471

        type_infos = slave.getType()

   472

        device, _alignment = self.Controler.CTNParent.GetModuleInfos(type_infos)

   473

   474

        # 'device' represents current slave device selected by user

   475

        if device is not None:

   476

            for eeprom_element in device.getEeprom().getcontent():

   477

                # get EEPROM size; <Device>-<Eeprom>-<ByteSize>

   478

                if eeprom_element["name"] == "ByteSize":

   479

                    smartview_infos["eeprom_size"] = eeprom_element

   480

   481

                elif eeprom_element["name"] == "ConfigData":

   482

                    configData_data = self.DecimalToHex(eeprom_element)

   483

                    # get PDI type; <Device>-<Eeprom>-<ConfigData> address 0x00

   484

                    smartview_infos["pdi_type"] = int(configData_data[0:2], 16)