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

    27

    28

import os

    29

import sys

    30

import shutil

    31

import wx

    32

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

    33

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

    34

    35

import util.paths as paths

    36

    37

from util.TranslationCatalogs import AddCatalog

    38

from ConfigTreeNode import ConfigTreeNode

    39

from PLCControler import \

    40

    LOCATION_CONFNODE, \

    41

    LOCATION_VAR_MEMORY

    42

    43

CanFestivalPath = paths.ThirdPartyPath("CanFestival-3")  # noqa

    44

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

    45

    46

# pylint: disable=wrong-import-position

    47

from nodelist import NodeList

    48

from nodemanager import NodeManager

    49

import gen_cfile

    50

import eds_utils

    51

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

    52

from commondialogs import CreateNodeDialog

    53

from subindextable import IECTypeConversion, SizeConversion

    54

from canfestival import config_utils

    55

from canfestival.SlaveEditor import SlaveEditor, MasterViewer

    56

from canfestival.NetworkEditor import NetworkEditor

    57

    58

    59

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

    60

setParanoia(0)

    61

    62

    63

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

    64

#              Location Tree Helper

    65

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

    66

    67

    68

def GetSlaveLocationTree(slave_node, current_location, name):

    69

    entries = []

    70

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

    71

        subentry_infos = slave_node.GetSubentryInfos(index, subindex)

    72

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

    73

        if typeinfos:

    74

            entries.append({

    75

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

    76

                "type": LOCATION_VAR_MEMORY,

    77

                "size": size,

    78

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

    79

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

    80

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

    81

                                                                         (index, subindex)))),

    82

                "description": "",

    83

                "children": []})

    84

    return {"name": name,

    85

            "type": LOCATION_CONFNODE,

    86

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

    87

            "children": entries}

    88

    89

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

    90

#                    SLAVE

    91

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

    92

    93

    94

