1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz

     5

#

     6

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

     7

#

     8

# See COPYING file for copyrights details.

     9

    10

import os

    11

import string

    12

from xml.dom import minidom

    13

    14

import wx

    15

import wx.grid

    16

import wx.gizmos

    17

import wx.lib.buttons

    18

    19

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

    20

from controls import CustomGrid, CustomTable

    21

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

    22

    23

# ------------ for register management ---------------

    24

    25

from util.TranslationCatalogs import NoTranslate

    26

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

    27

    28

    29

# ----------------------------- For Sync Manager Table -----------------------------------

    30

def GetSyncManagersTableColnames():

    31

    """

    32

    Returns column names of SyncManager Table in Slave state panel.

    33

    """

    34

    _ = NoTranslate

    35

    return ["#", _("Name"), _("Start Address"), _("Default Size"), _("Control Byte"), _("Enable")]

    36

    37

    38

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

    39

#                    Sync Managers Table

    40

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

    41

class SyncManagersTable(CustomTable):

    42

    def GetValue(self, row, col):

    43

        if row < self.GetNumberRows():

    44

            if col == 0:

    45

                return row

    46

            return self.data[row].get(self.GetColLabelValue(col, False), "")

    47

    48

    49

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

    50

#                    EtherCAT Management Treebook

    51

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

    52

class EtherCATManagementTreebook(wx.Treebook):

    53

    def __init__(self, parent, controler, node_editor):

    54

        """

    55

        Constructor

    56

        @param parent: Reference to the parent wx.ScrolledWindow object

    57

        @param controler: _EthercatSlaveCTN class in EthercatSlave.py

    58

        @param node_editor: Reference to Beremiz frame

    59

        """

    60

        wx.Treebook.__init__(self, parent, -1, size=wx.DefaultSize, style=wx.BK_DEFAULT)

    61

        self.parent = parent

    62

        self.Controler = controler

    63

        self.NodeEditor = node_editor

    64

    65

        self.EtherCATManagementClassObject = {}

    66

    67

        # fill EtherCAT Management Treebook

    68

        panels = [

    69

            ("Slave State",        SlaveStatePanelClass, []),

    70

            ("SDO Management",     SDOPanelClass, []),

    71

            ("PDO Monitoring",     PDOPanelClass, []),

    72

            ("ESC Management",     EEPROMAccessPanel, [

    73

                ("Smart View", SlaveSiiSmartView),

    74

                ("Hex View", HexView)]),

    75

            ("Register Access",     RegisterAccessPanel, [])

    76

        ]

    77

        for pname, pclass, subs in panels:

    78

            self.AddPage(pclass(self, self.Controler), pname)

    79

            for spname, spclass in subs:

    80

                self.AddSubPage(spclass(self, self.Controler), spname)

    81

    82

        self.Bind(wx.EVT_TREEBOOK_PAGE_CHANGED, self.OnPageChanged)

    83

        self.Bind(wx.EVT_TREEBOOK_PAGE_CHANGING, self.OnPageChanging)

    84

    85

    def OnPageChanged(self, event):

    86

        old = event.GetOldSelection()

    87

        new = event.GetSelection()

    88

        sel = event.GetSelection()

    89

        event.Skip()

    90

    91

    def OnPageChanging(self, event):

    92

        old = event.GetOldSelection()

    93

        new = event.GetSelection()

    94

        sel = event.GetSelection()

    95

        event.Skip()

    96

    97

    98

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

    99

#                    For SlaveState Panel

   100

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

   101

