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

from __future__ import absolute_import

    27

import os

    28

import sys

    29

import shutil

    30

import wx

    31

from gnosis.xml.pickle import *  # pylint: disable=import-error

    32

from gnosis.xml.pickle.util import setParanoia  # pylint: disable=import-error

    33

    34

import util.paths as paths

    35

from util.TranslationCatalogs import AddCatalog

    36

from ConfigTreeNode import ConfigTreeNode

    37

from PLCControler import \

    38

    LOCATION_CONFNODE, \

    39

    LOCATION_VAR_MEMORY

    40

    41

try:

    42

    from nodelist import NodeList

    43

except ImportError:

    44

    base_folder = paths.AbsParentDir(__file__, 2)

    45

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

    46

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

    47

    48

    from nodelist import NodeList

    49

    50

from nodemanager import NodeManager

    51

import gen_cfile

    52

import eds_utils

    53

import canfestival_config as local_canfestival_config  # pylint: disable=import-error

    54

    55

from commondialogs import CreateNodeDialog

    56

from subindextable import IECTypeConversion, SizeConversion

    57

from canfestival import config_utils

    58

from canfestival.SlaveEditor import SlaveEditor, MasterViewer

    59

from canfestival.NetworkEditor import NetworkEditor

    60

    61

    62

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

    63

setParanoia(0)

    64

    65

    66

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

    67

#              Location Tree Helper

    68

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

    69

    70

    71

def GetSlaveLocationTree(slave_node, current_location, name):

    72

    entries = []

    73

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

    74

        subentry_infos = slave_node.GetSubentryInfos(index, subindex)

    75

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

    76

        if typeinfos:

    77

            entries.append({

    78

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

    79

                "type": LOCATION_VAR_MEMORY,

    80

                "size": size,

    81

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

    82

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

    83

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

    84

                                                                         (index, subindex)))),

    85

                "description": "",

    86

                "children": []})

    87

    return {"name": name,

    88

            "type": LOCATION_CONFNODE,

    89

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

    90

            "children": entries}

    91

    92

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

    93

#                    SLAVE

    94

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

    95

    96

    97

