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

    27

import sys

    28

import shutil

    29

    30

import util.paths as paths

    31

    32

base_folder = paths.AbsParentDir(__file__, 2)

    33

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

    34

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

    35

    36

import wx

    37

    38

from nodelist import NodeList

    39

from nodemanager import NodeManager

    40

import config_utils

    41

import gen_cfile

    42

import eds_utils

    43

import canfestival_config as local_canfestival_config

    44

from ConfigTreeNode import ConfigTreeNode

    45

from commondialogs import CreateNodeDialog

    46

from subindextable import IECTypeConversion, SizeConversion

    47

    48

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

    49

from SlaveEditor import SlaveEditor, MasterViewer

    50

from NetworkEditor import NetworkEditor

    51

    52

from gnosis.xml.pickle import *

    53

from gnosis.xml.pickle.util import setParanoia

    54

setParanoia(0)

    55

    56

from util.TranslationCatalogs import AddCatalog

    57

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

    58

    59

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

    60

#              Location Tree Helper

    61

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

    62

    63

    64

def GetSlaveLocationTree(slave_node, current_location, name):

    65

    entries = []

    66

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

    67

        subentry_infos = slave_node.GetSubentryInfos(index, subindex)

    68

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

    69

        if typeinfos:

    70

            entries.append({

    71

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

    72

                "type": LOCATION_VAR_MEMORY,

    73

                "size": size,

    74

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

    75

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

    76

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

    77

                                                                                (index, subindex)))),

    78

                "description": "",

    79

                "children": []})

    80

    return {"name": name,

    81

            "type": LOCATION_CONFNODE,

    82

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

    83

            "children": entries

    84

    }

    85

    86

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

    87

#                    SLAVE

    88

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

    89

    90

    91

