2 # -*- coding: utf-8 -*-
4 #This file is part of CanFestival, a library implementing CanOpen Stack.
6 #Copyright (C): Edouard TISSERANT, Francis DUPIN and Laurent BESSARD
8 #See COPYING file for copyrights details.
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.
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.
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
24 from gnosis.xml.pickle import *
25 from gnosis.xml.pickle.util import setParanoia
29 import eds_utils, gen_cfile
36 type_model = re.compile('([\_A-Z]*)([0-9]*)')
37 range_model = re.compile('([\_A-Z]*)([0-9]*)\[([\-0-9]*)-([\-0-9]*)\]')
39 # ID for the file viewed
49 Class implementing a buffer of changes made on the current editing Object Dictionary
55 Constructor initialising buffer
57 def __init__(self, currentstate, issaved = False):
59 self.CurrentIndex = -1
62 # if current state is defined
67 # Initialising buffer with currentstate at the first place
68 for i in xrange(UndoBufferLength):
70 self.Buffer.append(currentstate)
72 self.Buffer.append(None)
73 # Initialising index of state saved
80 Add a new state in buffer
82 def Buffering(self, currentstate):
83 self.CurrentIndex = (self.CurrentIndex + 1) % UndoBufferLength
84 self.Buffer[self.CurrentIndex] = currentstate
85 # Actualising buffer limits
86 self.MaxIndex = self.CurrentIndex
87 if self.MinIndex == self.CurrentIndex:
88 # If the removed state was the state saved, there is no state saved in the buffer
89 if self.LastSave == self.MinIndex:
91 self.MinIndex = (self.MinIndex + 1) % UndoBufferLength
92 self.MinIndex = max(self.MinIndex, 0)
95 Return current state of buffer
98 return self.Buffer[self.CurrentIndex]
101 Change current state to previous in buffer and return new current state
104 if self.CurrentIndex != self.MinIndex:
105 self.CurrentIndex = (self.CurrentIndex - 1) % UndoBufferLength
106 return self.Buffer[self.CurrentIndex]
110 Change current state to next in buffer and return new current state
113 if self.CurrentIndex != self.MaxIndex:
114 self.CurrentIndex = (self.CurrentIndex + 1) % UndoBufferLength
115 return self.Buffer[self.CurrentIndex]
119 Return True if current state is the first in buffer
122 return self.CurrentIndex == self.MinIndex
125 Return True if current state is the last in buffer
128 return self.CurrentIndex == self.MaxIndex
131 Note that current state is saved
133 def CurrentSaved(self):
134 self.LastSave = self.CurrentIndex
137 Return True if current state is saved
139 def IsCurrentSaved(self):
140 return self.LastSave == self.CurrentIndex
145 Class which control the operations made on the node and answer to view requests
154 self.LastNewIndex = 0
157 self.NodeIndex = None
158 self.CurrentNode = None
159 self.UndoBuffers = {}
161 #-------------------------------------------------------------------------------
162 # Type and Map Variable Lists
163 #-------------------------------------------------------------------------------
166 Return the list of types defined for the current node
168 def GetCurrentTypeList(self):
170 return self.CurrentNode.GetTypeList()
175 Return the list of variables that can be mapped for the current node
177 def GetCurrentMapList(self):
179 return self.CurrentNode.GetMapList()
183 #-------------------------------------------------------------------------------
184 # Create Load and Save Functions
185 #-------------------------------------------------------------------------------
188 Create a new node and add a new buffer for storing it
190 def CreateNewNode(self, name, id, type, description, profile, filepath, NMT, options):
193 # Try to load profile given
194 result = self.LoadProfile(profile, filepath, node)
196 # if success, initialising node
197 self.CurrentNode = node
198 self.CurrentNode.SetNodeName(name)
199 self.CurrentNode.SetNodeID(id)
200 self.CurrentNode.SetNodeType(type)
201 self.CurrentNode.SetNodeDescription(description)
202 AddIndexList = self.GetMandatoryIndexes()
203 if NMT == "NodeGuarding":
204 AddIndexList.extend([0x100C, 0x100D])
205 elif NMT == "Heartbeat":
206 AddIndexList.append(0x1017)
207 for option in options:
208 if option == "DS302":
209 DS302Path = os.path.join(os.path.split(__file__)[0], "config/DS-302.prf")
210 # Charging DS-302 profile if choosen by user
211 if os.path.isfile(DS302Path):
214 self.CurrentNode.SetDS302Profile(Mapping)
215 self.CurrentNode.ExtendSpecificMenu(AddMenuEntries)
217 return "Problem with DS-302! Syntax Error."
219 return "Couldn't find DS-302 in 'config' folder!"
220 elif option == "GenSYNC":
221 AddIndexList.extend([0x1005, 0x1006])
222 elif option == "Emergency":
223 AddIndexList.append(0x1014)
224 elif option == "SaveConfig":
225 AddIndexList.extend([0x1010, 0x1011, 0x1020])
226 elif option == "StoreEDS":
227 AddIndexList.extend([0x1021, 0x1022])
229 index = self.AddNodeBuffer(self.CurrentNode.Copy(), False)
230 self.SetCurrentFilePath("")
231 # Add Mandatory indexes
232 self.ManageEntriesOfCurrent(AddIndexList, [])
238 Load a profile in node
240 def LoadProfile(self, profile, filepath, node):
241 if profile != "None":
242 # Try to charge the profile given
245 node.SetProfileName(profile)
246 node.SetProfile(Mapping)
247 node.SetSpecificMenu(AddMenuEntries)
250 return "Syntax Error\nBad OD Profile file!"
253 node.SetProfileName("None")
255 node.SetSpecificMenu([])
259 Open a file and store it in a new buffer
261 def OpenFileInCurrent(self, filepath):
264 file = open(filepath, "r")
267 self.CurrentNode = node
268 self.CurrentNode.SetNodeID(0)
269 # Add a new buffer and defining current state
270 index = self.AddNodeBuffer(self.CurrentNode.Copy(), True)
271 self.SetCurrentFilePath(filepath)
274 return "Unable to load file \"%s\"!"%filepath
277 Save current node in a file
279 def SaveCurrentInFile(self, filepath = None):
280 # if no filepath given, verify if current node has a filepath defined
282 filepath = self.GetCurrentFilePath()
286 file = open(filepath, "w")
287 dump(self.CurrentNode, file)
289 self.SetCurrentFilePath(filepath)
290 # Update saved state in buffer
291 self.UndoBuffers[self.NodeIndex].CurrentSaved()
297 def CloseCurrent(self, ignore = False):
298 # Verify if it's not forced that the current node is saved before closing it
299 if self.UndoBuffers[self.NodeIndex].IsCurrentSaved() or ignore:
300 self.RemoveNodeBuffer(self.NodeIndex)
301 if len(self.UndoBuffers) > 0:
302 previousindexes = [idx for idx in self.UndoBuffers.keys() if idx < self.NodeIndex]
303 nextindexes = [idx for idx in self.UndoBuffers.keys() if idx > self.NodeIndex]
304 if len(previousindexes) > 0:
305 previousindexes.sort()
306 self.NodeIndex = previousindexes[-1]
307 elif len(nextindexes) > 0:
309 self.NodeIndex = nextindexes[0]
311 self.NodeIndex = None
313 self.NodeIndex = None
318 Import an eds file and store it in a new buffer if no node edited
320 def ImportCurrentFromEDSFile(self, filepath):
321 # Generate node from definition in a xml file
322 result = eds_utils.GenerateNode(filepath)
323 if isinstance(result, Node):
324 self.CurrentNode = result
325 index = self.AddNodeBuffer(self.CurrentNode.Copy(), False)
326 self.SetCurrentFilePath("")
332 Export to an eds file and store it in a new buffer if no node edited
334 def ExportCurrentToEDSFile(self, filepath):
335 return eds_utils.GenerateEDSFile(filepath, self)
338 Build the C definition of Object Dictionary for current node
340 def ExportCurrentToCFile(self, filepath):
342 return gen_cfile.GenerateFile(filepath, self.CurrentNode)
344 #-------------------------------------------------------------------------------
345 # Add Entries to Current Functions
346 #-------------------------------------------------------------------------------
349 Add the specified number of subentry for the given entry. Verify that total
350 number of subentry (except 0) doesn't exceed nbmax defined
352 def AddSubentriesToCurrent(self, index, number, node = None):
353 disable_buffer = node != None
355 node = self.CurrentNode
356 # Informations about entry
357 length = node.GetEntry(index, 0)
358 infos = node.GetEntryInfos(index)
359 subentry_infos = node.GetSubentryInfos(index, 1)
360 # Get default value for subindex
361 if "default" in subentry_infos:
362 default = subentry_infos["default"]
364 default = self.GetTypeDefaultValue(subentry_infos["type"])
365 # First case entry is record
366 if infos["struct"] & OD_IdenticalSubindexes:
367 for i in xrange(1, min(number,subentry_infos["nbmax"]-length) + 1):
368 node.AddEntry(index, length + i, default)
369 if not disable_buffer:
370 self.BufferCurrentNode()
372 # Second case entry is array, only possible for manufacturer specific
373 elif infos["struct"] & OD_MultipleSubindexes and 0x2000 <= index <= 0x5FFF:
374 values = {"name" : "Undefined", "type" : 5, "access" : "rw", "pdo" : True}
375 for i in xrange(1, min(number,0xFE-length) + 1):
376 node.AddMappingEntry(index, length + i, values = values.copy())
377 node.AddEntry(index, length + i, 0)
378 if not disable_buffer:
379 self.BufferCurrentNode()
384 Remove the specified number of subentry for the given entry. Verify that total
385 number of subentry (except 0) isn't less than 1
387 def RemoveSubentriesFromCurrent(self, index, number):
388 # Informations about entry
389 infos = self.GetEntryInfos(index)
390 length = self.CurrentNode.GetEntry(index, 0)
392 nbmin = infos["nbmin"]
395 # Entry is a record, or is an array of manufacturer specific
396 if infos["struct"] & OD_IdenticalSubindexes or 0x2000 <= index <= 0x5FFF and infos["struct"] & OD_IdenticalSubindexes:
397 for i in xrange(min(number, length - nbmin)):
398 self.RemoveCurrentVariable(index, length - i)
399 self.BufferCurrentNode()
402 Add a SDO Server to current node
404 def AddSDOServerToCurrent(self):
405 # An SDO Server is already defined at index 0x1200
406 if self.CurrentNode.IsEntry(0x1200):
407 indexlist = [self.GetLineFromIndex(0x1201)]
408 if None not in indexlist:
409 self.ManageEntriesOfCurrent(indexlist, [])
410 # Add an SDO Server at index 0x1200
412 self.ManageEntriesOfCurrent([0x1200], [])
415 Add a SDO Server to current node
417 def AddSDOClientToCurrent(self):
418 indexlist = [self.GetLineFromIndex(0x1280)]
419 if None not in indexlist:
420 self.ManageEntriesOfCurrent(indexlist, [])
423 Add a Transmit PDO to current node
425 def AddPDOTransmitToCurrent(self):
426 indexlist = [self.GetLineFromIndex(0x1800),self.GetLineFromIndex(0x1A00)]
427 if None not in indexlist:
428 self.ManageEntriesOfCurrent(indexlist, [])
431 Add a Receive PDO to current node
433 def AddPDOReceiveToCurrent(self):
434 indexlist = [self.GetLineFromIndex(0x1400),self.GetLineFromIndex(0x1600)]
435 if None not in indexlist:
436 self.ManageEntriesOfCurrent(indexlist, [])
439 Add a list of entries defined in profile for menu item selected to current node
441 def AddSpecificEntryToCurrent(self, menuitem):
443 for menu, indexes in self.CurrentNode.GetSpecificMenu():
445 for index in indexes:
446 indexlist.append(self.GetLineFromIndex(index))
447 if None not in indexlist:
448 self.ManageEntriesOfCurrent(indexlist, [])
451 Search the first index available for a pluri entry from base_index
453 def GetLineFromIndex(self, base_index):
456 infos = self.GetEntryInfos(base_index)
457 while index < base_index + infos["incr"]*infos["nbmax"] and not found:
458 if not self.CurrentNode.IsEntry(index):
461 index += infos["incr"]
467 Add entries specified in addinglist and remove entries specified in removinglist
469 def ManageEntriesOfCurrent(self, addinglist, removinglist, node = None):
470 disable_buffer = node != None
472 node = self.CurrentNode
473 # Add all the entries in addinglist
474 for index in addinglist:
475 infos = self.GetEntryInfos(index)
476 if infos["struct"] & OD_MultipleSubindexes:
477 # First case entry is a record
478 if infos["struct"] & OD_IdenticalSubindexes:
479 subentry_infos = self.GetSubentryInfos(index, 1)
480 if "default" in subentry_infos:
481 default = subentry_infos["default"]
483 default = self.GetTypeDefaultValue(subentry_infos["type"])
484 node.AddEntry(index, value = [])
485 if "nbmin" in subentry_infos:
486 for i in xrange(subentry_infos["nbmin"]):
487 node.AddEntry(index, i + 1, default)
489 node.AddEntry(index, 1, default)
490 # Second case entry is a record
493 subentry_infos = self.GetSubentryInfos(index, i)
494 while subentry_infos:
495 if "default" in subentry_infos:
496 default = subentry_infos["default"]
498 default = self.GetTypeDefaultValue(subentry_infos["type"])
499 node.AddEntry(index, i, default)
501 subentry_infos = self.GetSubentryInfos(index, i)
502 # Third case entry is a record
504 subentry_infos = self.GetSubentryInfos(index, 0)
505 if "default" in subentry_infos:
506 default = subentry_infos["default"]
508 default = self.GetTypeDefaultValue(subentry_infos["type"])
509 node.AddEntry(index, 0, default)
510 # Remove all the entries in removinglist
511 for index in removinglist:
512 self.RemoveCurrentVariable(index)
513 if not disable_buffer:
514 self.BufferCurrentNode()
519 Reset an subentry from current node to its default value
521 def SetCurrentEntryToDefault(self, index, subindex, node = None):
522 disable_buffer = node != None
524 node = self.CurrentNode
525 if node.IsEntry(index, subindex):
526 subentry_infos = self.GetSubentryInfos(index, subindex)
527 if "default" in subentry_infos:
528 default = subentry_infos["default"]
530 default = self.GetTypeDefaultValue(subentry_infos["type"])
531 node.SetEntry(index, subindex, default)
532 if not disable_buffer:
533 self.BufferCurrentNode()
536 Remove an entry from current node. Analize the index to perform the correct
539 def RemoveCurrentVariable(self, index, subIndex = None):
540 Mappings = self.CurrentNode.GetMappings()
541 if index < 0x1000 and subIndex == None:
542 type = self.CurrentNode.GetEntry(index, 1)
543 for i in Mappings[-1]:
544 for value in Mappings[-1][i]["values"]:
545 if value["type"] == index:
547 self.CurrentNode.RemoveMappingEntry(index)
548 self.CurrentNode.RemoveEntry(index)
549 elif index == 0x1200 and subIndex == None:
550 self.CurrentNode.RemoveEntry(0x1200)
551 elif 0x1201 <= index <= 0x127F and subIndex == None:
552 self.CurrentNode.RemoveLine(index, 0x127F)
553 elif 0x1280 <= index <= 0x12FF and subIndex == None:
554 self.CurrentNode.RemoveLine(index, 0x12FF)
555 elif 0x1400 <= index <= 0x15FF or 0x1600 <= index <= 0x17FF and subIndex == None:
556 if 0x1600 <= index <= 0x17FF and subIndex == None:
558 self.CurrentNode.RemoveLine(index, 0x15FF)
559 self.CurrentNode.RemoveLine(index + 0x200, 0x17FF)
560 elif 0x1800 <= index <= 0x19FF or 0x1A00 <= index <= 0x1BFF and subIndex == None:
561 if 0x1A00 <= index <= 0x1BFF:
563 self.CurrentNode.RemoveLine(index, 0x19FF)
564 self.CurrentNode.RemoveLine(index + 0x200, 0x1BFF)
567 for menu,list in self.CurrentNode.GetSpecificMenu():
569 iinfos = self.GetEntryInfos(i)
570 indexes = [i + incr * iinfos["incr"] for incr in xrange(iinfos["nbmax"])]
575 jinfos = self.GetEntryInfos(j)
576 self.CurrentNode.RemoveLine(j + diff, j + jinfos["incr"]*jinfos["nbmax"], jinfos["incr"])
577 self.CurrentNode.RemoveMapVariable(index, subIndex)
579 infos = self.GetEntryInfos(index)
580 if not infos["need"]:
581 self.CurrentNode.RemoveEntry(index, subIndex)
582 if index in Mappings[-1]:
583 self.CurrentNode.RemoveMappingEntry(index, subIndex)
585 def AddMapVariableToCurrent(self, index, name, struct, number, node = None):
586 if 0x2000 <= index <= 0x5FFF:
587 disable_buffer = node != None
589 node = self.CurrentNode
590 if not node.IsEntry(index):
591 node.AddMappingEntry(index, name = name, struct = struct)
593 values = {"name" : name, "type" : 0x05, "access" : "rw", "pdo" : True}
594 node.AddMappingEntry(index, 0, values = values)
595 node.AddEntry(index, 0, 0)
597 values = {"name" : "Number of Entries", "type" : 0x05, "access" : "ro", "pdo" : False}
598 node.AddMappingEntry(index, 0, values = values)
600 values = {"name" : name + " %d[(sub)]", "type" : 0x05, "access" : "rw", "pdo" : True, "nbmax" : 0xFE}
601 node.AddMappingEntry(index, 1, values = values)
602 for i in xrange(number):
603 node.AddEntry(index, i + 1, 0)
605 for i in xrange(number):
606 values = {"name" : "Undefined", "type" : 0x05, "access" : "rw", "pdo" : True}
607 node.AddMappingEntry(index, i + 1, values = values)
608 node.AddEntry(index, i + 1, 0)
609 if not disable_buffer:
610 self.BufferCurrentNode()
613 return "Index 0x%04X already defined!"%index
615 return "Index 0x%04X isn't a valid index for Map Variable!"%index
617 def AddUserTypeToCurrent(self, type, min, max, length):
619 while index < 0x100 and self.CurrentNode.IsEntry(index):
622 customisabletypes = self.GetCustomisableTypes()
623 name, valuetype = customisabletypes[type]
624 size = self.GetEntryInfos(type)["size"]
625 default = self.GetTypeDefaultValue(type)
627 self.CurrentNode.AddMappingEntry(index, name = "%s[%d-%d]"%(name, min, max), struct = 3, size = size, default = default)
628 self.CurrentNode.AddMappingEntry(index, 0, values = {"name" : "Number of Entries", "type" : 0x05, "access" : "ro", "pdo" : False})
629 self.CurrentNode.AddMappingEntry(index, 1, values = {"name" : "Type", "type" : 0x05, "access" : "ro", "pdo" : False})
630 self.CurrentNode.AddMappingEntry(index, 2, values = {"name" : "Minimum Value", "type" : type, "access" : "ro", "pdo" : False})
631 self.CurrentNode.AddMappingEntry(index, 3, values = {"name" : "Maximum Value", "type" : type, "access" : "ro", "pdo" : False})
632 self.CurrentNode.AddEntry(index, 1, type)
633 self.CurrentNode.AddEntry(index, 2, min)
634 self.CurrentNode.AddEntry(index, 3, max)
636 self.CurrentNode.AddMappingEntry(index, name = "%s%d"%(name, length), struct = 3, size = length * size, default = default)
637 self.CurrentNode.AddMappingEntry(index, 0, values = {"name" : "Number of Entries", "type" : 0x05, "access" : "ro", "pdo" : False})
638 self.CurrentNode.AddMappingEntry(index, 1, values = {"name" : "Type", "type" : 0x05, "access" : "ro", "pdo" : False})
639 self.CurrentNode.AddMappingEntry(index, 2, values = {"name" : "Length", "type" : 0x05, "access" : "ro", "pdo" : False})
640 self.CurrentNode.AddEntry(index, 1, type)
641 self.CurrentNode.AddEntry(index, 2, length)
642 self.BufferCurrentNode()
645 return "Too many User Types have already been defined!"
647 #-------------------------------------------------------------------------------
648 # Modify Entry and Mapping Functions
649 #-------------------------------------------------------------------------------
651 def SetCurrentEntryCallbacks(self, index, value):
652 if self.CurrentNode and self.CurrentNode.IsEntry(index):
653 entry_infos = self.GetEntryInfos(index)
654 if "callback" not in entry_infos:
655 self.CurrentNode.SetParamsEntry(index, None, callback = value)
656 self.BufferCurrentNode()
658 def SetCurrentEntry(self, index, subIndex, value, name, editor, node = None):
659 disable_buffer = node != None
661 node = self.CurrentNode
662 if node and node.IsEntry(index):
665 value = node.GetMapValue(value)
667 node.SetEntry(index, subIndex, value)
668 elif editor == "bool":
669 value = value == "True"
670 node.SetEntry(index, subIndex, value)
671 elif editor == "time":
672 node.SetEntry(index, subIndex, value)
673 elif editor == "number":
675 node.SetEntry(index, subIndex, int(value))
678 elif editor == "float":
680 node.SetEntry(index, subIndex, float(value))
683 elif editor == "domain":
685 if len(value) % 2 != 0:
687 value = value.decode('hex_codec')
688 node.SetEntry(index, subIndex, value)
691 elif editor == "dcf":
692 node.SetEntry(index, subIndex, value)
694 subentry_infos = self.GetSubentryInfos(index, subIndex)
695 type = subentry_infos["type"]
697 for typeindex, typevalue in CustomisableTypes:
698 dic[typeindex] = typevalue
700 type = node.GetEntry(type)[1]
703 if value.startswith("$NODEID"):
704 value = "\"%s\""%value
705 elif value.startswith("0x"):
706 value = int(value, 16)
709 node.SetEntry(index, subIndex, value)
713 node.SetEntry(index, subIndex, value)
714 elif name in ["comment", "save"]:
715 if editor == "option":
716 value = value == "Yes"
718 node.SetParamsEntry(index, subIndex, save = value)
719 elif name == "comment":
720 node.SetParamsEntry(index, subIndex, comment = value)
723 value = self.GetTypeIndex(value)
724 size = self.GetEntryInfos(value)["size"]
725 node.UpdateMapVariable(index, subIndex, size)
726 elif editor in ["access","raccess"]:
728 for abbrev,access in AccessType.iteritems():
731 if editor == "raccess" and not node.IsMappingEntry(index):
732 entry_infos = self.GetEntryInfos(index)
733 node.AddMappingEntry(index, name = entry_infos["name"], struct = 7)
734 node.AddMappingEntry(index, 0, values = self.GetSubentryInfos(index, 0, False).copy())
735 node.AddMappingEntry(index, 1, values = self.GetSubentryInfos(index, 1, False).copy())
736 node.SetMappingEntry(index, subIndex, values = {name : value})
737 if not disable_buffer:
738 self.BufferCurrentNode()
741 def SetCurrentEntryName(self, index, name):
742 self.CurrentNode.SetMappingEntry(index, name=name)
743 self.BufferCurrentNode()
745 def SetCurrentUserType(self, index, type, min, max, length):
746 customisabletypes = self.GetCustomisableTypes()
747 values, valuetype = self.GetCustomisedTypeValues(index)
748 name, new_valuetype = customisabletypes[type]
749 size = self.GetEntryInfos(type)["size"]
750 default = self.GetTypeDefaultValue(type)
751 if new_valuetype == 0:
752 self.CurrentNode.SetMappingEntry(index, name = "%s[%d-%d]"%(name, min, max), struct = 3, size = size, default = default)
754 self.CurrentNode.SetMappingEntry(index, 2, values = {"name" : "Minimum Value", "type" : type, "access" : "ro", "pdo" : False})
755 self.CurrentNode.AddMappingEntry(index, 3, values = {"name" : "Maximum Value", "type" : type, "access" : "ro", "pdo" : False})
756 self.CurrentNode.SetEntry(index, 1, type)
757 self.CurrentNode.SetEntry(index, 2, min)
759 self.CurrentNode.AddEntry(index, 3, max)
761 self.CurrentNode.SetEntry(index, 3, max)
762 elif new_valuetype == 1:
763 self.CurrentNode.SetMappingEntry(index, name = "%s%d"%(name, length), struct = 3, size = size, default = default)
765 self.CurrentNode.SetMappingEntry(index, 2, values = {"name" : "Length", "type" : 0x02, "access" : "ro", "pdo" : False})
766 self.CurrentNode.RemoveMappingEntry(index, 3)
767 self.CurrentNode.SetEntry(index, 1, type)
768 self.CurrentNode.SetEntry(index, 2, length)
770 self.CurrentNode.RemoveEntry(index, 3)
771 self.BufferCurrentNode()
773 #-------------------------------------------------------------------------------
774 # Current Buffering Management Functions
775 #-------------------------------------------------------------------------------
777 def BufferCurrentNode(self):
778 self.UndoBuffers[self.NodeIndex].Buffering(self.CurrentNode.Copy())
780 def CurrentIsSaved(self):
781 return self.UndoBuffers[self.NodeIndex].IsCurrentSaved()
783 def OneFileHasChanged(self):
785 for buffer in self.UndoBuffers.values():
786 result |= not buffer.IsCurrentSaved()
789 def GetBufferNumber(self):
790 return len(self.UndoBuffers)
792 def LoadCurrentPrevious(self):
793 self.CurrentNode = self.UndoBuffers[self.NodeIndex].Previous().Copy()
795 def LoadCurrentNext(self):
796 self.CurrentNode = self.UndoBuffers[self.NodeIndex].Next().Copy()
798 def AddNodeBuffer(self, currentstate = None, issaved = False):
799 self.NodeIndex = GetNewId()
800 self.UndoBuffers[self.NodeIndex] = UndoBuffer(currentstate, issaved)
801 self.FilePaths[self.NodeIndex] = ""
802 self.FileNames[self.NodeIndex] = ""
803 return self.NodeIndex
805 def ChangeCurrentNode(self, index):
806 if index in self.UndoBuffers.keys():
807 self.NodeIndex = index
808 self.CurrentNode = self.UndoBuffers[self.NodeIndex].Current().Copy()
810 def RemoveNodeBuffer(self, index):
811 self.UndoBuffers.pop(index)
812 self.FilePaths.pop(index)
813 self.FileNames.pop(index)
815 def GetCurrentNodeIndex(self):
816 return self.NodeIndex
818 def GetCurrentFilename(self):
819 return self.GetFilename(self.NodeIndex)
821 def GetAllFilenames(self):
822 indexes = self.UndoBuffers.keys()
824 return [self.GetFilename(idx) for idx in indexes]
826 def GetFilename(self, index):
827 if self.UndoBuffers[index].IsCurrentSaved():
828 return self.FileNames[index]
830 return "~%s~"%self.FileNames[index]
832 def SetCurrentFilePath(self, filepath):
833 self.FilePaths[self.NodeIndex] = filepath
835 self.LastNewIndex += 1
836 self.FileNames[self.NodeIndex] = "Unnamed%d"%self.LastNewIndex
838 self.FileNames[self.NodeIndex] = os.path.splitext(os.path.basename(filepath))[0]
840 def GetCurrentFilePath(self):
841 if len(self.FilePaths) > 0:
842 return self.FilePaths[self.NodeIndex]
846 def GetCurrentBufferState(self):
847 first = self.UndoBuffers[self.NodeIndex].IsFirst()
848 last = self.UndoBuffers[self.NodeIndex].IsLast()
849 return not first, not last
851 #-------------------------------------------------------------------------------
852 # Profiles Management Functions
853 #-------------------------------------------------------------------------------
855 def GetCurrentCommunicationLists(self):
857 for index in MappingDictionary.iterkeys():
858 if 0x1000 <= index < 0x1200:
860 return self.GetProfileLists(MappingDictionary, list)
862 def GetCurrentDS302Lists(self):
863 return self.GetSpecificProfileLists(self.CurrentNode.GetDS302Profile())
865 def GetCurrentProfileLists(self):
866 return self.GetSpecificProfileLists(self.CurrentNode.GetProfile())
868 def GetSpecificProfileLists(self, mappingdictionary):
871 for name, list in self.CurrentNode.GetSpecificMenu():
872 exclusionlist.extend(list)
873 for index in mappingdictionary.iterkeys():
874 if index not in exclusionlist:
875 validlist.append(index)
876 return self.GetProfileLists(mappingdictionary, validlist)
878 def GetProfileLists(self, mappingdictionary, list):
882 dictionary[index] = (mappingdictionary[index]["name"], mappingdictionary[index]["need"])
883 if self.CurrentNode.IsEntry(index):
884 current.append(index)
885 return dictionary, current
887 def GetCurrentNextMapIndex(self):
890 while self.CurrentNode.IsEntry(index) and index < 0x5FFF:
897 def CurrentDS302Defined(self):
899 return len(self.CurrentNode.GetDS302Profile()) > 0
902 #-------------------------------------------------------------------------------
903 # Node State and Values Functions
904 #-------------------------------------------------------------------------------
906 def GetCurrentNodeName(self):
908 return self.CurrentNode.GetNodeName()
912 def GetCurrentNodeCopy(self):
914 return self.CurrentNode.Copy()
918 def GetCurrentNodeID(self, node = None):
920 return self.CurrentNode.GetNodeID()
924 def GetCurrentNodeInfos(self):
925 name = self.CurrentNode.GetNodeName()
926 id = self.CurrentNode.GetNodeID()
927 type = self.CurrentNode.GetNodeType()
928 description = self.CurrentNode.GetNodeDescription()
929 return name, id, type, description
931 def SetCurrentNodeInfos(self, name, id, type, description):
932 self.CurrentNode.SetNodeName(name)
933 self.CurrentNode.SetNodeID(id)
934 self.CurrentNode.SetNodeType(type)
935 self.CurrentNode.SetNodeDescription(description)
936 self.BufferCurrentNode()
938 def GetCurrentNodeDefaultStringSize(self):
940 return self.CurrentNode.GetDefaultStringSize()
942 return Node.DefaultStringSize
944 def SetCurrentNodeDefaultStringSize(self, size):
946 self.CurrentNode.SetDefaultStringSize(size)
948 Node.DefaultStringSize = size
950 def GetCurrentProfileName(self):
952 return self.CurrentNode.GetProfileName()
955 def IsCurrentEntry(self, index):
957 return self.CurrentNode.IsEntry(index)
960 def GetCurrentEntry(self, index, subIndex = None, compute = True):
962 return self.CurrentNode.GetEntry(index, subIndex, compute)
965 def GetCurrentParamsEntry(self, index, subIndex = None):
967 return self.CurrentNode.GetParamsEntry(index, subIndex)
970 def GetCurrentValidIndexes(self, min, max):
972 for index in self.CurrentNode.GetIndexes():
973 if min <= index <= max:
974 validindexes.append((self.GetEntryName(index), index))
977 def GetCurrentValidChoices(self, min, max):
980 for menu, indexes in self.CurrentNode.GetSpecificMenu():
981 exclusionlist.extend(indexes)
983 for index in indexes:
984 good &= min <= index <= max
986 validchoices.append((menu, None))
987 list = [index for index in MappingDictionary.keys() if index >= 0x1000]
988 profiles = self.CurrentNode.GetMappings(False)
989 for profile in profiles:
990 list.extend(profile.keys())
993 if min <= index <= max and not self.CurrentNode.IsEntry(index) and index not in exclusionlist:
994 validchoices.append((self.GetEntryName(index), index))
997 def HasCurrentEntryCallbacks(self, index):
999 return self.CurrentNode.HasEntryCallbacks(index)
1002 def GetCurrentEntryValues(self, index):
1003 if self.CurrentNode:
1004 return self.GetNodeEntryValues(self.CurrentNode, index)
1006 def GetNodeEntryValues(self, node, index):
1007 if node and node.IsEntry(index):
1008 entry_infos = node.GetEntryInfos(index)
1011 values = node.GetEntry(index, compute = False)
1012 params = node.GetParamsEntry(index)
1013 if type(values) == ListType:
1014 for i, value in enumerate(values):
1015 data.append({"value" : value})
1016 data[-1].update(params[i])
1018 data.append({"value" : values})
1019 data[-1].update(params)
1020 for i, dic in enumerate(data):
1021 infos = node.GetSubentryInfos(index, i)
1022 dic["subindex"] = "0x%02X"%i
1023 dic["name"] = infos["name"]
1024 dic["type"] = node.GetTypeName(infos["type"])
1025 dic["access"] = AccessType[infos["access"]]
1026 dic["save"] = OptionType[dic["save"]]
1027 editor = {"subindex" : None, "save" : "option", "callback" : "option", "comment" : "string"}
1028 if type(values) == ListType and i == 0:
1029 editor["name"] = None
1030 editor["type"] = None
1031 if 0x1600 <= index <= 0x17FF or 0x1A00 <= index <= 0x1C00:
1032 editor["access"] = "raccess"
1034 editor["access"] = None
1035 editor["value"] = None
1037 if infos["user_defined"]:
1038 if entry_infos["struct"] & OD_IdenticalSubindexes:
1039 editor["name"] = None
1041 editor["type"] = None
1042 editor["access"] = None
1044 editor["type"] = "type"
1045 editor["access"] = "access"
1047 if entry_infos["struct"] & OD_MultipleSubindexes:
1048 editor["name"] = "string"
1050 editor["name"] = None
1051 editor["type"] = "type"
1052 editor["access"] = "access"
1054 editor["name"] = None
1055 editor["type"] = None
1056 editor["access"] = None
1058 editor["value"] = None
1060 dic["value"] = node.GetTypeName(dic["value"])
1061 elif 0x1600 <= index <= 0x17FF or 0x1A00 <= index <= 0x1C00:
1062 editor["value"] = "map"
1063 dic["value"] = node.GetMapName(dic["value"])
1065 if dic["type"].startswith("VISIBLE_STRING") or dic["type"].startswith("OCTET_STRING"):
1066 editor["value"] = "string"
1067 elif dic["type"] in ["TIME_OF_DAY","TIME_DIFFERENCE"]:
1068 editor["value"] = "time"
1069 elif dic["type"] == "DOMAIN":
1071 editor["value"] = "dcf"
1073 editor["value"] = "domain"
1074 dic["value"] = dic["value"].encode('hex_codec')
1075 elif dic["type"] == "BOOLEAN":
1076 editor["value"] = "bool"
1077 dic["value"] = BoolType[dic["value"]]
1078 result = type_model.match(dic["type"])
1080 values = result.groups()
1081 if values[0] == "UNSIGNED":
1083 format = "0x%0" + str(int(values[1])/4) + "X"
1084 dic["value"] = format%dic["value"]
1087 editor["value"] = "string"
1088 if values[0] == "INTEGER":
1089 editor["value"] = "number"
1090 elif values[0] == "REAL":
1091 editor["value"] = "float"
1092 elif values[0] in ["VISIBLE_STRING", "OCTET_STRING"]:
1093 editor["length"] = values[0]
1094 result = range_model.match(dic["type"])
1096 values = result.groups()
1097 if values[0] in ["UNSIGNED", "INTEGER", "REAL"]:
1098 editor["min"] = values[2]
1099 editor["max"] = values[3]
1100 editors.append(editor)
1101 return data, editors
1105 def AddToDCF(self, node_id, index, subindex, size, value):
1106 if self.CurrentNode.IsEntry(0x1F22, node_id):
1107 dcf_value = self.CurrentNode.GetEntry(0x1F22, node_id)
1109 nbparams = BE_to_LE(dcf_value[:4])
1112 new_value = LE_to_BE(nbparams + 1, 4) + dcf_value[4:]
1113 new_value += LE_to_BE(index, 2) + LE_to_BE(subindex, 1) + LE_to_BE(size, 4) + LE_to_BE(value, size)
1114 self.CurrentNode.SetEntry(0x1F22, node_id, new_value)
1116 #-------------------------------------------------------------------------------
1117 # Node Informations Functions
1118 #-------------------------------------------------------------------------------
1120 def GetCustomisedTypeValues(self, index):
1121 if self.CurrentNode:
1122 values = self.CurrentNode.GetEntry(index)
1123 customisabletypes = self.GetCustomisableTypes()
1124 return values, customisabletypes[values[1]][1]
1128 def GetEntryName(self, index):
1129 if self.CurrentNode:
1130 return self.CurrentNode.GetEntryName(index)
1132 return FindEntryName(index, MappingDictionary)
1134 def GetEntryInfos(self, index):
1135 if self.CurrentNode:
1136 return self.CurrentNode.GetEntryInfos(index)
1138 return FindEntryInfos(index, MappingDictionary)
1140 def GetSubentryInfos(self, index, subindex):
1141 if self.CurrentNode:
1142 return self.CurrentNode.GetSubentryInfos(index, subindex)
1144 result = FindSubentryInfos(index, subindex, MappingDictionary)
1146 result["user_defined"] = False
1149 def GetTypeIndex(self, typename):
1150 if self.CurrentNode:
1151 return self.CurrentNode.GetTypeIndex(typename)
1153 return FindTypeIndex(typename, MappingDictionary)
1155 def GetTypeName(self, typeindex):
1156 if self.CurrentNode:
1157 return self.CurrentNode.GetTypeName(typeindex)
1159 return FindTypeName(typeindex, MappingDictionary)
1161 def GetTypeDefaultValue(self, typeindex):
1162 if self.CurrentNode:
1163 return self.CurrentNode.GetTypeDefaultValue(typeindex)
1165 return FindTypeDefaultValue(typeindex, MappingDictionary)
1167 def GetMapVariableList(self):
1168 if self.CurrentNode:
1169 return self.CurrentNode.GetMapVariableList()
1173 def GetMandatoryIndexes(self):
1174 if self.CurrentNode:
1175 return self.CurrentNode.GetMandatoryIndexes()
1177 return FindMandatoryIndexes(MappingDictionary)
1179 def GetCustomisableTypes(self):
1181 for index, valuetype in CustomisableTypes:
1182 name = self.GetTypeName(index)
1183 dic[index] = [name, valuetype]
1186 def GetCurrentSpecificMenu(self):
1187 if self.CurrentNode:
1188 return self.CurrentNode.GetSpecificMenu()