1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

# Copyright (C) 2017: Andrey Skvortsov

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

# This program is free software; you can redistribute it and/or

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

# of the License, or (at your option) any later version.

    16

#

    17

# This program is distributed in the hope that it will be useful,

    18

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

# You should have received a copy of the GNU General Public License

    23

# along with this program; if not, write to the Free Software

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

import os, sys, shutil

    27

import util.paths as paths

    28

    29

base_folder = paths.AbsParentDir(__file__, 2)

    30

CanFestivalPath = os.path.join(base_folder, "CanFestival-3")

    31

sys.path.append(os.path.join(CanFestivalPath, "objdictgen"))

    32

    33

import wx

    34

    35

from nodelist import NodeList

    36

from nodemanager import NodeManager

    37

import config_utils, gen_cfile, eds_utils

    38

import canfestival_config as local_canfestival_config

    39

from ConfigTreeNode import ConfigTreeNode

    40

from commondialogs import CreateNodeDialog

    41

from subindextable import IECTypeConversion, SizeConversion

    42

    43

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

    44

from SlaveEditor import SlaveEditor, MasterViewer

    45

from NetworkEditor import NetworkEditor

    46

    47

from gnosis.xml.pickle import *

    48

from gnosis.xml.pickle.util import setParanoia

    49

setParanoia(0)

    50

    51

from util.TranslationCatalogs import AddCatalog

    52

AddCatalog(os.path.join(CanFestivalPath, "objdictgen", "locale"))

    53

    54

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

    55

#              Location Tree Helper

    56

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

    57

    58

def GetSlaveLocationTree(slave_node, current_location, name):

    59

    entries = []

    60

    for index, subindex, size, entry_name in slave_node.GetMapVariableList():

    61

        subentry_infos = slave_node.GetSubentryInfos(index, subindex)

    62

        typeinfos = slave_node.GetEntryInfos(subentry_infos["type"])

    63

        if typeinfos:

    64

            entries.append({

    65

                "name": "0x%4.4x-0x%2.2x: %s" % (index, subindex, entry_name),

    66

                "type": LOCATION_VAR_MEMORY,

    67

                "size": size,

    68

                "IEC_type": IECTypeConversion.get(typeinfos["name"]),

    69

                "var_name": "%s_%4.4x_%2.2x" % ("_".join(name.split()), index, subindex),

    70

                "location": "%s%s"%(SizeConversion[size], ".".join(map(str, current_location + 

    71

                                                                                (index, subindex)))),

    72

                "description": "",

    73

                "children": []})

    74

    return  {"name": name,

    75

             "type": LOCATION_CONFNODE,

    76

             "location": ".".join([str(i) for i in current_location]) + ".x",

    77

             "children": entries

    78

    }

    79

    80

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

    81

#                    SLAVE

    82

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

    83

    84