class _SlaveCTN(NodeManager):

    92

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

    93

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

    94

      <xsd:element name="CanFestivalSlaveNode">

    95

        <xsd:complexType>

    96

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

    97

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

    98

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

    99

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

   100

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

   101

            <xsd:simpleType>

   102

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

   103

                    <xsd:minInclusive value="1"/>

   104

                    <xsd:maxInclusive value="99"/>

   105

                </xsd:restriction>

   106

            </xsd:simpleType>

   107

          </xsd:attribute>

   108

        </xsd:complexType>

   109

      </xsd:element>

   110

    </xsd:schema>

   111

    """

   112

   113

    EditorType = SlaveEditor

   114

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

   115

   116

    def __init__(self):

   117

        # TODO change netname when name change

   118

        NodeManager.__init__(self)

   119

        odfilepath = self.GetSlaveODPath()

   120

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

   121

            self.OpenFileInCurrent(odfilepath)

   122

        else:

   123

            self.FilePath = ""

   124

            dialog = CreateNodeDialog(None, wx.OK)

   125

            dialog.Type.Enable(False)

   126

            dialog.GenSYNC.Enable(False)

   127

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

   128

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

   129

                profile, filepath = dialog.GetProfile()

   130

                NMT = dialog.GetNMTManagement()

   131

                options = dialog.GetOptions()

   132

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

   133

                                   id,           # NodeID - will be changed at build time

   134

                                   "slave",      # Type

   135

                                   description,  # description

   136

                                   profile,      # profile

   137

                                   filepath,     # prfile filepath

   138

                                   NMT,          # NMT

   139

                                   options)      # options

   140

            else:

   141

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

   142

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

   143

                                   "slave",      # Type

   144

                                   "",           # description

   145

                                   "None",       # profile

   146

                                   "",           # prfile filepath

   147

                                   "heartbeat",  # NMT

   148

                                   [])           # options

   149

            dialog.Destroy()

   150

            self.OnCTNSave()

   151

   152

    def GetCurrentNodeName(self):

   153

        return self.CTNName()

   154

   155

    def GetSlaveODPath(self):

   156

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

   157

   158

    def GetCanDevice(self):

   159

        return self.CanFestivalSlaveNode.getCAN_Device()

   160

   161

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

   162

        ConfigTreeNode._OpenView(self, name, onlyopened)

   163

        if self._View is not None:

   164

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

   165

        return self._View

   166

   167

    def _ExportSlave(self):

   168

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

   169

                               _("Choose a file"),

   170

                               os.path.expanduser("~"),

   171

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

   172

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

   174

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

   175

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

   176

            if result:

   177

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

   178

        dialog.Destroy()

   179

   180

    ConfNodeMethods = [

   181

        {

   182

            "bitmap":    "ExportSlave",

   183

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

   184

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

   185

            "method":   "_ExportSlave"

   186

        },

   187

    ]

   188

   189

    def CTNTestModified(self):

   190

        return self.ChangesToSave or self.OneFileHasChanged()

   191

   192

    def OnCTNSave(self, from_project_path=None):

   193

        return self.SaveCurrentInFile(self.GetSlaveODPath())

   194

   195

    def SetParamsAttribute(self, path, value):

   196

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

   197

   198

        # Filter IEC_Channel and Name, that have specific behavior

   199

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

   200

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

   201

   202

        return result

   203

   204

    def GetVariableLocationTree(self):

   205

        current_location = self.GetCurrentLocation()

   206

        return GetSlaveLocationTree(self.CurrentNode,

   207

                                    self.GetCurrentLocation(),

   208

                                    self.BaseParams.getName())

   209

   210

    def CTNGenerate_C(self, buildpath, locations):

   211

        """

   212

        Generate C code

   213

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

   214

        @param locations: List of complete variables locations \

   215

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

   216

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

   217

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

   218

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

   219

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

   220

            }, ...]

   221

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

   222

        """

   223

        current_location = self.GetCurrentLocation()

   224

        # define a unique name for the generated C file

   225

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

   226

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

   227

        # Create a new copy of the model

   228

        slave = self.GetCurrentNodeCopy()

   229

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

   230

        # allow access to local OD from Slave PLC

   231

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

   232

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

   233

        if res:

   234

            raise Exception, res

   235

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

   236

        if res:

   237

            raise Exception, res

   238

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

   239

   240

    def LoadPrevious(self):

   241

        self.LoadCurrentPrevious()

   242

   243

    def LoadNext(self):

   244

        self.LoadCurrentNext()

   245

   246

    def GetBufferState(self):

   247

        return self.GetCurrentBufferState()

   248

   249

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

   250

#                    MASTER

   251

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

   252

   253

   254

class MiniNodeManager(NodeManager):

   255

   256

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

   257

        NodeManager.__init__(self)

   258

   259

        self.OpenFileInCurrent(filepath)

   260

   261

        self.Parent = parent

   262

        self.Fullname = fullname

   263

   264

    def GetIconName(self):

   265

        return None

   266

   267

    def OnCloseEditor(self, view):

   268

        self.Parent.OnCloseEditor(view)

   269

   270

    def CTNFullName(self):

   271

        return self.Fullname

   272

   273

    def CTNTestModified(self):

   274

        return False

   275

   276

    def GetBufferState(self):

   277

        return self.GetCurrentBufferState()

   278

   279

    ConfNodeMethods = []

   280

   281

   282

class _NodeManager(NodeManager):

   283

   284

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

   285

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

   286

        self.Parent = parent

   287

   288

    def __del__(self):

   289

        self.Parent = None

   290

   291

    def GetCurrentNodeName(self):

   292

        return self.Parent.CTNName()

   293

   294

    def GetCurrentNodeID(self):

   295

        return self.Parent.CanFestivalNode.getNodeId()

   296

   297

   298

class _NodeListCTN(NodeList):

   299

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

   300

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

   301

      <xsd:element name="CanFestivalNode">

   302

        <xsd:complexType>

   303

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

   304

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

   305

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

   306

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

   307

        </xsd:complexType>

   308

      </xsd:element>

   309

    </xsd:schema>

   310

    """

   311

   312

    EditorType = NetworkEditor

   313

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

   314

   315

    def __init__(self):

   316

        manager = _NodeManager(self)

   317

        NodeList.__init__(self, manager)

   318

        self.LoadProject(self.CTNPath())

   319

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

   320

   321

    def GetCanDevice(self):

   322

        return self.CanFestivalNode.getCAN_Device()

   323

   324

    def SetParamsAttribute(self, path, value):

   325

        if path == "CanFestivalNode.NodeId":

   326

            nodeid = self.CanFestivalNode.getNodeId()

   327

            if value != nodeid:

   328

                slaves = self.GetSlaveIDs()

   329

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

   330

                while value in slaves and value >= 0:

   331

                    value += dir

   332

                if value < 0:

   333

                    value = nodeid

   334

   335

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

   336

        refresh_network = False

   337

   338

        # Filter IEC_Channel and Name, that have specific behavior

   339

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

   340

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

   341

        elif path == "BaseParams.Name":

   342

            self.SetNetworkName(value)

   343

            refresh_network = True

   344

        elif path == "CanFestivalNode.NodeId":

   345

            refresh_network = True

   346

   347

        if refresh_network and self._View is not None:

   348

            wx.CallAfter(self._View.RefreshBufferState)

   349

        return value, refresh

   350

   351

    def GetVariableLocationTree(self):

   352

        current_location = self.GetCurrentLocation()

   353

        nodeindexes = self.SlaveNodes.keys()

   354

        nodeindexes.sort()

   355

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

   356

                 "type": LOCATION_CONFNODE,

   357

                 "location": self.GetFullIEC_Channel(),

   358

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

   359

                                                   current_location,

   360

                                                   _("Local entries"))] +

   361

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

   362

                                                   current_location + (nodeid,),

   363

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

   364

                              for nodeid in nodeindexes]

   365

        }

   366

   367

    _GeneratedMasterView = None

   368

    def _ShowGeneratedMaster(self):

   369

        self._OpenView("Generated master")

   370

   371

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

   372

        if name == "Generated master":

   373

            app_frame = self.GetCTRoot().AppFrame

   374

            if self._GeneratedMasterView is None:

   375

                buildpath = self._getBuildPath()

   376

                # Eventually create build dir

   377

                if not os.path.exists(buildpath):

   378

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

   379

                    return

   380

   381

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

   382

                if not os.path.exists(masterpath):

   383

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

   384

                    return

   385

   386

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

   387

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

   388

   389

            if self._GeneratedMasterView is not None:

   390

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

   391

   392

            return self._GeneratedMasterView

   393

        else:

   394

            ConfigTreeNode._OpenView(self, name, onlyopened)

   395

            if self._View is not None:

   396

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

   397

            return self._View

   398

   399

    ConfNodeMethods = [

   400

        {

   401

            "bitmap":    "ShowMaster",

   402

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

   403

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

   404

            "method":   "_ShowGeneratedMaster"

   405

        }

   406

    ]

   407

   408

    def OnCloseEditor(self, view):

   409

        ConfigTreeNode.OnCloseEditor(self, view)

   410

        if self._GeneratedMasterView == view:

   411

            self._GeneratedMasterView = None

   412

   413

    def OnCTNClose(self):

   414

        ConfigTreeNode.OnCTNClose(self)

   415

        self._CloseView(self._GeneratedMasterView)

   416

        return True

   417

   418

    def CTNTestModified(self):

   419

        return self.ChangesToSave or self.HasChanged()

   420

   421

    def OnCTNSave(self, from_project_path=None):

   422

        self.SetRoot(self.CTNPath())

   423

        if from_project_path is not None:

   424

            shutil.copytree(self.GetEDSFolder(from_project_path),

   425

                            self.GetEDSFolder())

   426

        return self.SaveProject() is None

   427

   428

    def CTNGenerate_C(self, buildpath, locations):

   429

        """

   430

        Generate C code

   431

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

   432

        @param locations: List of complete variables locations \

   433

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

   434

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

   435

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

   436

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

   437

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

   438

            }, ...]

   439

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

   440

        """

   441

        self._CloseView(self._GeneratedMasterView)

   442

        current_location = self.GetCurrentLocation()

   443

        # define a unique name for the generated C file

   444

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

   445

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

   446

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

   447

        try:

   448

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

   449

        except config_utils.PDOmappingException, e:

   450

            raise Exception, e.message

   451

        # Do generate C file.

   452

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

   453

        if res:

   454

            raise Exception, res

   455

   456

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

   457

        dump(master, file)

   458

        file.close()

   459

   460

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

   461

   462

    def LoadPrevious(self):

   463

        self.Manager.LoadCurrentPrevious()

   464

   465

    def LoadNext(self):

   466

        self.Manager.LoadCurrentNext()

   467

   468

    def GetBufferState(self):

   469

        return self.Manager.GetCurrentBufferState()

   470

   471

   472

class RootClass:

   473

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

   474

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

   475

      <xsd:element name="CanFestivalInstance">

   476

        <xsd:complexType>

   477

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

   478

        </xsd:complexType>

   479

      </xsd:element>

   480

    </xsd:schema>

   481

    """