class _SlaveCTN(NodeManager):

    95

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

    96

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

    97

      <xsd:element name="CanFestivalSlaveNode">

    98

        <xsd:complexType>

    99

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

   100

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

   101

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

   102

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

   103

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

   104

            <xsd:simpleType>

   105

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

   106

                    <xsd:minInclusive value="1"/>

   107

                    <xsd:maxInclusive value="99"/>

   108

                </xsd:restriction>

   109

            </xsd:simpleType>

   110

          </xsd:attribute>

   111

        </xsd:complexType>

   112

      </xsd:element>

   113

    </xsd:schema>

   114

    """

   115

   116

    EditorType = SlaveEditor

   117

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

   118

   119

    def __init__(self):

   120

        # TODO change netname when name change

   121

        NodeManager.__init__(self)

   122

        odfilepath = self.GetSlaveODPath()

   123

        if os.path.isfile(odfilepath):

   124

            self.OpenFileInCurrent(odfilepath)

   125

        else:

   126

            self.FilePath = ""

   127

            dialog = CreateNodeDialog(None, wx.OK)

   128

            dialog.Type.Enable(False)

   129

            dialog.GenSYNC.Enable(False)

   130

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

   131

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

   132

                profile, filepath = dialog.GetProfile()

   133

                NMT = dialog.GetNMTManagement()

   134

                options = dialog.GetOptions()

   135

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

   136

                                   id,           # NodeID - will be changed at build time

   137

                                   "slave",      # Type

   138

                                   description,  # description

   139

                                   profile,      # profile

   140

                                   filepath,     # prfile filepath

   141

                                   NMT,          # NMT

   142

                                   options)      # options

   143

            else:

   144

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

   145

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

   146

                                   "slave",      # Type

   147

                                   "",           # description

   148

                                   "None",       # profile

   149

                                   "",           # prfile filepath

   150

                                   "heartbeat",  # NMT

   151

                                   [])           # options

   152

            dialog.Destroy()

   153

            self.OnCTNSave()

   154

   155

    def GetCurrentNodeName(self):

   156

        return self.CTNName()

   157

   158

    def GetSlaveODPath(self):

   159

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

   160

   161

    def GetCanDevice(self):

   162

        return self.CanFestivalSlaveNode.getCAN_Device()

   163

   164

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

   165

        ConfigTreeNode._OpenView(self, name, onlyopened)

   166

        if self._View is not None:

   167

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

   168

        return self._View

   169

   170

    def _ExportSlave(self):

   171

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

   172

                               _("Choose a file"),

   173

                               os.path.expanduser("~"),

   174

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

   175

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

   176

                               wx.SAVE | wx.OVERWRITE_PROMPT)

   177

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

   178

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

   179

            if result:

   180

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

   181

        dialog.Destroy()

   182

   183

    ConfNodeMethods = [

   184

        {

   185

            "bitmap":    "ExportSlave",

   186

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

   187

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

   188

            "method":   "_ExportSlave"

   189

        },

   190

    ]

   191

   192

    def CTNTestModified(self):

   193

        return self.ChangesToSave or self.OneFileHasChanged()

   194

   195

    def OnCTNSave(self, from_project_path=None):

   196

        return self.SaveCurrentInFile(self.GetSlaveODPath())

   197

   198

    def SetParamsAttribute(self, path, value):

   199

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

   200

   201

        # Filter IEC_Channel and Name, that have specific behavior

   202

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

   203

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

   204

   205

        return result

   206

   207

    def GetVariableLocationTree(self):

   208

        return GetSlaveLocationTree(self.CurrentNode,

   209

                                    self.GetCurrentLocation(),

   210

                                    self.BaseParams.getName())

   211

   212

    def CTNGenerate_C(self, buildpath, locations):

   213

        """

   214

        Generate C code

   215

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

   216

        @param locations: List of complete variables locations \

   217

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

   218

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

   219

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

   220

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

   221

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

   222

            }, ...]

   223

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

   224

        """

   225

        current_location = self.GetCurrentLocation()

   226

        # define a unique name for the generated C file

   227

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

   228

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

   229

        # Create a new copy of the model

   230

        slave = self.GetCurrentNodeCopy()

   231

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

   232

        # allow access to local OD from Slave PLC

   233

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

   234

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

   235

        if res:

   236

            raise Exception(res)

   237

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

   238

        if res:

   239

            raise Exception(res)

   240

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

   241

   242

    def LoadPrevious(self):

   243

        self.LoadCurrentPrevious()

   244

   245

    def LoadNext(self):

   246

        self.LoadCurrentNext()

   247

   248

    def GetBufferState(self):

   249

        return self.GetCurrentBufferState()

   250

   251

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

   252

#                    MASTER

   253

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

   254

   255

   256

class MiniNodeManager(NodeManager):

   257

   258

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

   259

        NodeManager.__init__(self)

   260

   261

        self.OpenFileInCurrent(filepath)

   262

   263

        self.Parent = parent

   264

        self.Fullname = fullname

   265

   266

    def GetIconName(self):

   267

        return None

   268

   269

    def OnCloseEditor(self, view):

   270

        self.Parent.OnCloseEditor(view)

   271

   272

    def CTNFullName(self):

   273

        return self.Fullname

   274

   275

    def CTNTestModified(self):

   276

        return False

   277

   278

    def GetBufferState(self):

   279

        return self.GetCurrentBufferState()

   280

   281

    ConfNodeMethods = []

   282

   283

   284

class _NodeManager(NodeManager):

   285

   286

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

   287

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

   288

        self.Parent = parent

   289

   290

    def __del__(self):

   291

        self.Parent = None

   292

   293

    def GetCurrentNodeName(self):

   294

        return self.Parent.CTNName()

   295

   296

    def GetCurrentNodeID(self):

   297

        return self.Parent.CanFestivalNode.getNodeId()

   298

   299

   300

class _NodeListCTN(NodeList):

   301

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

   302

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

   303

      <xsd:element name="CanFestivalNode">

   304

        <xsd:complexType>

   305

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

   306

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

   307

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

   308

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

   309

        </xsd:complexType>

   310

      </xsd:element>

   311

    </xsd:schema>

   312

    """

   313

   314

    EditorType = NetworkEditor

   315

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

   316

   317

    def __init__(self):

   318

        manager = _NodeManager(self)

   319

        NodeList.__init__(self, manager)

   320

        self.LoadProject(self.CTNPath())

   321

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

   322

   323

    def GetCanDevice(self):

   324

        return self.CanFestivalNode.getCAN_Device()

   325

   326

    def SetParamsAttribute(self, path, value):

   327

        if path == "CanFestivalNode.NodeId":

   328

            nodeid = self.CanFestivalNode.getNodeId()

   329

            if value != nodeid:

   330

                slaves = self.GetSlaveIDs()

   331

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

   332

                while value in slaves and value >= 0:

   333

                    value += dir

   334

                if value < 0:

   335

                    value = nodeid

   336

   337

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

   338

        refresh_network = False

   339

   340

        # Filter IEC_Channel and Name, that have specific behavior

   341

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

   342

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

   343

        elif path == "BaseParams.Name":

   344

            self.SetNetworkName(value)

   345

            refresh_network = True

   346

        elif path == "CanFestivalNode.NodeId":

   347

            refresh_network = True

   348

   349

        if refresh_network and self._View is not None:

   350

            wx.CallAfter(self._View.RefreshBufferState)

   351

        return value, refresh

   352

   353

    def GetVariableLocationTree(self):

   354

        current_location = self.GetCurrentLocation()

   355

        nodeindexes = list(self.SlaveNodes.keys())

   356

        nodeindexes.sort()

   357

        children = []

   358

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

   359

                                          current_location,

   360

                                          _("Local entries"))]

   361

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

   362

                                          current_location + (nodeid,),

   363

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

   364

   365

        return {

   366

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

   367

            "type":     LOCATION_CONFNODE,

   368

            "location": self.GetFullIEC_Channel(),

   369

            "children": children

   370

        }

   371

   372

    _GeneratedMasterView = None

   373

   374

    def _ShowGeneratedMaster(self):

   375

        self._OpenView("Generated master")

   376

   377

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

   378

        if name == "Generated master":

   379

            app_frame = self.GetCTRoot().AppFrame

   380

            if self._GeneratedMasterView is None:

   381

                buildpath = self._getBuildPath()

   382

                # Eventually create build dir

   383

                if not os.path.exists(buildpath):

   384

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

   385

                    return

   386

   387

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

   388

                if not os.path.exists(masterpath):

   389

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

   390

                    return

   391

   392

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

   393

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

   394

   395

            if self._GeneratedMasterView is not None:

   396

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

   397

   398

            return self._GeneratedMasterView

   399

        else:

   400

            ConfigTreeNode._OpenView(self, name, onlyopened)

   401

            if self._View is not None:

   402

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

   403

            return self._View

   404

   405

    ConfNodeMethods = [

   406

        {

   407

            "bitmap":    "ShowMaster",

   408

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

   409

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

   410

            "method":   "_ShowGeneratedMaster"

   411

        }

   412

    ]

   413

   414

    def OnCloseEditor(self, view):

   415

        ConfigTreeNode.OnCloseEditor(self, view)

   416

        if self._GeneratedMasterView == view:

   417

            self._GeneratedMasterView = None

   418

   419

    def OnCTNClose(self):

   420

        ConfigTreeNode.OnCTNClose(self)

   421

        self._CloseView(self._GeneratedMasterView)

   422

        return True

   423

   424

    def CTNTestModified(self):

   425

        return self.ChangesToSave or self.HasChanged()

   426

   427

    def OnCTNSave(self, from_project_path=None):

   428

        self.SetRoot(self.CTNPath())

   429

        if from_project_path is not None:

   430

            shutil.copytree(self.GetEDSFolder(from_project_path),

   431

                            self.GetEDSFolder())

   432

        return self.SaveProject() is None

   433

   434

    def CTNGenerate_C(self, buildpath, locations):

   435

        """

   436

        Generate C code

   437

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

   438

        @param locations: List of complete variables locations \

   439

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

   440

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

   441

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

   442

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

   443

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

   444

            }, ...]

   445

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

   446

        """

   447

        self._CloseView(self._GeneratedMasterView)

   448

        current_location = self.GetCurrentLocation()

   449

        # define a unique name for the generated C file

   450

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

   451

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

   452

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

   453

        try:

   454

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

   455

        except config_utils.PDOmappingException as e:

   456

            raise Exception(e.message)

   457

        # Do generate C file.

   458

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

   459

        if res:

   460

            raise Exception(res)

   461

   462

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

   463

        # linter disabled here, undefined variable happens

   464

        # here because gnosis isn't impored while linting

   465

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

   466

        file.close()

   467

   468

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

   469

   470

    def LoadPrevious(self):

   471

        self.Manager.LoadCurrentPrevious()

   472

   473

    def LoadNext(self):

   474

        self.Manager.LoadCurrentNext()

   475

   476

    def GetBufferState(self):

   477

        return self.Manager.GetCurrentBufferState()

   478

   479