class SlaveStatePanelClass(wx.Panel):

   102

    def __init__(self, parent, controler):

   103

        """

   104

        Constructor

   105

        @param parent: Reference to the parent EtherCATManagementTreebook class

   106

        @param controler: _EthercatSlaveCTN class in EthercatSlave.py

   107

        """

   108

        wx.Panel.__init__(self, parent, -1, (0, 0), size=wx.DefaultSize, style=wx.SUNKEN_BORDER)

   109

        self.Controler = controler

   110

        self.parent = parent

   111

   112

        # initialize SlaveStatePanel UI dictionaries

   113

        self.StaticBoxDic = {}

   114

        self.StaticTextDic = {}

   115

        self.TextCtrlDic = {}

   116

        self.ButtonDic = {}

   117

   118

        # iniitalize BoxSizer and FlexGridSizer

   119

        self.SizerDic = {

   120

            "SlaveState_main_sizer": wx.BoxSizer(wx.VERTICAL),

   121

            "SlaveState_inner_main_sizer": wx.FlexGridSizer(cols=1, hgap=50, rows=3, vgap=10),

   122

            "SlaveInfosDetailsInnerSizer": wx.FlexGridSizer(cols=4, hgap=10, rows=2, vgap=10),

   123

            "SyncManagerInnerSizer": wx.FlexGridSizer(cols=1, hgap=5, rows=1, vgap=5),

   124

            "SlaveState_sizer": wx.FlexGridSizer(cols=1, hgap=10, rows=2, vgap=10),

   125

            "SlaveState_up_sizer": wx.FlexGridSizer(cols=4, hgap=10, rows=2, vgap=10),

   126

            "SlaveState_down_sizer": wx.FlexGridSizer(cols=2, hgap=10, rows=1, vgap=10)}

   127

   128

        # initialize StaticBox and StaticBoxSizer

   129

        for box_name, box_label in [

   130

                ("SlaveInfosDetailsBox", "Slave Informations"),

   131

                ("SyncManagerBox", "Sync Manager"),

   132

                ("SlaveStateBox", "Slave State Transition && Monitoring")]:

   133

            self.StaticBoxDic[box_name] = wx.StaticBox(self, label=_(box_label))

   134

            self.SizerDic[box_name] = wx.StaticBoxSizer(self.StaticBoxDic[box_name])

   135

   136

        for statictext_name, statictext_label, textctrl_name in [

   137

                ("VendorLabel", "Vendor:", "vendor"),

   138

                ("ProductcodeLabel", "Product code:", "product_code"),

   139

                ("RevisionnumberLabel", "Slave Count:", "revision_number"),

   140

                ("PhysicsLabel", "Physics:", "physics")]:

   141

            self.StaticTextDic[statictext_name] = wx.StaticText(self, label=_(statictext_label))

   142

            self.TextCtrlDic[textctrl_name] = wx.TextCtrl(self, size=wx.Size(130, 24), style=wx.TE_READONLY)

   143

            self.SizerDic["SlaveInfosDetailsInnerSizer"].AddMany([self.StaticTextDic[statictext_name],

   144

                                                                  self.TextCtrlDic[textctrl_name]])

   145

   146

        self.SizerDic["SlaveInfosDetailsBox"].AddSizer(self.SizerDic["SlaveInfosDetailsInnerSizer"])

   147

   148

        self.SyncManagersGrid = CustomGrid(self, size=wx.Size(605, 155), style=wx.VSCROLL)

   149

   150

        self.SizerDic["SyncManagerInnerSizer"].Add(self.SyncManagersGrid)

   151

        self.SizerDic["SyncManagerBox"].Add(self.SizerDic["SyncManagerInnerSizer"])

   152

   153

        buttons = [

   154

            ("InitButton",   0, "INIT", "State Transition to \"Init\" State",     self.OnButtonClick, []),

   155

            ("PreOPButton",  1, "PREOP", "State Transition to \"PreOP\" State",   self.OnButtonClick, [

   156

                ("TargetStateLabel", "Target State:", "TargetState")]),

   157

            ("SafeOPButton", 2, "SAFEOP", "State Transition to \"SafeOP\" State", self.OnButtonClick, []),

   158

            ("OPButton",     3, "OP",  "State Transition to \"OP\" State",        self.OnButtonClick, [

   159

                ("CurrentStateLabel", "Current State:", "CurrentState")])

   160

        ]

   161

        for button_name, button_id, button_label, button_tooltipstring, event_method, sub_item in buttons:

   162

            self.ButtonDic[button_name] = wx.Button(self, id=button_id, label=_(button_label))

   163

            self.ButtonDic[button_name].Bind(wx.EVT_BUTTON, event_method)

   164

            self.ButtonDic[button_name].SetToolTipString(button_tooltipstring)

   165

            self.SizerDic["SlaveState_up_sizer"].Add(self.ButtonDic[button_name])

   166

            for statictext_name, statictext_label, textctrl_name in sub_item:

   167

                self.StaticTextDic[statictext_name] = wx.StaticText(self, label=_(statictext_label))

   168

                self.TextCtrlDic[textctrl_name] = wx.TextCtrl(self, size=wx.DefaultSize, style=wx.TE_READONLY)

   169

                self.SizerDic["SlaveState_up_sizer"].AddMany([self.StaticTextDic[statictext_name],

   170

                                                              self.TextCtrlDic[textctrl_name]])

   171

   172

        for button_name, button_label, button_tooltipstring, event_method in [

   173

                ("StartTimerButton", "Start State Monitoring", "Slave State Update Restart", self.StartTimer),

   174

                ("StopTimerButton", "Stop State Monitoring", "Slave State Update Stop", self.CurrentStateThreadStop)]:

   175

            self.ButtonDic[button_name] = wx.Button(self, label=_(button_label))

   176

            self.ButtonDic[button_name].Bind(wx.EVT_BUTTON, event_method)

   177

            self.ButtonDic[button_name].SetToolTipString(button_tooltipstring)

   178

            self.SizerDic["SlaveState_down_sizer"].Add(self.ButtonDic[button_name])

   179

   180

        self.SizerDic["SlaveState_sizer"].AddMany([self.SizerDic["SlaveState_up_sizer"],

   181

                                                   self.SizerDic["SlaveState_down_sizer"]])

   182

   183

        self.SizerDic["SlaveStateBox"].Add(self.SizerDic["SlaveState_sizer"])

   184

   185

        self.SizerDic["SlaveState_inner_main_sizer"].AddMany([

   186

            self.SizerDic["SlaveInfosDetailsBox"], self.SizerDic["SyncManagerBox"],

   187

            self.SizerDic["SlaveStateBox"]])

   188

   189

        self.SizerDic["SlaveState_main_sizer"].Add(self.SizerDic["SlaveState_inner_main_sizer"])

   190

   191

        self.SetSizer(self.SizerDic["SlaveState_main_sizer"])

   192

   193

        # register a timer for periodic exectuion of slave state update (period: 1000 ms)

   194

        self.Bind(wx.EVT_TIMER, self.GetCurrentState)

   195

   196

        self.CreateSyncManagerTable()

   197

   198

        self.Centre()

   199

   200

    def CreateSyncManagerTable(self):

   201

        """

   202

        Create grid for "SyncManager"

   203

        """

   204

        # declare Table object

   205

        self.SyncManagersTable = SyncManagersTable(self, [], GetSyncManagersTableColnames())

   206

        self.SyncManagersGrid.SetTable(self.SyncManagersTable)

   207

        # set grid alignment attr. (CENTER)

   208

        self.SyncManagersGridColAlignements = [wx.ALIGN_CENTRE, wx.ALIGN_CENTRE, wx.ALIGN_CENTRE,

   209

                                               wx.ALIGN_CENTRE, wx.ALIGN_CENTRE, wx.ALIGN_CENTRE]

   210

        # set grid size

   211

        self.SyncManagersGridColSizes = [40, 150, 100, 100, 100, 100]

   212

        self.SyncManagersGrid.SetRowLabelSize(0)

   213

        for col in range(self.SyncManagersTable.GetNumberCols()):

   214

            attr = wx.grid.GridCellAttr()

   215

            attr.SetAlignment(self.SyncManagersGridColAlignements[col], wx.ALIGN_CENTRE)

   216

            self.SyncManagersGrid.SetColAttr(col, attr)

   217

            self.SyncManagersGrid.SetColMinimalWidth(col, self.SyncManagersGridColSizes[col])

   218

            self.SyncManagersGrid.AutoSizeColumn(col, False)

   219

   220

        self.RefreshSlaveInfos()

   221

   222

    def RefreshSlaveInfos(self):

   223

        """

   224

        Fill data in "Slave Information" and "SyncManager"

   225

        """

   226

        slave_infos = self.Controler.GetSlaveInfos()

   227

        sync_manager_section = ["vendor", "product_code", "revision_number", "physics"]

   228

        if slave_infos is not None:

   229

            # this method is same as "TextCtrl.SetValue"

   230

            for textctrl_name in sync_manager_section:

   231

                self.TextCtrlDic[textctrl_name].SetValue(slave_infos[textctrl_name])

   232

            self.SyncManagersTable.SetData(slave_infos["sync_managers"])

   233

            self.SyncManagersTable.ResetView(self.SyncManagersGrid)

   234

        else:

   235

            for textctrl_name in sync_manager_section:

   236

                self.TextCtrlDic[textctrl_name].SetValue("")

   237

            self.SyncManagersTable.SetData([])

   238

            self.SyncManagersTable.ResetView(self.SyncManagersGrid)

   239

   240

    def OnButtonClick(self, event):

   241

        """

   242

        Event handler for slave state transition button click (Init, PreOP, SafeOP, OP button)

   243

        @param event : wx.EVT_BUTTON object

   244

        """

   245

        check_connect_flag = self.Controler.CommonMethod.CheckConnect(False)

   246

        if check_connect_flag:

   247

            state_dic = ["INIT", "PREOP", "SAFEOP", "OP"]

   248

   249

            # If target state is one of {INIT, PREOP, SAFEOP}, request slave state transition immediately.

   250

            if event.GetId() < 3:

   251

                self.Controler.CommonMethod.RequestSlaveState(state_dic[event.GetId()])

   252

                self.TextCtrlDic["TargetState"].SetValue(state_dic[event.GetId()])

   253

   254

            # If target state is OP, first check "PLC status".

   255

            #  (1) If current PLC status is "Started", then request slave state transition

   256

            #  (2) Otherwise, show error message and return

   257

            else:

   258

                status, count = self.Controler.GetCTRoot()._connector.GetPLCstatus()

   259

                if status == "Started":

   260

                    self.Controler.CommonMethod.RequestSlaveState("OP")

   261

                    self.TextCtrlDic["TargetState"].SetValue("OP")

   262

                else:

   263

                    self.Controler.CommonMethod.CreateErrorDialog("PLC is Not Started")

   264

   265

    def GetCurrentState(self, event):

   266

        """

   267

        Timer event handler for periodic slave state monitoring (Default period: 1 sec = 1000 msec).

   268

        @param event : wx.TIMER object

   269

        """

   270

        check_connect_flag = self.Controler.CommonMethod.CheckConnect(True)

   271

        if check_connect_flag:

   272

            returnVal = self.Controler.CommonMethod.GetSlaveStateFromSlave()

   273

            line = returnVal.split("\n")

   274

            try:

   275

                self.SetCurrentState(line[self.Controler.GetSlavePos()])

   276

            except Exception:

   277

                pass

   278

   279

    def SetCurrentState(self, line):

   280

        """

   281

        Show current slave state using the executiob result of "ethercat slaves" command.

   282

        @param line : result of "ethercat slaves" command

   283

        """

   284

        state_array = ["INIT", "PREOP", "SAFEOP", "OP"]

   285

        try:

   286

            # parse the execution result of  "ethercat slaves" command

   287

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

   288

            token = line.split("  ")

   289

            if token[2] in state_array:

   290

                self.TextCtrlDic["CurrentState"].SetValue(token[2])

   291

        except Exception:

   292

            pass

   293

   294

    def StartTimer(self, event):

   295

        """

   296

        Event handler for "Start State Monitoring" button.

   297

          - start slave state monitoring thread

   298

        @param event : wx.EVT_BUTTON object

   299

        """

   300

        self.SlaveStateThread = wx.Timer(self)

   301

        # set timer period (1000 ms)

   302

        self.SlaveStateThread.Start(1000)

   303

   304

    def CurrentStateThreadStop(self, event):

   305

        """

   306

        Event handler for "Stop State Monitoring" button.

   307

          - stop slave state monitoring thread

   308

        @param event : wx.EVT_BUTTON object

   309

        """

   310

        try:

   311

            self.SlaveStateThread.Stop()

   312

        except Exception:

   313

            pass

   314

   315

   316

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

   317