class _SlaveCTN(NodeManager):

    85

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

    86

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    87

      <xsd:element name="CanFestivalSlaveNode">

    88

        <xsd:complexType>

    89

          <xsd:attribute name="CAN_Device" type="xsd:string" use="optional"/>

    90

          <xsd:attribute name="CAN_Baudrate" type="xsd:string" use="optional"/>

    91

          <xsd:attribute name="NodeId" type="xsd:integer" use="optional" default="2"/>

    92

          <xsd:attribute name="Sync_Align" type="xsd:integer" use="optional" default="0"/>

    93

          <xsd:attribute name="Sync_Align_Ratio" use="optional" default="50">

    94

            <xsd:simpleType>

    95

                <xsd:restriction base="xsd:integer">

    96

                    <xsd:minInclusive value="1"/>

    97

                    <xsd:maxInclusive value="99"/>

    98

                </xsd:restriction>

    99

            </xsd:simpleType>

   100

          </xsd:attribute>

   101

        </xsd:complexType>

   102

      </xsd:element>

   103

    </xsd:schema>

   104

    """

   105

   106

    EditorType = SlaveEditor

   107

    IconPath = os.path.join(CanFestivalPath, "objdictgen", "networkedit.png")

   108

   109

    def __init__(self):

   110

        # TODO change netname when name change

   111

        NodeManager.__init__(self)

   112

        odfilepath = self.GetSlaveODPath()

   113

        if(os.path.isfile(odfilepath)):

   114

            self.OpenFileInCurrent(odfilepath)

   115

        else:

   116

            self.FilePath = ""

   117

            dialog = CreateNodeDialog(None, wx.OK)

   118

            dialog.Type.Enable(False)

   119

            dialog.GenSYNC.Enable(False)

   120

            if dialog.ShowModal() == wx.ID_OK:

   121

                name, id, nodetype, description = dialog.GetValues()

   122

                profile, filepath = dialog.GetProfile()

   123

                NMT = dialog.GetNMTManagement()

   124

                options = dialog.GetOptions()

   125

                self.CreateNewNode(name,       # Name - will be changed at build time

   126

                                   id,         # NodeID - will be changed at build time

   127

                                   "slave",    # Type

   128

                                   description,# description 

   129

                                   profile,    # profile

   130

                                   filepath,   # prfile filepath

   131

                                   NMT,        # NMT

   132

                                   options)     # options

   133

            else:

   134

                self.CreateNewNode("SlaveNode",  # Name - will be changed at build time

   135

                                   0x00,         # NodeID - will be changed at build time

   136

                                   "slave",      # Type

   137

                                   "",           # description 

   138

                                   "None",       # profile

   139

                                   "", # prfile filepath

   140

                                   "heartbeat",  # NMT

   141

                                   [])           # options

   142

            dialog.Destroy()

   143

            self.OnCTNSave()

   144

   145

    def GetCurrentNodeName(self):

   146

        return self.CTNName()

   147

   148

    def GetSlaveODPath(self):

   149

        return os.path.join(self.CTNPath(), 'slave.od')

   150

   151

    def GetCanDevice(self):

   152

        return self.CanFestivalSlaveNode.getCAN_Device()

   153

   154

    def _OpenView(self, name=None, onlyopened=False):

   155

        ConfigTreeNode._OpenView(self, name, onlyopened)

   156

        if self._View is not None:

   157

            self._View.SetBusId(self.GetCurrentLocation())

   158

        return self._View

   159

   160

    def _ExportSlave(self):

   161

        dialog = wx.FileDialog(self.GetCTRoot().AppFrame, 

   162

                               _("Choose a file"), 

   163

                               os.path.expanduser("~"), 

   164

                               "%s.eds" % self.CTNName(),  

   165

                               _("EDS files (*.eds)|*.eds|All files|*.*"),

   166

                               wx.SAVE|wx.OVERWRITE_PROMPT)

   167

        if dialog.ShowModal() == wx.ID_OK:

   168

            result = eds_utils.GenerateEDSFile(dialog.GetPath(), self.GetCurrentNodeCopy())

   169

            if result:

   170

                self.GetCTRoot().logger.write_error(_("Error: Export slave failed\n"))

   171

        dialog.Destroy()  

   172

   173

    ConfNodeMethods = [

   174

        {"bitmap" : "ExportSlave",

   175

         "name" : _("Export slave"), 

   176

         "tooltip" : _("Export CanOpen slave to EDS file"),

   177

         "method" : "_ExportSlave"},

   178

    ]

   179

   180

    def CTNTestModified(self):

   181

        return self.ChangesToSave or self.OneFileHasChanged()

   182

   183

    def OnCTNSave(self, from_project_path=None):

   184

        return self.SaveCurrentInFile(self.GetSlaveODPath())

   185

   186

    def SetParamsAttribute(self, path, value):

   187

        result = ConfigTreeNode.SetParamsAttribute(self, path, value)

   188

   189

        # Filter IEC_Channel and Name, that have specific behavior

   190

        if path == "BaseParams.IEC_Channel" and self._View is not None:

   191

            self._View.SetBusId(self.GetCurrentLocation())

   192

   193

        return result

   194

   195

    def GetVariableLocationTree(self):

   196

        current_location = self.GetCurrentLocation()

   197

        return GetSlaveLocationTree(self.CurrentNode, 

   198

                                    self.GetCurrentLocation(), 

   199

                                    self.BaseParams.getName())

   200

   201

    def CTNGenerate_C(self, buildpath, locations):

   202

        """

   203

        Generate C code

   204

        @param current_location: Tupple containing confnode IEC location : %I0.0.4.5 => (0,0,4,5)

   205

        @param locations: List of complete variables locations \

   206

            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)

   207

            "NAME" : name of the variable (generally "__IW0_1_2" style)

   208

            "DIR" : direction "Q","I" or "M"

   209

            "SIZE" : size "X", "B", "W", "D", "L"

   210

            "LOC" : tuple of interger for IEC location (0,1,2,...)

   211

            }, ...]

   212

        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND

   213

        """

   214

        current_location = self.GetCurrentLocation()

   215

        # define a unique name for the generated C file

   216

        prefix = "_".join(map(str, current_location))

   217

        Gen_OD_path = os.path.join(buildpath, "OD_%s.c"%prefix )

   218

        # Create a new copy of the model

   219

        slave = self.GetCurrentNodeCopy()

   220

        slave.SetNodeName("OD_%s"%prefix)

   221

        # allow access to local OD from Slave PLC

   222

        pointers = config_utils.LocalODPointers(locations, current_location, slave)

   223

        res = gen_cfile.GenerateFile(Gen_OD_path, slave, pointers)

   224

        if res :

   225

            raise Exception, res

   226

        res = eds_utils.GenerateEDSFile(os.path.join(buildpath, "Slave_%s.eds"%prefix), slave)

   227

        if res :

   228

            raise Exception, res

   229

        return [(Gen_OD_path,local_canfestival_config.getCFLAGS(CanFestivalPath))],"",False

   230

   231

    def LoadPrevious(self):

   232

        self.LoadCurrentPrevious()

   233

   234

    def LoadNext(self):

   235

        self.LoadCurrentNext()

   236

   237

    def GetBufferState(self):

   238

        return self.GetCurrentBufferState()

   239

   240

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

   241

#                    MASTER

   242

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

   243

   244

class MiniNodeManager(NodeManager):

   245

   246

    def __init__(self, parent, filepath, fullname):

   247

        NodeManager.__init__(self)

   248

   249

        self.OpenFileInCurrent(filepath)

   250

   251

        self.Parent = parent

   252

        self.Fullname = fullname

   253

   254

    def GetIconName(self):

   255

        return None

   256

   257

    def OnCloseEditor(self, view):

   258

        self.Parent.OnCloseEditor(view)

   259

   260

    def CTNFullName(self):

   261

        return self.Fullname

   262

   263

    def CTNTestModified(self):

   264

        return False

   265

   266

    def GetBufferState(self):

   267

        return self.GetCurrentBufferState()

   268

   269

    ConfNodeMethods = []

   270

   271

class _NodeManager(NodeManager):

   272

   273

    def __init__(self, parent, *args, **kwargs):

   274

        NodeManager.__init__(self, *args, **kwargs)

   275

        self.Parent = parent

   276

   277

    def __del__(self):

   278

        self.Parent = None

   279

   280

    def GetCurrentNodeName(self):

   281

        return self.Parent.CTNName()

   282

   283

    def GetCurrentNodeID(self):

   284

        return self.Parent.CanFestivalNode.getNodeId()

   285

   286

class _NodeListCTN(NodeList):

   287

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

   288

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   289

      <xsd:element name="CanFestivalNode">

   290

        <xsd:complexType>

   291

          <xsd:attribute name="CAN_Device" type="xsd:string" use="optional"/>

   292

          <xsd:attribute name="CAN_Baudrate" type="xsd:string" use="optional"/>

   293

          <xsd:attribute name="NodeId" type="xsd:integer" use="optional" default="1"/>

   294

          <xsd:attribute name="Sync_TPDOs" type="xsd:boolean" use="optional" default="true"/>

   295

        </xsd:complexType>

   296

      </xsd:element>

   297

    </xsd:schema>

   298

    """ 

   299

   300

    EditorType = NetworkEditor

   301

    IconPath = os.path.join(CanFestivalPath, "objdictgen", "networkedit.png")

   302

   303

    def __init__(self):

   304

        manager = _NodeManager(self)

   305

        NodeList.__init__(self, manager)

   306

        self.LoadProject(self.CTNPath())

   307

        self.SetNetworkName(self.BaseParams.getName())

   308

   309

    def GetCanDevice(self):

   310

        return self.CanFestivalNode.getCAN_Device()

   311

   312

    def SetParamsAttribute(self, path, value):

   313

        if path == "CanFestivalNode.NodeId":

   314

            nodeid = self.CanFestivalNode.getNodeId()

   315

            if value != nodeid:

   316

                slaves = self.GetSlaveIDs()

   317

                dir = (value - nodeid) / abs(value - nodeid)

   318

                while value in slaves and value >= 0:

   319

                    value += dir

   320

                if value < 0:

   321

                    value = nodeid

   322

   323

        value, refresh = ConfigTreeNode.SetParamsAttribute(self, path, value)

   324

        refresh_network = False

   325

   326

        # Filter IEC_Channel and Name, that have specific behavior

   327

        if path == "BaseParams.IEC_Channel" and self._View is not None:

   328

            self._View.SetBusId(self.GetCurrentLocation())

   329

        elif path == "BaseParams.Name":

   330

            self.SetNetworkName(value)

   331

            refresh_network = True

   332

        elif path == "CanFestivalNode.NodeId":

   333

            refresh_network = True

   334

   335

        if refresh_network and self._View is not None:

   336

            wx.CallAfter(self._View.RefreshBufferState)

   337

        return value, refresh

   338

   339

    def GetVariableLocationTree(self):

   340

        current_location = self.GetCurrentLocation()

   341

        nodeindexes = self.SlaveNodes.keys()

   342

        nodeindexes.sort()

   343

        return {"name": self.BaseParams.getName(),

   344

                 "type": LOCATION_CONFNODE,

   345

                 "location": self.GetFullIEC_Channel(),

   346

                 "children": [GetSlaveLocationTree(self.Manager.GetCurrentNodeCopy(),

   347

                                                   current_location,

   348

                                                   _("Local entries"))] + 

   349

                             [GetSlaveLocationTree(self.SlaveNodes[nodeid]["Node"], 

   350

                                                   current_location + (nodeid,), 

   351

                                                   self.SlaveNodes[nodeid]["Name"])

   352

                              for nodeid in nodeindexes]

   353

        }

   354

   355

    _GeneratedMasterView = None

   356

    def _ShowGeneratedMaster(self):

   357

        self._OpenView("Generated master")

   358

   359

    def _OpenView(self, name=None, onlyopened=False):

   360

        if name == "Generated master":

   361

            app_frame = self.GetCTRoot().AppFrame

   362

            if self._GeneratedMasterView is None:

   363

                buildpath = self._getBuildPath()

   364

                # Eventually create build dir

   365

                if not os.path.exists(buildpath):

   366

                    self.GetCTRoot().logger.write_error(_("Error: No PLC built\n"))

   367

                    return

   368

   369

                masterpath = os.path.join(buildpath, "MasterGenerated.od")

   370

                if not os.path.exists(masterpath):

   371

                    self.GetCTRoot().logger.write_error(_("Error: No Master generated\n"))

   372

                    return

   373

   374

                manager = MiniNodeManager(self, masterpath, self.CTNFullName())

   375

                self._GeneratedMasterView = MasterViewer(app_frame.TabsOpened, manager, app_frame, name)

   376

   377

            if self._GeneratedMasterView is not None:

   378

                app_frame.EditProjectElement(self._GeneratedMasterView, self._GeneratedMasterView.GetInstancePath())

   379

   380

            return self._GeneratedMasterView

   381

        else:

   382

            ConfigTreeNode._OpenView(self, name, onlyopened)

   383

            if self._View is not None:

   384

                self._View.SetBusId(self.GetCurrentLocation())

   385

            return self._View

   386

   387

    ConfNodeMethods = [

   388

        {"bitmap" : "ShowMaster",

   389

         "name" : _("Show Master"), 

   390

         "tooltip" : _("Show Master generated by config_utils"),

   391

         "method" : "_ShowGeneratedMaster"}

   392

    ]

   393

   394

    def OnCloseEditor(self, view):

   395

        ConfigTreeNode.OnCloseEditor(self, view)

   396

        if self._GeneratedMasterView == view:

   397

            self._GeneratedMasterView = None

   398

   399

    def OnCTNClose(self):

   400

        ConfigTreeNode.OnCTNClose(self)

   401

        self._CloseView(self._GeneratedMasterView)

   402

        return True

   403

   404

    def CTNTestModified(self):

   405

        return self.ChangesToSave or self.HasChanged()

   406

   407

    def OnCTNSave(self, from_project_path=None):

   408

        self.SetRoot(self.CTNPath())

   409

        if from_project_path is not None:

   410

            shutil.copytree(self.GetEDSFolder(from_project_path), 

   411

                            self.GetEDSFolder())

   412

        return self.SaveProject() is None

   413

   414

    def CTNGenerate_C(self, buildpath, locations):

   415

        """

   416

        Generate C code

   417

        @param current_location: Tupple containing confnode IEC location : %I0.0.4.5 => (0,0,4,5)

   418

        @param locations: List of complete variables locations \

   419

            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)

   420

            "NAME" : name of the variable (generally "__IW0_1_2" style)

   421

            "DIR" : direction "Q","I" or "M"

   422

            "SIZE" : size "X", "B", "W", "D", "L"

   423

            "LOC" : tuple of interger for IEC location (0,1,2,...)

   424

            }, ...]

   425

        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND

   426

        """

   427

        self._CloseView(self._GeneratedMasterView)

   428

        current_location = self.GetCurrentLocation()

   429

        # define a unique name for the generated C file

   430

        prefix = "_".join(map(str, current_location))

   431

        Gen_OD_path = os.path.join(buildpath, "OD_%s.c"%prefix )

   432

        # Create a new copy of the model with DCF loaded with PDO mappings for desired location

   433

        try:

   434

            master, pointers = config_utils.GenerateConciseDCF(locations, current_location, self, self.CanFestivalNode.getSync_TPDOs(),"OD_%s"%prefix)

   435

        except config_utils.PDOmappingException, e:

   436

            raise Exception, e.message

   437

        # Do generate C file.

   438

        res = gen_cfile.GenerateFile(Gen_OD_path, master, pointers)

   439

        if res :

   440

            raise Exception, res

   441

   442

        file = open(os.path.join(buildpath, "MasterGenerated.od"), "w")

   443

        dump(master, file)

   444

        file.close()

   445

   446

        return [(Gen_OD_path,local_canfestival_config.getCFLAGS(CanFestivalPath))],"",False

   447

   448

    def LoadPrevious(self):

   449

        self.Manager.LoadCurrentPrevious()

   450

   451

    def LoadNext(self):

   452

        self.Manager.LoadCurrentNext()

   453

   454

    def GetBufferState(self):

   455

        return self.Manager.GetCurrentBufferState()

   456

   457

class RootClass:

   458

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

   459

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   460

      <xsd:element name="CanFestivalInstance">

   461

        <xsd:complexType>

   462

          <xsd:attribute name="CAN_Driver" type="xsd:string" use="optional"/>

   463

        </xsd:complexType>

   464

      </xsd:element>

   465

    </xsd:schema>

   466

    """

   467

   468

    CTNChildrenTypes = [("CanOpenNode",_NodeListCTN, "CanOpen Master"),

   469

                       ("CanOpenSlave",_SlaveCTN, "CanOpen Slave")]

   470

    def GetParamsAttributes(self, path = None):

   471

        infos = ConfigTreeNode.GetParamsAttributes(self, path = path)

   472

        for element in infos:

   473

            if element["name"] == "CanFestivalInstance":

   474

                for child in element["children"]:

   475

                    if child["name"] == "CAN_Driver":

   476

                        child["type"] = local_canfestival_config.DLL_LIST

   477

        return infos

   478

   479

    def GetCanDriver(self):

   480

        res = self.CanFestivalInstance.getCAN_Driver()

   481

        if not res :

   482

            return ""

   483

        return res

   484

   485

    def CTNGenerate_C(self, buildpath, locations):