class _SlaveCTN(NodeManager):

    98

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

    99

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

   100

      <xsd:element name="CanFestivalSlaveNode">

   101

        <xsd:complexType>

   102

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

   103

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

   104

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

   105

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

   106

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

   107

            <xsd:simpleType>

   108

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

   109

                    <xsd:minInclusive value="1"/>

   110

                    <xsd:maxInclusive value="99"/>

   111

                </xsd:restriction>

   112

            </xsd:simpleType>

   113

          </xsd:attribute>

   114

        </xsd:complexType>

   115

      </xsd:element>

   116

    </xsd:schema>

   117

    """

   118

   119

    EditorType = SlaveEditor

   120

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

   121

   122

    def __init__(self):

   123

        # TODO change netname when name change

   124

        NodeManager.__init__(self)

   125

        odfilepath = self.GetSlaveODPath()

   126

        if os.path.isfile(odfilepath):

   127

            self.OpenFileInCurrent(odfilepath)

   128

        else:

   129

            self.FilePath = ""

   130

            dialog = CreateNodeDialog(None, wx.OK)

   131

            dialog.Type.Enable(False)

   132

            dialog.GenSYNC.Enable(False)

   133

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

   134

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

   135

                profile, filepath = dialog.GetProfile()

   136

                NMT = dialog.GetNMTManagement()

   137

                options = dialog.GetOptions()

   138

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

   139

                                   id,           # NodeID - will be changed at build time

   140

                                   "slave",      # Type

   141

                                   description,  # description

   142

                                   profile,      # profile

   143

                                   filepath,     # prfile filepath

   144

                                   NMT,          # NMT

   145

                                   options)      # options

   146

            else:

   147

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

   148

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

   149

                                   "slave",      # Type

   150

                                   "",           # description

   151

                                   "None",       # profile

   152

                                   "",           # prfile filepath

   153

                                   "heartbeat",  # NMT

   154

                                   [])           # options

   155

            dialog.Destroy()

   156

            self.OnCTNSave()

   157

   158

    def GetCurrentNodeName(self):

   159

        return self.CTNName()

   160

   161

    def GetSlaveODPath(self):

   162

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

   163

   164

    def GetCanDevice(self):

   165

        return self.CanFestivalSlaveNode.getCAN_Device()

   166

   167

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

   168

        ConfigTreeNode._OpenView(self, name, onlyopened)

   169

        if self._View is not None:

   170

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

   171

        return self._View

   172

   173

    def _ExportSlave(self):

   174

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

   175

                               _("Choose a file"),

   176

                               os.path.expanduser("~"),

   177

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

   178

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

   179

                               wx.SAVE | wx.OVERWRITE_PROMPT)

   180

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

   181

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

   182

            if result:

   183

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

   184

        dialog.Destroy()

   185

   186

    ConfNodeMethods = [

   187

        {

   188

            "bitmap":    "ExportSlave",

   189

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

   190

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

   191

            "method":   "_ExportSlave"

   192

        },

   193

    ]

   194

   195

    def CTNTestModified(self):

   196

        return self.ChangesToSave or self.OneFileHasChanged()

   197

   198

    def OnCTNSave(self, from_project_path=None):

   199

        return self.SaveCurrentInFile(self.GetSlaveODPath())

   200

   201

    def SetParamsAttribute(self, path, value):

   202

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

   203

   204

        # Filter IEC_Channel and Name, that have specific behavior

   205

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

   206

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

   207

   208

        return result

   209

   210

    def GetVariableLocationTree(self):

   211

        return GetSlaveLocationTree(self.CurrentNode,

   212

                                    self.GetCurrentLocation(),

   213

                                    self.BaseParams.getName())

   214

   215

    def CTNGenerate_C(self, buildpath, locations):

   216

        """

   217

        Generate C code

   218

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

   219

        @param locations: List of complete variables locations \

   220

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

   221

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

   222

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

   223

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

   224

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

   225

            }, ...]

   226

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

   227

        """

   228

        current_location = self.GetCurrentLocation()

   229

        # define a unique name for the generated C file

   230

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

   231

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

   232

        # Create a new copy of the model

   233

        slave = self.GetCurrentNodeCopy()

   234

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

   235

        # allow access to local OD from Slave PLC

   236

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

   237

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

   238

        if res:

   239

            raise Exception(res)

   240

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

   241

        if res:

   242

            raise Exception(res)

   243

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

   244

   245

    def LoadPrevious(self):

   246

        self.LoadCurrentPrevious()

   247

   248

    def LoadNext(self):

   249

        self.LoadCurrentNext()

   250

   251

    def GetBufferState(self):

   252

        return self.GetCurrentBufferState()

   253

   254

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

   255

#                    MASTER

   256

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

   257

   258

   259

class MiniNodeManager(NodeManager):

   260

   261

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

   262

        NodeManager.__init__(self)

   263

   264

        self.OpenFileInCurrent(filepath)

   265

   266

        self.Parent = parent

   267

        self.Fullname = fullname

   268

   269

    def GetIconName(self):

   270

        return None

   271

   272

    def OnCloseEditor(self, view):

   273

        self.Parent.OnCloseEditor(view)

   274

   275

    def CTNFullName(self):

   276

        return self.Fullname

   277

   278

    def CTNTestModified(self):

   279

        return False

   280

   281

    def GetBufferState(self):

   282

        return self.GetCurrentBufferState()

   283

   284

    ConfNodeMethods = []

   285

   286

   287

class _NodeManager(NodeManager):

   288

   289

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

   290

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

   291

        self.Parent = parent

   292

   293

    def __del__(self):

   294

        self.Parent = None

   295

   296

    def GetCurrentNodeName(self):

   297

        return self.Parent.CTNName()

   298

   299

    def GetCurrentNodeID(self):

   300

        return self.Parent.CanFestivalNode.getNodeId()

   301

   302

   303

class _NodeListCTN(NodeList):

   304

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

   305

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

   306

      <xsd:element name="CanFestivalNode">

   307

        <xsd:complexType>

   308

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

   309

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

   310

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

   311

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

   312

        </xsd:complexType>

   313

      </xsd:element>

   314

    </xsd:schema>

   315

    """

   316

   317

    EditorType = NetworkEditor

   318

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

   319

   320

    def __init__(self):

   321

        manager = _NodeManager(self)

   322

        NodeList.__init__(self, manager)

   323

        self.LoadProject(self.CTNPath())

   324

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

   325

   326

    def GetCanDevice(self):

   327

        return self.CanFestivalNode.getCAN_Device()

   328

   329

    def SetParamsAttribute(self, path, value):

   330

        if path == "CanFestivalNode.NodeId":

   331

            nodeid = self.CanFestivalNode.getNodeId()

   332

            if value != nodeid:

   333

                slaves = self.GetSlaveIDs()

   334

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

   335

                while value in slaves and value >= 0:

   336

                    value += dir

   337

                if value < 0:

   338

                    value = nodeid

   339

   340

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

   341

        refresh_network = False

   342

   343

        # Filter IEC_Channel and Name, that have specific behavior

   344

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

   345

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

   346

        elif path == "BaseParams.Name":

   347

            self.SetNetworkName(value)

   348

            refresh_network = True

   349

        elif path == "CanFestivalNode.NodeId":

   350

            refresh_network = True

   351

   352

        if refresh_network and self._View is not None:

   353

            wx.CallAfter(self._View.RefreshBufferState)

   354

        return value, refresh

   355

   356

    def GetVariableLocationTree(self):

   357

        current_location = self.GetCurrentLocation()

   358

        nodeindexes = self.SlaveNodes.keys()

   359

        nodeindexes.sort()

   360

        children = []

   361

        children += [GetSlaveLocationTree(self.Manager.GetCurrentNodeCopy(),

   362

                                          current_location,

   363

                                          _("Local entries"))]

   364

        children += [GetSlaveLocationTree(self.SlaveNodes[nodeid]["Node"],

   365

                                          current_location + (nodeid,),

   366

                                          self.SlaveNodes[nodeid]["Name"]) for nodeid in nodeindexes]

   367

   368

        return {

   369

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

   370

            "type":     LOCATION_CONFNODE,

   371

            "location": self.GetFullIEC_Channel(),

   372

            "children": children

   373

        }

   374

   375

    _GeneratedMasterView = None

   376

   377

    def _ShowGeneratedMaster(self):

   378

        self._OpenView("Generated master")

   379

   380

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

   381

        if name == "Generated master":

   382

            app_frame = self.GetCTRoot().AppFrame

   383

            if self._GeneratedMasterView is None:

   384

                buildpath = self._getBuildPath()

   385

                # Eventually create build dir

   386

                if not os.path.exists(buildpath):

   387

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

   388

                    return

   389

   390

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

   391

                if not os.path.exists(masterpath):

   392

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

   393

                    return

   394

   395

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

   396

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

   397

   398

            if self._GeneratedMasterView is not None:

   399

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

   400

   401

            return self._GeneratedMasterView

   402

        else:

   403

            ConfigTreeNode._OpenView(self, name, onlyopened)

   404

            if self._View is not None:

   405

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

   406

            return self._View

   407

   408

    ConfNodeMethods = [

   409

        {

   410

            "bitmap":    "ShowMaster",

   411

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

   412

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

   413

            "method":   "_ShowGeneratedMaster"

   414

        }

   415

    ]

   416

   417

    def OnCloseEditor(self, view):

   418

        ConfigTreeNode.OnCloseEditor(self, view)

   419

        if self._GeneratedMasterView == view:

   420

            self._GeneratedMasterView = None

   421

   422

    def OnCTNClose(self):

   423

        ConfigTreeNode.OnCTNClose(self)

   424

        self._CloseView(self._GeneratedMasterView)

   425

        return True

   426

   427

    def CTNTestModified(self):

   428

        return self.ChangesToSave or self.HasChanged()

   429

   430

    def OnCTNSave(self, from_project_path=None):

   431

        self.SetRoot(self.CTNPath())

   432

        if from_project_path is not None:

   433

            shutil.copytree(self.GetEDSFolder(from_project_path),

   434

                            self.GetEDSFolder())

   435

        return self.SaveProject() is None

   436

   437

    def CTNGenerate_C(self, buildpath, locations):

   438

        """

   439

        Generate C code

   440

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

   441

        @param locations: List of complete variables locations \

   442

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

   443

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

   444

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

   445

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

   446

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

   447

            }, ...]

   448

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

   449

        """

   450

        self._CloseView(self._GeneratedMasterView)

   451

        current_location = self.GetCurrentLocation()

   452

        # define a unique name for the generated C file

   453

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

   454

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

   455

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

   456

        try:

   457

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

   458

        except config_utils.PDOmappingException, e:

   459

            raise Exception(e.message)

   460

        # Do generate C file.

   461

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

   462

        if res:

   463

            raise Exception(res)

   464

   465

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

   466

        # linter disabled here, undefined variable happens

   467

        # here because gnosis isn't impored while linting

   468

        dump(master, file)  # pylint: disable=undefined-variable

   469

        file.close()

   470

   471

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

   472

   473

    def LoadPrevious(self):

   474

        self.Manager.LoadCurrentPrevious()

   475

   476

    def LoadNext(self):

   477

        self.Manager.LoadCurrentNext()

   478

   479

    def GetBufferState(self):

   480

        return self.Manager.GetCurrentBufferState()