#                    For SDO Management Panel

   318

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

   319

class SDOPanelClass(wx.Panel):

   320

    def __init__(self, parent, controler):

   321

        """

   322

        Constructor

   323

        @param parent: Reference to the parent EtherCATManagementTreebook class

   324

        @param controler: _EthercatSlaveCTN class in EthercatSlave.py

   325

        """

   326

        wx.Panel.__init__(self, parent, -1)

   327

   328

        self.DatatypeDescription, self.CommunicationObject, self.ManufacturerSpecific, \

   329

            self.ProfileSpecific, self.Reserved, self.AllSDOData = range(6)

   330

   331

        self.Controler = controler

   332

   333

        self.SDOManagementMainSizer = wx.BoxSizer(wx.VERTICAL)

   334

        self.SDOManagementInnerMainSizer = wx.FlexGridSizer(cols=1, hgap=10, rows=2, vgap=10)

   335

   336

        self.SDOUpdate = wx.Button(self, label=_('update'))

   337

        self.SDOUpdate.Bind(wx.EVT_BUTTON, self.SDOInfoUpdate)

   338

   339

        self.CallSDONoteBook = SDONoteBook(self, controler=self.Controler)

   340

        self.SDOManagementInnerMainSizer.Add(self.SDOUpdate)

   341

        self.SDOManagementInnerMainSizer.Add(self.CallSDONoteBook, wx.ALL | wx.EXPAND)

   342

   343

        self.SDOManagementMainSizer.Add(self.SDOManagementInnerMainSizer)

   344

   345

        self.SetSizer(self.SDOManagementMainSizer)

   346

   347

    def SDOInfoUpdate(self, event):

   348

        """

   349

        Evenet handler for SDO "update" button.

   350

          - Load SDO data from current slave

   351

        @param event : wx.EVT_BUTTON object

   352

        """

   353

        self.Controler.CommonMethod.SaveSDOData = []

   354

        self.Controler.CommonMethod.ClearSDODataSet()

   355

        self.SDOFlag = False

   356

   357

        # Check whether beremiz connected or not.

   358

        check_connect_flag = self.Controler.CommonMethod.CheckConnect(False)

   359

        if check_connect_flag:

   360

            self.SDOs = self.Controler.CommonMethod.GetSlaveSDOFromSlave()

   361

            # SDOFlag is "False", user click "Cancel" button

   362

            self.SDOFlag = self.SDOParser()

   363

   364

            if self.SDOFlag:

   365

                self.CallSDONoteBook.CreateNoteBook()

   366

                self.Refresh()

   367

   368

    def SDOParser(self):

   369

        """

   370

        Parse SDO data set that obtain "SDOInfoUpdate" Method

   371

        @return True or False

   372

        """

   373

   374

        slaveSDO_progress = wx.ProgressDialog("Slave SDO Monitoring", "Now Uploading...",

   375

                                              maximum=len(self.SDOs.splitlines()),

   376

                                              parent=self,

   377

                                              style=wx.PD_CAN_ABORT | wx.PD_APP_MODAL | wx.PD_ELAPSED_TIME |

   378

                                              wx.PD_ESTIMATED_TIME | wx.PD_REMAINING_TIME |

   379

                                              wx.PD_AUTO_HIDE | wx.PD_SMOOTH)

   380

   381

        # If keep_going flag is False, SDOParser method is stop and return "False".

   382

        keep_going = True

   383

        count = 0

   384

   385

        # SDO data example

   386

        # SDO 0x1000, "Device type"

   387

        # 0x1000:00,r-r-r-,uint32,32 bit,"Device type",0x00020192, 131474

   388

        for details_line in self.SDOs.splitlines():

   389

            count += 1

   390

            line_token = details_line.split("\"")

   391

            # len(line_token[2]) case : SDO 0x1000, "Device type"

   392

            if len(line_token[2]) == 0:

   393

                title_name = line_token[1]

   394

            # else case : 0x1000:00,r-r-r-,uint32,32 bit,"Device type",0x00020192, 131474

   395

            else:

   396

                # line_token = ['0x1000:00,r-r-r-,uint32,32 bit,', 'Device type', ',0x00020192, 131474']

   397

                token_head, name, token_tail = line_token

   398

   399

                # token_head = ['0x1000:00', 'r-r-r-', 'uint32', '32 bit', '']

   400

                token_head = token_head.split(",")

   401

                ful_idx, access, type, size, empty = token_head

   402

                # ful_idx.split(":") = ['0x1000', '00']

   403

                idx, sub_idx = ful_idx.split(":")

   404

   405

                # token_tail = ['', '0x00020192', '131474']

   406

                token_tail = token_tail.split(",")

   407

                try:

   408

                    empty, hex_val, dec_val = token_tail

   409

   410

                # SDO data is not return "dec value"

   411

                # line example :

   412

                # 0x1702:01,rwr-r-,uint32,32 bit," 1st mapping", ----

   413

                except Exception:

   414

                    empty, hex_val = token_tail

   415

   416

                name_after_check = self.StringTest(name)

   417

   418

                # convert hex type

   419

                sub_idx = "0x" + sub_idx

   420

   421

                if type == "octet_string":

   422

                    hex_val = ' ---- '

   423

   424

                # SResult of SlaveSDO data parsing. (data type : dictionary)

   425

                self.Data = {'idx': idx.strip(), 'subIdx': sub_idx.strip(), 'access': access.strip(),

   426

                             'type': type.strip(), 'size': size.strip(),  'name': name_after_check.strip("\""),

   427

                             'value': hex_val.strip(), "category": title_name.strip("\"")}

   428

   429

                category_divide_value = [0x1000, 0x2000, 0x6000, 0xa000, 0xffff]

   430

   431

                for count in range(len(category_divide_value)):

   432

                    if int(idx, 0) < category_divide_value[count]:

   433

                        self.Controler.CommonMethod.SaveSDOData[count].append(self.Data)

   434

                        break

   435

   436

                self.Controler.CommonMethod.SaveSDOData[self.AllSDOData].append(self.Data)

   437

   438

            if count >= len(self.SDOs.splitlines()) / 2:

   439

                (keep_going, skip) = slaveSDO_progress.Update(count, "Please waiting a moment!!")

   440

            else:

   441

                (keep_going, skip) = slaveSDO_progress.Update(count)

   442

   443

            # If user click "Cancel" loop suspend immediately

   444

            if not keep_going:

   445

                break

   446

   447

        slaveSDO_progress.Destroy()

   448

        return keep_going

   449

   450

    def StringTest(self, check_string):

   451

        """

   452

        Test value 'name' is alphanumeric

   453

        @param check_string : input data for check

   454

        @return result : output data after check

   455

        """

   456

        # string.printable is print this result

   457

        # '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ

   458

        # !"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c

   459

        allow_range = string.printable

   460

        result = check_string

   461

        for i in range(0, len(check_string)):

   462

            # string.isalnum() is check whether string is alphanumeric or not

   463

            if check_string[len(check_string)-1-i:len(check_string)-i] in allow_range:

   464

                result = check_string[:len(check_string) - i]

   465

                break

   466

        return result

   467

   468

   469

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

   470

#                    For SDO Notebook (divide category)

   471

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

   472

class SDONoteBook(wx.Notebook):

   473

    def __init__(self, parent, controler):

   474

        """

   475

        Constructor

   476

        @param parent: Reference to the parent SDOPanelClass class

   477

        @param controler: _EthercatSlaveCTN class in EthercatSlave.py

   478

        """

   479

        wx.Notebook.__init__(self, parent, id=-1, size=(850, 500))

   480

        self.Controler = controler

   481

        self.parent = parent

   482

   483