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 GetMasterNodeID(self):

    75

        return self.Manager.GetCurrentNodeID()

    76

    77

    def GetSlaveNumber(self):

    78

        return len(self.SlaveNodes)

    79

    80

    def GetSlaveName(self, idx):

    81

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

    82

    83

    def GetSlaveNames(self):

    84

        nodes = self.SlaveNodes.keys()

    85

        nodes.sort()

    86

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

    87

    88

    def GetSlaveIDs(self):

    89

        nodes = self.SlaveNodes.keys()

    90

        nodes.sort()

    91

        return nodes

    92

    93

    def SetCurrentSelected(self, selected):

    94

        self.CurrentSelected = selected

    95

    96

    def GetCurrentSelected(self):

    97

        return self.CurrentSelected

    98

    99

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

   100

        self.SlaveNodes = {}

   101

        self.EDSNodes = {}

   102

   103

        self.Root = root

   104

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

   105

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

   106

   107

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

   108

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

   109

            os.mkdir(self.EDSFolder)

   110

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

   111

   112

        files = os.listdir(self.EDSFolder)

   113

        for file in files:

   114

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

   115

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

   116

                result = self.LoadEDS(file)

   117

                if result != None:

   118

                    return result

   119

   120

        result = self.LoadMasterNode(netname)

   121

        if result != None:

   122

            return result

   123

   124

        result = self.LoadSlaveNodes(netname)

   125

        if result != None:

   126

            return result

   127

   128

        self.NetworkName = netname

   129

   130

    def SaveProject(self, netname = None):

   131

        result = self.SaveMasterNode(netname)

   132

        if result != None:

   133

            return result

   134

   135

        result = self.SaveNodeList(netname)

   136

        if result != None:

   137

            return result

   138

   139

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

   140

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

   141

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

   142

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

   143

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

   144

        else:

   145

            shutil.copy(edspath, self.EDSFolder)

   146

            return self.LoadEDS(file), False

   147

   148

    def LoadEDS(self, eds):

   149

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

   150

        node = eds_utils.GenerateNode(edspath)

   151

        if isinstance(node, Node):

   152

            self.EDSNodes[eds] = node

   153

            return None

   154

        else:

   155

            return node

   156

   157

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

   158

        if eds in self.EDSNodes.keys():

   159

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

   160

            self.SlaveNodes[nodeID] = slave

   161

            self.Changed = True

   162

            return None

   163

        else:

   164

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

   165

   166

    def RemoveSlaveNode(self, index):

   167

        if index in self.SlaveNodes.keys():

   168

            self.SlaveNodes.pop(index)

   169

            self.Changed = True

   170

            return None

   171

        else:

   172

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

   173

   174

    def LoadMasterNode(self, netname = None):

   175

        if netname:

   176

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

   177

        else:

   178

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

   179

        if os.path.isfile(masterpath):

   180

            result = self.Manager.OpenFileInCurrent(masterpath)

   181

        else:

   182

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

   183

        if not isinstance(result, types.IntType):

   184

            return result

   185

        return None

   186

   187

    def SaveMasterNode(self, netname = None):

   188

        if netname:

   189

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

   190

        else:

   191

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

   192

        if self.Manager.SaveCurrentInFile(masterpath):

   193

            return None

   194

        else:

   195

            return _("Fail to save Master Node")

   196

   197

    def LoadSlaveNodes(self, netname = None):

   198

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

   199

        if os.path.isfile(cpjpath):

   200

            try:

   201

                networks = eds_utils.ParseCPJFile(cpjpath)

   202

                network = None

   203

                if netname:

   204

                    for net in networks:

   205

                        if net["Name"] == netname:

   206

                            network = net

   207

                    self.NetworkName = netname

   208

                elif len(networks) > 0:

   209

                    network = networks[0]

   210

                    self.NetworkName = network["Name"]

   211

                if network:

   212

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

   213

                        if node["Present"] == 1:

   214

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

   215

                            if result != None:

   216

                                return result        

   217

                self.Changed = False

   218

            except SyntaxError, message:

   219

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

   220

        return None

   221

   222

    def SaveNodeList(self, netname = None):

   223

        try:

   224

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

   225

            content = eds_utils.GenerateCPJContent(self)

   226

            if netname:

   227

                file = open(cpjpath, "a")

   228

            else:

   229

                file = open(cpjpath, "w")

   230

            file.write(content)

   231

            file.close()

   232

            self.Changed = False

   233

            return None

   234

        except:

   235

            return _("Fail to save node list")

   236

   237

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

   238

        if nodeid in self.SlaveNodes.keys():

   239

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

   240

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

   241

        else:

   242

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

   243

   244

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

   245

        return self.Manager.GetCurrentEntry(index, subindex)

   246

   247

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

   248

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

   249

   250

    def GetOrderNumber(self, nodeid):

   251

        nodeindexes = self.SlaveNodes.keys()

   252

        nodeindexes.sort()

   253

        return nodeindexes.index(nodeid) + 1

   254

   255

    def GetNodeByOrder(self, order):

   256

        if order > 0:

   257

            nodeindexes = self.SlaveNodes.keys()

   258

            nodeindexes.sort()

   259

            if order <= len(nodeindexes):

   260

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

   261

        return None

   262

   263

    def IsCurrentEntry(self, index):

   264

        if self.CurrentSelected != None:

   265

            if self.CurrentSelected == 0:

   266

                return self.Manager.IsCurrentEntry(index)

   267

            else:

   268

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

   269

                if node:

   270

                    node.SetNodeID(self.CurrentSelected)

   271

                    return node.IsEntry(index)

   272

        return False

   273

   274

    def GetEntryInfos(self, index):

   275

        if self.CurrentSelected != None:

   276

            if self.CurrentSelected == 0:

   277

                return self.Manager.GetEntryInfos(index)

   278

            else:

   279

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

   280

                if node:

   281

                    node.SetNodeID(self.CurrentSelected)

   282

                    return node.GetEntryInfos(index)

   283

        return None

   284

   285

    def GetSubentryInfos(self, index, subindex):

   286

        if self.CurrentSelected != None:

   287

            if self.CurrentSelected == 0:

   288

                return self.Manager.GetSubentryInfos(index, subindex)

   289

            else:

   290

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

   291

                if node:

   292

                    node.SetNodeID(self.CurrentSelected)

   293

                    return node.GetSubentryInfos(index, subindex)

   294

        return None

   295

   296

    def GetCurrentValidIndexes(self, min, max):

   297

        if self.CurrentSelected != None:

   298

            if self.CurrentSelected == 0:

   299

                return self.Manager.GetCurrentValidIndexes(min, max)

   300

            else:

   301

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

   302

                if node:

   303

                    node.SetNodeID(self.CurrentSelected)

   304

                    validindexes = []

   305

                    for index in node.GetIndexes():

   306

                        if min <= index <= max:

   307

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

   308

                    return validindexes

   309

                else:

   310

                    print _("Can't find node")

   311

        return []

   312

   313

    def GetCurrentEntryValues(self, index):

   314

        if self.CurrentSelected != None:

   315

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

   316

            if node:

   317

                node.SetNodeID(self.CurrentSelected)

   318

                return self.Manager.GetNodeEntryValues(node, index)

   319

            else:

   320

                print _("Can't find node")

   321

        return [], []

   322

   323

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

   324

        # Adding DCF entry into Master node

   325

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

   326

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

   327

        self.Manager.AddSubentriesToCurrent(0x1F22, 127)

   328

   329

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

   330

   331

if __name__ == "__main__":

   332

    from nodemanager import *

   333

    import os, sys, shutil

   334

   335

    manager = NodeManager(sys.path[0])

   336

   337

    nodelist = NodeList(manager)

   338

   339

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

   340

    if result != None:

   341

        print result

   342

    else:

   343

        print "MasterNode :"

   344

        manager.CurrentNode.Print()

   345

        print 

   346

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

   347

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

   348

            node["Node"].Print()

   349

            print

   350