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

    13

from builtins import str as text

    14

import wx

    15

    16

    17

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

    18

    19

    20

def ExtractHexDecValue(value):

    21

    """

    22

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

    23

     @param value : hex or decimal data

    24

     @return integer data

    25

    """

    26

    try:

    27

        return int(value)

    28

    except Exception:

    29

        pass

    30

    try:

    31

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

    32

    33

    except Exception:

    34

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

    35

    36

    37

def ExtractName(names, default=None):

    38

    """

    39

     Extract "name" field from XML entries.

    40

     @param names : XML entry

    41

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

    42

     @return default or the name extracted

    43

    """

    44

    if len(names) == 1:

    45

        return names[0].getcontent()

    46

    else:

    47

        for name in names:

    48

            if name.getLcId() == 1033:

    49

                return name.getcontent()

    50

    return default

    51

    52

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

    53

#         Remote Exec Etherlab Commands

    54

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

    55

    56

    57

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

    58

MASTER_STATE = """

    59

import commands

    60

result = commands.getoutput("ethercat master")

    61

returnVal =result

    62

"""

    63

    64

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

    65

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

    66

SLAVE_STATE = """

    67

import commands

    68

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

    69

returnVal = result

    70

"""

    71

    72

# ethercat slave

    73

GET_SLAVE = """

    74

import commands

    75

result = commands.getoutput("ethercat slaves")

    76

returnVal =result

    77

"""

    78

    79

# ethercat xml -p (slave position)

    80

SLAVE_XML = """

    81

import commands

    82

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

    83

returnVal = result

    84

"""

    85

    86

# ethercat sdos -p (slave position)

    87

SLAVE_SDO = """

    88

import commands

    89

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

    90

returnVal =result

    91

"""

    92

    93

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

    94

GET_SLOW_SDO = """

    95

import commands

    96

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

    97

returnVal =result

    98

"""

    99

   100

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

   101

SDO_DOWNLOAD = """

   102

import commands

   103

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

   104

returnVal =result

   105

"""

   106

   107

# ethercat sii_read -p (slave position)

   108

SII_READ = """

   109

import commands

   110

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

   111

returnVal =result

   112

"""

   113

   114

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

   115

REG_READ = """

   116

import commands

   117

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

   118

returnVal =result

   119

"""

   120

   121

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

   122

SII_WRITE = """

   123

import subprocess

   124

process = subprocess.Popen(

   125

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

   126

    stdin=subprocess.PIPE)

   127

process.communicate(sii_data)

   128

returnVal = process.returncode

   129

"""

   130

   131

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

   132

REG_WRITE = """

   133

import commands

   134

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

   135

returnVal =result

   136

"""

   137

   138

# ethercat rescan -p (slave position)

   139

RESCAN = """

   140

import commands

   141

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

   142

returnVal =result

   143

"""

   144

   145

   146

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

   147

#    Common Method For EtherCAT Management

   148

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

   149

