1

#!/usr/bin/env python

     2

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

     3

     4

#This file is part of CanFestival, a library implementing CanOpen Stack. 

     5

#

     6

#Copyright (C): Edouard TISSERANT, Francis DUPIN and Laurent BESSARD

     7

#

     8

#See COPYING file for copyrights details.

     9

#

    10

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

    11

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

    12

#License as published by the Free Software Foundation; either

    13

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

    14

#

    15

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

    16

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

    17

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    18

#Lesser General Public License for more details.

    19

#

    20

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

    21

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

    22

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    23

    24

from node import *

    25

import eds_utils

    26

import os, shutil, types

    27

    28

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

    29

#                          Definition of NodeList Object

    30

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

    31

    32

"""

    33

Class recording a node list for a CANOpen network.

    34

"""

    35

    36

class NodeList:

    37

    38

    def __init__(self, manager, netname = ""):

    39

        self.Root = ""

    40

        self.EDSFolder = ""

    41

        self.Manager = manager

    42

        self.NetworkName = netname

    43

        self.SlaveNodes = {}

    44

        self.EDSNodes = {}

    45

        self.CurrentSelected = None

    46

        self.Changed = False

    47

    48

    def HasChanged(self):

    49

        return self.Changed or not self.Manager.CurrentIsSaved()

    50

    51

    def ForceChanged(self, changed):

    52

        self.Changed = changed

    53

    54

    def GetNetworkName(self):

    55

        return self.NetworkName

    56

    57

    def SetNetworkName(self, name):

    58

        self.NetworkName = name

    59

    60

    def GetManager(self):

    61

        return self.Manager

    62

    63

    def GetRoot(self):

    64

        return self.Root

    65

    66

    def SetRoot(self, newrootpath):

    67

        """

    68

        Define a new path for the CanOpen network project

    69

        !!! Does not check if new path is valid !!!

    70

        """

    71

        self.Root = newrootpath

    72

        self.Manager.SetCurrentFilePath(os.path.join(self.Root, "master.od"))

    73

    74

    def GetSlaveNumber(self):

    75

        return len(self.SlaveNodes)

    76

    77

    def GetSlaveName(self, idx):

    78

        return self.SlaveNodes[idx]["Name"]

    79

    80

    def GetSlaveNames(self):

    81

        nodes = self.SlaveNodes.keys()

    82

        nodes.sort()

    83

        return ["0x%2.2X %s"%(idx, self.SlaveNodes[idx]["Name"]) for idx in nodes]

    84

    85

    def GetSlaveIDs(self):

    86

        nodes = self.SlaveNodes.keys()

    87

        nodes.sort()

    88

        return nodes

    89

    90

    def SetCurrentSelected(self, selected):

    91

        self.CurrentSelected = selected

    92

    93

    def GetCurrentSelected(self):

    94

        return self.CurrentSelected

    95

    96

    def LoadProject(self, root, netname = None):

    97

        self.SlaveNodes = {}

    98

        self.EDSNodes = {}

    99

   100

        self.Root = root

   101

        if not os.path.exists(self.Root):

   102

            return _("\"%s\" folder doesn't exist")%self.Root

   103

   104

        self.EDSFolder = os.path.join(self.Root, "eds")

   105

        if not os.path.exists(self.EDSFolder):

   106

            os.mkdir(self.EDSFolder)

   107

            #return "\"%s\" folder doesn't contain a \"eds\" folder"%self.Root

   108

   109

        files = os.listdir(self.EDSFolder)

   110

        for file in files:

   111

            filepath = os.path.join(self.EDSFolder, file)

   112

            if os.path.isfile(filepath) and os.path.splitext(filepath)[-1] == ".eds":

   113

                result = self.LoadEDS(file)

   114

                if result != None:

   115

                    return result

   116

   117

        result = self.LoadMasterNode(netname)

   118

        if result != None:

   119

            return result

   120

   121

        result = self.LoadSlaveNodes(netname)

   122

        if result != None:

   123

            return result

   124

   125

        self.NetworkName = netname

   126

   127

    def SaveProject(self, netname = None):

   128

        result = self.SaveMasterNode(netname)

   129

        if result != None:

   130

            return result

   131

   132

        result = self.SaveNodeList(netname)

   133

        if result != None:

   134

            return result

   135

   136

    def ImportEDSFile(self, edspath, force = False):

   137

        dir, file = os.path.split(edspath)

   138

        eds = os.path.join(self.EDSFolder, file)

   139

        if not force and os.path.isfile(eds):

   140

            return _("EDS file already imported"), True

   141

        else:

   142

            shutil.copy(edspath, self.EDSFolder)

   143

            return self.LoadEDS(file), False

   144

   145

    def LoadEDS(self, eds):

   146

        edspath = os.path.join(self.EDSFolder, eds)

   147

        node = eds_utils.GenerateNode(edspath)

   148

        if isinstance(node, Node):

   149

            self.EDSNodes[eds] = node

   150

            return None

   151

        else:

   152

            return node

   153

   154

    def AddSlaveNode(self, nodeName, nodeID, eds):

   155

        if eds in self.EDSNodes.keys():

   156

            slave = {"Name" : nodeName, "EDS" : eds, "Node" : self.EDSNodes[eds]}

   157

            self.SlaveNodes[nodeID] = slave

   158

            self.Changed = True

   159

            return None

   160

        else:

   161

            return _("\"%s\" EDS file is not available")%eds

   162

   163

    def RemoveSlaveNode(self, index):

   164

        if index in self.SlaveNodes.keys():

   165

            self.SlaveNodes.pop(index)

   166

            self.Changed = True

   167

            return None

   168

        else:

   169

            return _("Node with \"0x%2.2X\" ID doesn't exist")

   170

   171

    def LoadMasterNode(self, netname = None):

   172

        if netname:

   173

            masterpath = os.path.join(self.Root, "%s_master.od"%netname)

   174

        else:

   175

            masterpath = os.path.join(self.Root, "master.od")

   176

        if os.path.isfile(masterpath):

   177

            result = self.Manager.OpenFileInCurrent(masterpath)

   178

        else:

   179

            result = self.Manager.CreateNewNode("MasterNode", 0x00, "master", "", "None", "", "heartbeat", ["DS302"])

   180

        if not isinstance(result, types.IntType):

   181

            return result

   182

        return None

   183

   184

    def SaveMasterNode(self, netname = None):

   185

        if netname:

   186

            masterpath = os.path.join(self.Root, "%s_master.od"%netname)

   187

        else:

   188

            masterpath = os.path.join(self.Root, "master.od")

   189

        if self.Manager.SaveCurrentInFile(masterpath):

   190

            return None

   191

        else:

   192

            return _("Fail to save Master Node")

   193

   194

    def LoadSlaveNodes(self, netname = None):

   195

        cpjpath = os.path.join(self.Root, "nodelist.cpj")

   196

        if os.path.isfile(cpjpath):

   197

            try:

   198

                networks = eds_utils.ParseCPJFile(cpjpath)

   199

                network = None

   200

                if netname:

   201

                    for net in networks:

   202

                        if net["Name"] == netname:

   203

                            network = net

   204

                    self.NetworkName = netname

   205

                elif len(networks) > 0:

   206

                    network = networks[0]

   207

                    self.NetworkName = network["Name"]

   208

                if network:

   209

                    for nodeid, node in network["Nodes"].items():

   210

                        if node["Present"] == 1:

   211

                            result = self.AddSlaveNode(node["Name"], nodeid, node["DCFName"])

   212

                            if result != None:

   213

                                return result        

   214

                self.Changed = False

   215

            except SyntaxError, message:

   216

                return _("Unable to load CPJ file\n%s")%message

   217

        return None

   218

   219

    def SaveNodeList(self, netname = None):

   220

        try:

   221

            cpjpath = os.path.join(self.Root, "nodelist.cpj")

   222

            content = eds_utils.GenerateCPJContent(self)

   223

            if netname:

   224

                file = open(cpjpath, "a")

   225

            else:

   226

                file = open(cpjpath, "w")

   227

            file.write(content)

   228

            file.close()

   229

            self.Changed = False

   230

            return None

   231

        except:

   232

            return _("Fail to save node list")

   233

   234

    def GetSlaveNodeEntry(self, nodeid, index, subindex = None):

   235

        if nodeid in self.SlaveNodes.keys():

   236

            self.SlaveNodes[nodeid]["Node"].SetNodeID(nodeid)

   237

            return self.SlaveNodes[nodeid]["Node"].GetEntry(index, subindex)

   238

        else:

   239

            return _("Node 0x%2.2X doesn't exist")%nodeid

   240

   241

    def GetMasterNodeEntry(self, index, subindex = None):

   242

        return self.Manager.GetCurrentEntry(index, subindex)

   243

   244

    def SetMasterNodeEntry(self, index, subindex = None, value = None):

   245

        self.Manager.SetCurrentEntry(index, subindex, value)

   246

   247

    def GetOrderNumber(self, nodeid):

   248

        nodeindexes = self.SlaveNodes.keys()

   249

        nodeindexes.sort()

   250

        return nodeindexes.index(nodeid) + 1

   251

   252

    def GetNodeByOrder(self, order):

   253

        if order > 0:

   254

            nodeindexes = self.SlaveNodes.keys()

   255

            nodeindexes.sort()

   256

            if order <= len(nodeindexes):

   257

                return self.SlaveNodes[nodeindexes[order - 1]]["Node"]

   258

        return None

   259

   260

    def IsCurrentEntry(self, index):

   261

        if self.CurrentSelected != None:

   262

            if self.CurrentSelected == 0:

   263

                return self.Manager.IsCurrentEntry(index)

   264

            else:

   265

                node = self.SlaveNodes[self.CurrentSelected]["Node"]

   266

                if node:

   267

                    node.SetNodeID(self.CurrentSelected)

   268

                    return node.IsEntry(index)

   269

        return False

   270

   271

    def GetEntryInfos(self, index):

   272

        if self.CurrentSelected != None:

   273

            if self.CurrentSelected == 0:

   274

                return self.Manager.GetEntryInfos(index)

   275

            else:

   276

                node = self.SlaveNodes[self.CurrentSelected]["Node"]

   277

                if node:

   278

                    node.SetNodeID(self.CurrentSelected)

   279

                    return node.GetEntryInfos(index)

   280

        return None

   281

   282

    def GetSubentryInfos(self, index, subindex):

   283

        if self.CurrentSelected != None:

   284

            if self.CurrentSelected == 0:

   285

                return self.Manager.GetSubentryInfos(index, subindex)

   286

            else:

   287

                node = self.SlaveNodes[self.CurrentSelected]["Node"]

   288

                if node:

   289

                    node.SetNodeID(self.CurrentSelected)

   290

                    return node.GetSubentryInfos(index, subindex)

   291

        return None

   292

   293

    def GetCurrentValidIndexes(self, min, max):

   294

        if self.CurrentSelected != None:

   295

            if self.CurrentSelected == 0:

   296

                return self.Manager.GetCurrentValidIndexes(min, max)

   297

            else:

   298

                node = self.SlaveNodes[self.CurrentSelected]["Node"]

   299

                if node:

   300

                    node.SetNodeID(self.CurrentSelected)

   301

                    validindexes = []

   302

                    for index in node.GetIndexes():

   303

                        if min <= index <= max:

   304

                            validindexes.append((node.GetEntryName(index), index))

   305

                    return validindexes

   306

                else:

   307

                    print _("Can't find node")

   308

        return []

   309

   310

    def GetCurrentEntryValues(self, index):

   311

        if self.CurrentSelected != None:

   312

            node = self.SlaveNodes[self.CurrentSelected]["Node"]

   313

            if node:

   314

                node.SetNodeID(self.CurrentSelected)

   315

                return self.Manager.GetNodeEntryValues(node, index)

   316

            else:

   317

                print _("Can't find node")

   318

        return [], []

   319

   320

    def AddToMasterDCF(self, node_id, index, subindex, size, value):

   321

        # Adding DCF entry into Master node

   322

        if not self.Manager.IsCurrentEntry(0x1F22):

   323

            self.Manager.ManageEntriesOfCurrent([0x1F22], [])

   324

        self.Manager.AddSubentriesToCurrent(0x1F22, 127)

   325

   326

        self.Manager.AddToDCF(node_id, index, subindex, size, value)

   327

   328

if __name__ == "__main__":

   329

    from nodemanager import *

   330

    import os, sys, shutil

   331

   332

    manager = NodeManager(sys.path[0])

   333

   334

    nodelist = NodeList(manager)

   335

   336

    result = nodelist.LoadProject("/home/laurent/test_nodelist")

   337

    if result != None:

   338

        print result

   339

    else:

   340

        print "MasterNode :"

   341

        manager.CurrentNode.Print()

   342

        print 

   343

        for nodeid, node in nodelist.SlaveNodes.items():

   344

            print "SlaveNode name=%s id=0x%2.2X :"%(node["Name"], nodeid)

   345

            node["Node"].Print()

   346

            print

   347