class _CommonSlave(object):

   150

   151

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

   152

    SlaveState = ""

   153

   154

    # category of SDO data

   155

    DatatypeDescription, CommunicationObject, ManufacturerSpecific, \

   156

        ProfileSpecific, Reserved, AllSDOData = range(6)

   157

   158

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

   159

    SaveSDOData = []

   160

   161

    # Flags for checking "write" permission of OD entries

   162

    CheckPREOP = False

   163

    CheckSAFEOP = False

   164

    CheckOP = False

   165

   166

    # Save PDO Data

   167

    TxPDOInfo = []

   168

    TxPDOCategory = []

   169

    RxPDOInfo = []

   170

    RxPDOCategory = []

   171

   172

    # Save EEPROM Data

   173

    SiiData = ""

   174

   175

    # Save Register Data

   176

    RegData = ""

   177

    CrtRegSpec = {"ESCType": "",

   178

                  "FMMUNumber": "",

   179

                  "SMNumber": "",

   180

                  "PDIType": ""}

   181

   182

    def __init__(self, controler):

   183

        """

   184

        Constructor

   185

        @param controler: _EthercatSlaveCTN class in EthercatSlave.py

   186

        """

   187

        self.Controler = controler

   188

   189

        self.ClearSDODataSet()

   190

   191

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

   192

    #                        Used Master State

   193

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

   194

    def GetMasterState(self):

   195

        """

   196

        Execute "ethercat master" command and parse the execution result

   197

        @return MasterState

   198

        """

   199

   200

        # exectute "ethercat master" command

   201

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

   202

        master_state = {}

   203

        # parse the reslut

   204

        for each_line in return_val.splitlines():

   205

            if len(each_line) > 0:

   206

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

   207

                key = chunks[0]

   208

                value = []

   209

                if len(chunks) > 1:

   210

                    value = chunks[1].split()

   211

                if '(attached)' in value:

   212

                    value.remove('(attached)')

   213

                master_state[key] = value

   214

   215

        return master_state

   216

   217

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

   218

    #                        Used Slave State

   219

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

   220

    def RequestSlaveState(self, command):

   221

        """

   222

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

   223

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

   224

        @param command : target slave state

   225

        """

   226

        _error, _return_val = self.Controler.RemoteExec(

   227

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

   228

            return_val=None)

   229

   230

    def GetSlaveStateFromSlave(self):

   231

        """

   232

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

   233

        (self.SlaveState) for "Slave State"

   234

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

   235

        """

   236

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

   237

        self.SlaveState = return_val

   238

        return return_val

   239

   240

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

   241

    #                        Used SDO Management

   242

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

   243

    def GetSlaveSDOFromSlave(self):

   244

        """

   245

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

   246

        Command example : "ethercat sdos -p 0"

   247

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

   248

        """

   249

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

   250

        return return_val

   251

   252

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

   253

        """

   254

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

   255

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

   256

        @param data_type : data type of SDO entry

   257

        @param idx : index of the SDO entry

   258

        @param sub_idx : subindex of the SDO entry

   259

        @param value : value of SDO entry

   260

        """

   261

        _error, _return_val = self.Controler.RemoteExec(

   262

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

   263

            return_val=None)

   264

   265

    def BackupSDODataSet(self):

   266

        """

   267

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

   268

        in case that the user cancels SDO update operation.

   269

        """

   270

        self.BackupDatatypeDescription = self.SaveDatatypeDescription

   271

        self.BackupCommunicationObject = self.SaveCommunicationObject

   272

        self.BackupManufacturerSpecific = self.SaveManufacturerSpecific

   273

        self.BackupProfileSpecific = self.SaveProfileSpecific

   274

        self.BackupReserved = self.SaveReserved

   275

        self.BackupAllSDOData = self.SaveAllSDOData

   276

   277

    def ClearSDODataSet(self):

   278

        """

   279

        Clear the specified SDO entry information.

   280

        """

   281

        for dummy in range(6):

   282

            self.SaveSDOData.append([])

   283

   284

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

   285

    #                        Used PDO Monitoring

   286

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

   287

    def RequestPDOInfo(self):

   288

        """

   289

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

   290

        """

   291

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

   292

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

   293

   294

        type_infos = slave.getType()

   295

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

   296

        # Initialize PDO data set

   297

        self.ClearDataSet()

   298

   299

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

   300

        if device is not None:

   301

            self.SavePDOData(device)

   302

   303

    def SavePDOData(self, device):

   304

        """

   305

        Parse PDO data and store the results in TXPDOCategory and RXPDOCategory

   306

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

   307

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

   308

        @param device : Slave information extracted from ESI XML file

   309

        """

   310

        # Parsing TXPDO entries

   311

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

   312

            # Save pdo_index, entry, and name of each entry

   313

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

   314

            entries = pdo.getEntry()

   315

            pdo_name = ExtractName(pdo.getName())

   316

   317

            # Initialize entry number count

   318

            count = 0

   319

   320

            # Parse entries

   321

            for entry in entries:

   322

                # Save index and subindex

   323

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

   324

                subindex = ExtractHexDecValue(entry.getSubIndex())

   325

                # if entry name exists, save entry data

   326

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

   327

                    entry_infos = {

   328

                        "entry_index": index,

   329

                        "subindex": subindex,

   330

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

   331

                        "bitlen": entry.getBitLen(),

   332

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

   333

                    }

   334

                    self.TxPDOInfo.append(entry_infos)

   335

                    count += 1

   336

   337

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

   338

            self.TxPDOCategory.append(categorys)

   339

   340

        # Parsing RxPDO entries

   341

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

   342

            # Save pdo_index, entry, and name of each entry

   343

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

   344

            entries = pdo.getEntry()

   345

            pdo_name = ExtractName(pdo.getName())

   346

   347

            # Initialize entry number count

   348

            count = 0

   349

   350

            # Parse entries

   351

            for entry in entries:

   352

                # Save index and subindex

   353

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

   354

                subindex = ExtractHexDecValue(entry.getSubIndex())

   355

                # if entry name exists, save entry data

   356

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

   357

                    entry_infos = {

   358

                        "entry_index": index,

   359

                        "subindex": subindex,

   360

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

   361

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

   362

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

   363

                    }

   364

                    self.RxPDOInfo.append(entry_infos)

   365

                    count += 1

   366

   367

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

   368

            self.RxPDOCategory.append(categorys)

   369

   370

    def GetTxPDOCategory(self):

   371

        """

   372

        Get TxPDOCategory data structure (Meta informaton of TxPDO).

   373

        TxPDOCategorys : index, name, number of entries

   374

        @return TxPDOCategorys

   375

        """

   376

        return self.TxPDOCategory

   377

   378

    def GetRxPDOCategory(self):

   379

        """

   380

        Get RxPDOCategory data structure (Meta information of RxPDO).

   381

        RxPDOCategorys : index, name, number of entries

   382

        @return RxPDOCategorys

   383

        """

   384

        return self.RxPDOCategory

   385

   386

    def GetTxPDOInfo(self):

   387

        """

   388

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

   389

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

   390

        @return TxPDOInfos

   391

        """

   392

        return self.TxPDOInfo

   393

   394

    def GetRxPDOInfo(self):

   395

        """

   396

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

   397

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

   398

        @return RxPDOInfos

   399

        """

   400

        return self.RxPDOInfo

   401

   402

    def ClearDataSet(self):

   403

        """

   404

        Initialize PDO management data structure.

   405

        """

   406

        self.TxPDOInfos = []

   407

        self.TxPDOCategorys = []

   408

        self.RxPDOInfos = []

   409

        self.RxPDOCategorys = []

   410

   411

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

   412

    #                        Used EEPROM Management

   413

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

   414

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

   415

    BaseDataTypeDict = {"BOOL": "01",

   416

                        "SINT": "02",

   417

                        "INT": "03",

   418

                        "DINT": "04",

   419

                        "USINT": "05",

   420

                        "UINT": "06",

   421

                        "UDINT": "07",

   422

                        "REAL": "08",

   423

                        "INT24": "10",

   424

                        "LREAL": "11",

   425

                        "INT40": "12",

   426

                        "INT48": "13",

   427

                        "INT56": "14",

   428

                        "LINT": "15",

   429

                        "UINT24": "16",

   430

                        "UINT40": "18",

   431

                        "UINT48": "19",

   432

                        "UINT56": "1a",

   433

                        "ULINT": "1b",

   434

                        "BITARR8": "2d",

   435

                        "BITARR16": "2e",

   436

                        "BITARR32": "2f",

   437

                        "BIT1": "30",

   438

                        "BIT2": "31",

   439

                        "BIT3": "32",

   440

                        "BIT4": "33",

   441

                        "BIT5": "34",

   442

                        "BIT6": "35",

   443

                        "BIT7": "36",

   444

                        "BIT8": "37"}

   445

   446

    def GetSmartViewInfos(self):

   447

        """

   448

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

   449

        @return smartview_infos : EEPROM contents dictionary

   450

        """

   451

   452

        smartview_infos = {"eeprom_size": 128,

   453

                           "pdi_type": 0,

   454

                           "device_emulation": "False",

   455

                           "vendor_id": '0x00000000',

   456

                           "product_code": '0x00000000',

   457

                           "revision_no": '0x00000000',

   458

                           "serial_no": '0x00000000',

   459

                           "supported_mailbox": "",

   460

                           "mailbox_bootstrapconf_outstart": '0',

   461

                           "mailbox_bootstrapconf_outlength": '0',

   462

                           "mailbox_bootstrapconf_instart": '0',

   463

                           "mailbox_bootstrapconf_inlength": '0',

   464

                           "mailbox_standardconf_outstart": '0',

   465

                           "mailbox_standardconf_outlength": '0',

   466

                           "mailbox_standardconf_instart": '0',

   467

                           "mailbox_standardconf_inlength": '0'}

   468

   469

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

   470

        type_infos = slave.getType()

   471

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

   472

   473

        # 'device' represents current slave device selected by user

   474

        if device is not None:

   475

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

   476

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

   477

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

   478

                    smartview_infos["eeprom_size"] = eeprom_element

   479

   480

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

   481

                    configData_data = self.DecimalToHex(eeprom_element)

   482

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

   483

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

   484

                    # get state of device emulation; <Device>-<Eeprom>-<ConfigData> address 0x01