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()
204 if NMT == "NodeGuarding":
205 AddIndexList.extend([0x100C, 0x100D])
206 elif NMT == "Heartbeat":
207 AddIndexList.append(0x1017)
208 for option in options:
209 if option == "DS302":
210 DS302Path = os.path.join(os.path.split(__file__)[0], "config/DS-302.prf")
211 # Charging DS-302 profile if choosen by user
212 if os.path.isfile(DS302Path):
215 self.CurrentNode.SetDS302Profile(Mapping)
216 self.CurrentNode.ExtendSpecificMenu(AddMenuEntries)
218 return "Problem with DS-302! Syntax Error."
220 return "Couldn't find DS-302 in 'config' folder!"
221 elif option == "GenSYNC":
222 AddIndexList.extend([0x1005, 0x1006])
223 elif option == "Emergency":
224 AddIndexList.append(0x1014)
225 elif option == "SaveConfig":
226 AddIndexList.extend([0x1010, 0x1011, 0x1020])
227 elif option == "StoreEDS":
228 AddIndexList.extend([0x1021, 0x1022])
230 # add default SDO server
231 AddIndexList.append(0x1200)
232 # add default 4 receive and 4 transmit PDO
233 for comm, mapping in [(0x1400, 0x1600),(0x1800, 0x1A00)]:
234 firstparamindex = self.GetLineFromIndex(comm)
235 firstmappingindex = self.GetLineFromIndex(mapping)
236 AddIndexList.extend(range(firstparamindex, firstparamindex + 4))
237 for idx in range(firstmappingindex, firstmappingindex + 4):
238 AddIndexList.append(idx)
239 AddSubIndexList.append((idx, 8))
241 index = self.AddNodeBuffer(self.CurrentNode.Copy(), False)
242 self.SetCurrentFilePath("")
243 # Add Mandatory indexes
244 self.ManageEntriesOfCurrent(AddIndexList, [])
245 for idx, num in AddSubIndexList:
246 self.AddSubentriesToCurrent(idx, num)
252 Load a profile in node
254 def LoadProfile(self, profile, filepath, node):
255 if profile != "None":
256 # Try to charge the profile given
259 node.SetProfileName(profile)
260 node.SetProfile(Mapping)
261 node.SetSpecificMenu(AddMenuEntries)
264 return "Syntax Error\nBad OD Profile file!"
267 node.SetProfileName("None")
269 node.SetSpecificMenu([])
273 Open a file and store it in a new buffer
275 def OpenFileInCurrent(self, filepath):
278 file = open(filepath, "r")
281 self.CurrentNode = node
282 self.CurrentNode.SetNodeID(0)
283 # Add a new buffer and defining current state
284 index = self.AddNodeBuffer(self.CurrentNode.Copy(), True)
285 self.SetCurrentFilePath(filepath)
288 return "Unable to load file \"%s\"!"%filepath
291 Save current node in a file
293 def SaveCurrentInFile(self, filepath = None):
294 # if no filepath given, verify if current node has a filepath defined
296 filepath = self.GetCurrentFilePath()
300 file = open(filepath, "w")
301 dump(self.CurrentNode, file)
303 self.SetCurrentFilePath(filepath)
304 # Update saved state in buffer
305 self.UndoBuffers[self.NodeIndex].CurrentSaved()
311 def CloseCurrent(self, ignore = False):
312 # Verify if it's not forced that the current node is saved before closing it
313 if self.NodeIndex in self.UndoBuffers and (self.UndoBuffers[self.NodeIndex].IsCurrentSaved() or ignore):
314 self.RemoveNodeBuffer(self.NodeIndex)
315 if len(self.UndoBuffers) > 0:
316 previousindexes = [idx for idx in self.UndoBuffers.keys() if idx < self.NodeIndex]
317 nextindexes = [idx for idx in self.UndoBuffers.keys() if idx > self.NodeIndex]
318 if len(previousindexes) > 0:
319 previousindexes.sort()
320 self.NodeIndex = previousindexes[-1]
321 elif len(nextindexes) > 0:
323 self.NodeIndex = nextindexes[0]
325 self.NodeIndex = None
327 self.NodeIndex = None
332 Import an eds file and store it in a new buffer if no node edited
334 def ImportCurrentFromEDSFile(self, filepath):
335 # Generate node from definition in a xml file
336 result = eds_utils.GenerateNode(filepath)
337 if isinstance(result, Node):
338 self.CurrentNode = result
339 index = self.AddNodeBuffer(self.CurrentNode.Copy(), False)
340 self.SetCurrentFilePath("")
346 Export to an eds file and store it in a new buffer if no node edited
348 def ExportCurrentToEDSFile(self, filepath):
349 return eds_utils.GenerateEDSFile(filepath, self.CurrentNode)
352 Build the C definition of Object Dictionary for current node
354 def ExportCurrentToCFile(self, filepath):
356 return gen_cfile.GenerateFile(filepath, self.CurrentNode)
358 #-------------------------------------------------------------------------------
359 # Add Entries to Current Functions
360 #-------------------------------------------------------------------------------
363 Add the specified number of subentry for the given entry. Verify that total
364 number of subentry (except 0) doesn't exceed nbmax defined
366 def AddSubentriesToCurrent(self, index, number, node = None):
367 disable_buffer = node != None
369 node = self.CurrentNode
370 # Informations about entry
371 length = node.GetEntry(index, 0)
372 infos = node.GetEntryInfos(index)
373 subentry_infos = node.GetSubentryInfos(index, 1)
374 # Get default value for subindex
375 if "default" in subentry_infos:
376 default = subentry_infos["default"]
378 default = self.GetTypeDefaultValue(subentry_infos["type"])
379 # First case entry is record
380 if infos["struct"] & OD_IdenticalSubindexes:
381 for i in xrange(1, min(number,subentry_infos["nbmax"]-length) + 1):
382 node.AddEntry(index, length + i, default)
383 if not disable_buffer:
384 self.BufferCurrentNode()
386 # Second case entry is array, only possible for manufacturer specific
387 elif infos["struct"] & OD_MultipleSubindexes and 0x2000 <= index <= 0x5FFF:
388 values = {"name" : "Undefined", "type" : 5, "access" : "rw", "pdo" : True}
389 for i in xrange(1, min(number,0xFE-length) + 1):
390 node.AddMappingEntry(index, length + i, values = values.copy())
391 node.AddEntry(index, length + i, 0)
392 if not disable_buffer:
393 self.BufferCurrentNode()
398 Remove the specified number of subentry for the given entry. Verify that total
399 number of subentry (except 0) isn't less than 1
401 def RemoveSubentriesFromCurrent(self, index, number):
402 # Informations about entry
403 infos = self.GetEntryInfos(index)
404 length = self.CurrentNode.GetEntry(index, 0)
406 nbmin = infos["nbmin"]
409 # Entry is a record, or is an array of manufacturer specific
410 if infos["struct"] & OD_IdenticalSubindexes or 0x2000 <= index <= 0x5FFF and infos["struct"] & OD_IdenticalSubindexes:
411 for i in xrange(min(number, length - nbmin)):
412 self.RemoveCurrentVariable(index, length - i)
413 self.BufferCurrentNode()
416 Add a SDO Server to current node
418 def AddSDOServerToCurrent(self):
419 # An SDO Server is already defined at index 0x1200
420 if self.CurrentNode.IsEntry(0x1200):
421 indexlist = [self.GetLineFromIndex(0x1201)]
422 if None not in indexlist:
423 self.ManageEntriesOfCurrent(indexlist, [])
424 # Add an SDO Server at index 0x1200
426 self.ManageEntriesOfCurrent([0x1200], [])
429 Add a SDO Server to current node
431 def AddSDOClientToCurrent(self):
432 indexlist = [self.GetLineFromIndex(0x1280)]
433 if None not in indexlist:
434 self.ManageEntriesOfCurrent(indexlist, [])
437 Add a Transmit PDO to current node
439 def AddPDOTransmitToCurrent(self):
440 indexlist = [self.GetLineFromIndex(0x1800),self.GetLineFromIndex(0x1A00)]
441 if None not in indexlist:
442 self.ManageEntriesOfCurrent(indexlist, [])
445 Add a Receive PDO to current node
447 def AddPDOReceiveToCurrent(self):
448 indexlist = [self.GetLineFromIndex(0x1400),self.GetLineFromIndex(0x1600)]
449 if None not in indexlist:
450 self.ManageEntriesOfCurrent(indexlist, [])
453 Add a list of entries defined in profile for menu item selected to current node
455 def AddSpecificEntryToCurrent(self, menuitem):
457 for menu, indexes in self.CurrentNode.GetSpecificMenu():
459 for index in indexes:
460 indexlist.append(self.GetLineFromIndex(index))
461 if None not in indexlist:
462 self.ManageEntriesOfCurrent(indexlist, [])
465 Search the first index available for a pluri entry from base_index
467 def GetLineFromIndex(self, base_index):
470 infos = self.GetEntryInfos(base_index)
471 while index < base_index + infos["incr"]*infos["nbmax"] and not found:
472 if not self.CurrentNode.IsEntry(index):
475 index += infos["incr"]
481 Add entries specified in addinglist and remove entries specified in removinglist
483 def ManageEntriesOfCurrent(self, addinglist, removinglist, node = None):
484 disable_buffer = node != None
486 node = self.CurrentNode
487 # Add all the entries in addinglist
488 for index in addinglist:
489 infos = self.GetEntryInfos(index)
490 if infos["struct"] & OD_MultipleSubindexes:
491 # First case entry is a record
492 if infos["struct"] & OD_IdenticalSubindexes:
493 subentry_infos = self.GetSubentryInfos(index, 1)
494 if "default" in subentry_infos:
495 default = subentry_infos["default"]
497 default = self.GetTypeDefaultValue(subentry_infos["type"])
498 node.AddEntry(index, value = [])
499 if "nbmin" in subentry_infos:
500 for i in xrange(subentry_infos["nbmin"]):
501 node.AddEntry(index, i + 1, default)
503 node.AddEntry(index, 1, default)
504 # Second case entry is a record
507 subentry_infos = self.GetSubentryInfos(index, i)
508 while subentry_infos:
509 if "default" in subentry_infos:
510 default = subentry_infos["default"]
512 default = self.GetTypeDefaultValue(subentry_infos["type"])
513 node.AddEntry(index, i, default)
515 subentry_infos = self.GetSubentryInfos(index, i)
516 # Third case entry is a record
518 subentry_infos = self.GetSubentryInfos(index, 0)
519 if "default" in subentry_infos:
520 default = subentry_infos["default"]
522 default = self.GetTypeDefaultValue(subentry_infos["type"])
523 node.AddEntry(index, 0, default)
524 # Remove all the entries in removinglist
525 for index in removinglist:
526 self.RemoveCurrentVariable(index)
527 if not disable_buffer:
528 self.BufferCurrentNode()
533 Reset an subentry from current node to its default value
535 def SetCurrentEntryToDefault(self, index, subindex, node = None):
536 disable_buffer = node != None
538 node = self.CurrentNode
539 if node.IsEntry(index, subindex):
540 subentry_infos = self.GetSubentryInfos(index, subindex)
541 if "default" in subentry_infos:
542 default = subentry_infos["default"]
544 default = self.GetTypeDefaultValue(subentry_infos["type"])
545 node.SetEntry(index, subindex, default)
546 if not disable_buffer:
547 self.BufferCurrentNode()
550 Remove an entry from current node. Analize the index to perform the correct
553 def RemoveCurrentVariable(self, index, subIndex = None):
554 Mappings = self.CurrentNode.GetMappings()
555 if index < 0x1000 and subIndex == None:
556 type = self.CurrentNode.GetEntry(index, 1)
557 for i in Mappings[-1]:
558 for value in Mappings[-1][i]["values"]:
559 if value["type"] == index:
561 self.CurrentNode.RemoveMappingEntry(index)
562 self.CurrentNode.RemoveEntry(index)
563 elif index == 0x1200 and subIndex == None:
564 self.CurrentNode.RemoveEntry(0x1200)
565 elif 0x1201 <= index <= 0x127F and subIndex == None:
566 self.CurrentNode.RemoveLine(index, 0x127F)
567 elif 0x1280 <= index <= 0x12FF and subIndex == None:
568 self.CurrentNode.RemoveLine(index, 0x12FF)
569 elif 0x1400 <= index <= 0x15FF or 0x1600 <= index <= 0x17FF and subIndex == None:
570 if 0x1600 <= index <= 0x17FF and subIndex == None:
572 self.CurrentNode.RemoveLine(index, 0x15FF)
573 self.CurrentNode.RemoveLine(index + 0x200, 0x17FF)
574 elif 0x1800 <= index <= 0x19FF or 0x1A00 <= index <= 0x1BFF and subIndex == None:
575 if 0x1A00 <= index <= 0x1BFF:
577 self.CurrentNode.RemoveLine(index, 0x19FF)
578 self.CurrentNode.RemoveLine(index + 0x200, 0x1BFF)
581 for menu,list in self.CurrentNode.GetSpecificMenu():
583 iinfos = self.GetEntryInfos(i)
584 indexes = [i + incr * iinfos["incr"] for incr in xrange(iinfos["nbmax"])]
589 jinfos = self.GetEntryInfos(j)
590 self.CurrentNode.RemoveLine(j + diff, j + jinfos["incr"]*jinfos["nbmax"], jinfos["incr"])
591 self.CurrentNode.RemoveMapVariable(index, subIndex)
593 infos = self.GetEntryInfos(index)
594 if not infos["need"]:
595 self.CurrentNode.RemoveEntry(index, subIndex)
596 if index in Mappings[-1]:
597 self.CurrentNode.RemoveMappingEntry(index, subIndex)
599 def AddMapVariableToCurrent(self, index, name, struct, number, node = None):
600 if 0x2000 <= index <= 0x5FFF:
601 disable_buffer = node != None
603 node = self.CurrentNode
604 if not node.IsEntry(index):
605 node.AddMappingEntry(index, name = name, struct = struct)
607 values = {"name" : name, "type" : 0x05, "access" : "rw", "pdo" : True}
608 node.AddMappingEntry(index, 0, values = values)
609 node.AddEntry(index, 0, 0)
611 values = {"name" : "Number of Entries", "type" : 0x05, "access" : "ro", "pdo" : False}
612 node.AddMappingEntry(index, 0, values = values)
614 values = {"name" : name + " %d[(sub)]", "type" : 0x05, "access" : "rw", "pdo" : True, "nbmax" : 0xFE}
615 node.AddMappingEntry(index, 1, values = values)
616 for i in xrange(number):
617 node.AddEntry(index, i + 1, 0)
619 for i in xrange(number):
620 values = {"name" : "Undefined", "type" : 0x05, "access" : "rw", "pdo" : True}
621 node.AddMappingEntry(index, i + 1, values = values)
622 node.AddEntry(index, i + 1, 0)
623 if not disable_buffer:
624 self.BufferCurrentNode()
627 return "Index 0x%04X already defined!"%index
629 return "Index 0x%04X isn't a valid index for Map Variable!"%index
631 def AddUserTypeToCurrent(self, type, min, max, length):
633 while index < 0x100 and self.CurrentNode.IsEntry(index):
636 customisabletypes = self.GetCustomisableTypes()
637 name, valuetype = customisabletypes[type]
638 size = self.GetEntryInfos(type)["size"]
639 default = self.GetTypeDefaultValue(type)
641 self.CurrentNode.AddMappingEntry(index, name = "%s[%d-%d]"%(name, min, max), struct = 3, size = size, default = default)
642 self.CurrentNode.AddMappingEntry(index, 0, values = {"name" : "Number of Entries", "type" : 0x05, "access" : "ro", "pdo" : False})
643 self.CurrentNode.AddMappingEntry(index, 1, values = {"name" : "Type", "type" : 0x05, "access" : "ro", "pdo" : False})
644 self.CurrentNode.AddMappingEntry(index, 2, values = {"name" : "Minimum Value", "type" : type, "access" : "ro", "pdo" : False})
645 self.CurrentNode.AddMappingEntry(index, 3, values = {"name" : "Maximum Value", "type" : type, "access" : "ro", "pdo" : False})
646 self.CurrentNode.AddEntry(index, 1, type)
647 self.CurrentNode.AddEntry(index, 2, min)
648 self.CurrentNode.AddEntry(index, 3, max)
650 self.CurrentNode.AddMappingEntry(index, name = "%s%d"%(name, length), struct = 3, size = length * size, default = default)
651 self.CurrentNode.AddMappingEntry(index, 0, values = {"name" : "Number of Entries", "type" : 0x05, "access" : "ro", "pdo" : False})
652 self.CurrentNode.AddMappingEntry(index, 1, values = {"name" : "Type", "type" : 0x05, "access" : "ro", "pdo" : False})
653 self.CurrentNode.AddMappingEntry(index, 2, values = {"name" : "Length", "type" : 0x05, "access" : "ro", "pdo" : False})
654 self.CurrentNode.AddEntry(index, 1, type)
655 self.CurrentNode.AddEntry(index, 2, length)
656 self.BufferCurrentNode()
659 return "Too many User Types have already been defined!"
661 #-------------------------------------------------------------------------------
662 # Modify Entry and Mapping Functions
663 #-------------------------------------------------------------------------------
665 def SetCurrentEntryCallbacks(self, index, value):
666 if self.CurrentNode and self.CurrentNode.IsEntry(index):
667 entry_infos = self.GetEntryInfos(index)
668 if "callback" not in entry_infos:
669 self.CurrentNode.SetParamsEntry(index, None, callback = value)
670 self.BufferCurrentNode()
672 def SetCurrentEntry(self, index, subIndex, value, name, editor, node = None):
673 disable_buffer = node != None
675 node = self.CurrentNode
676 if node and node.IsEntry(index):
679 value = node.GetMapValue(value)
681 node.SetEntry(index, subIndex, value)
682 elif editor == "bool":
683 value = value == "True"
684 node.SetEntry(index, subIndex, value)
685 elif editor == "time":
686 node.SetEntry(index, subIndex, value)
687 elif editor == "number":
689 node.SetEntry(index, subIndex, int(value))
692 elif editor == "float":
694 node.SetEntry(index, subIndex, float(value))
697 elif editor == "domain":
699 if len(value) % 2 != 0:
701 value = value.decode('hex_codec')
702 node.SetEntry(index, subIndex, value)
705 elif editor == "dcf":
706 node.SetEntry(index, subIndex, value)
708 subentry_infos = self.GetSubentryInfos(index, subIndex)
709 type = subentry_infos["type"]
711 for typeindex, typevalue in CustomisableTypes:
712 dic[typeindex] = typevalue
714 type = node.GetEntry(type)[1]
717 if value.startswith("$NODEID"):
718 value = "\"%s\""%value
719 elif value.startswith("0x"):
720 value = int(value, 16)
723 node.SetEntry(index, subIndex, value)
727 node.SetEntry(index, subIndex, value)
728 elif name in ["comment", "save"]:
729 if editor == "option":
730 value = value == "Yes"
732 node.SetParamsEntry(index, subIndex, save = value)
733 elif name == "comment":
734 node.SetParamsEntry(index, subIndex, comment = value)
737 value = self.GetTypeIndex(value)
738 size = self.GetEntryInfos(value)["size"]
739 node.UpdateMapVariable(index, subIndex, size)
740 elif editor in ["access","raccess"]:
742 for abbrev,access in AccessType.iteritems():
745 if editor == "raccess" and not node.IsMappingEntry(index):
746 entry_infos = self.GetEntryInfos(index)
747 node.AddMappingEntry(index, name = entry_infos["name"], struct = 7)
748 node.AddMappingEntry(index, 0, values = self.GetSubentryInfos(index, 0, False).copy())
749 node.AddMappingEntry(index, 1, values = self.GetSubentryInfos(index, 1, False).copy())
750 node.SetMappingEntry(index, subIndex, values = {name : value})
751 if not disable_buffer:
752 self.BufferCurrentNode()
755 def SetCurrentEntryName(self, index, name):
756 self.CurrentNode.SetMappingEntry(index, name=name)
757 self.BufferCurrentNode()
759 def SetCurrentUserType(self, index, type, min, max, length):
760 customisabletypes = self.GetCustomisableTypes()
761 values, valuetype = self.GetCustomisedTypeValues(index)
762 name, new_valuetype = customisabletypes[type]
763 size = self.GetEntryInfos(type)["size"]
764 default = self.GetTypeDefaultValue(type)
765 if new_valuetype == 0:
766 self.CurrentNode.SetMappingEntry(index, name = "%s[%d-%d]"%(name, min, max), struct = 3, size = size, default = default)
768 self.CurrentNode.SetMappingEntry(index, 2, values = {"name" : "Minimum Value", "type" : type, "access" : "ro", "pdo" : False})
769 self.CurrentNode.AddMappingEntry(index, 3, values = {"name" : "Maximum Value", "type" : type, "access" : "ro", "pdo" : False})
770 self.CurrentNode.SetEntry(index, 1, type)
771 self.CurrentNode.SetEntry(index, 2, min)
773 self.CurrentNode.AddEntry(index, 3, max)
775 self.CurrentNode.SetEntry(index, 3, max)
776 elif new_valuetype == 1:
777 self.CurrentNode.SetMappingEntry(index, name = "%s%d"%(name, length), struct = 3, size = size, default = default)
779 self.CurrentNode.SetMappingEntry(index, 2, values = {"name" : "Length", "type" : 0x02, "access" : "ro", "pdo" : False})
780 self.CurrentNode.RemoveMappingEntry(index, 3)
781 self.CurrentNode.SetEntry(index, 1, type)
782 self.CurrentNode.SetEntry(index, 2, length)
784 self.CurrentNode.RemoveEntry(index, 3)
785 self.BufferCurrentNode()
787 #-------------------------------------------------------------------------------
788 # Current Buffering Management Functions
789 #-------------------------------------------------------------------------------
791 def BufferCurrentNode(self):
792 self.UndoBuffers[self.NodeIndex].Buffering(self.CurrentNode.Copy())
794 def CurrentIsSaved(self):
795 return self.UndoBuffers[self.NodeIndex].IsCurrentSaved()
797 def OneFileHasChanged(self):
799 for buffer in self.UndoBuffers.values():
800 result |= not buffer.IsCurrentSaved()
803 def GetBufferNumber(self):
804 return len(self.UndoBuffers)
806 def GetBufferIndexes(self):
807 return self.UndoBuffers.keys()
809 def LoadCurrentPrevious(self):
810 self.CurrentNode = self.UndoBuffers[self.NodeIndex].Previous().Copy()
812 def LoadCurrentNext(self):
813 self.CurrentNode = self.UndoBuffers[self.NodeIndex].Next().Copy()
815 def AddNodeBuffer(self, currentstate = None, issaved = False):
816 self.NodeIndex = GetNewId()
817 self.UndoBuffers[self.NodeIndex] = UndoBuffer(currentstate, issaved)
818 self.FilePaths[self.NodeIndex] = ""
819 self.FileNames[self.NodeIndex] = ""
820 return self.NodeIndex
822 def ChangeCurrentNode(self, index):
823 if index in self.UndoBuffers.keys():
824 self.NodeIndex = index
825 self.CurrentNode = self.UndoBuffers[self.NodeIndex].Current().Copy()
827 def RemoveNodeBuffer(self, index):
828 self.UndoBuffers.pop(index)
829 self.FilePaths.pop(index)
830 self.FileNames.pop(index)
832 def GetCurrentNodeIndex(self):
833 return self.NodeIndex
835 def GetCurrentFilename(self):
836 return self.GetFilename(self.NodeIndex)
838 def GetAllFilenames(self):
839 indexes = self.UndoBuffers.keys()
841 return [self.GetFilename(idx) for idx in indexes]
843 def GetFilename(self, index):
844 if self.UndoBuffers[index].IsCurrentSaved():
845 return self.FileNames[index]
847 return "~%s~"%self.FileNames[index]
849 def SetCurrentFilePath(self, filepath):
850 self.FilePaths[self.NodeIndex] = filepath
852 self.LastNewIndex += 1
853 self.FileNames[self.NodeIndex] = "Unnamed%d"%self.LastNewIndex
855 self.FileNames[self.NodeIndex] = os.path.splitext(os.path.basename(filepath))[0]
857 def GetCurrentFilePath(self):
858 if len(self.FilePaths) > 0:
859 return self.FilePaths[self.NodeIndex]
863 def GetCurrentBufferState(self):
864 first = self.UndoBuffers[self.NodeIndex].IsFirst()
865 last = self.UndoBuffers[self.NodeIndex].IsLast()
866 return not first, not last
868 #-------------------------------------------------------------------------------
869 # Profiles Management Functions
870 #-------------------------------------------------------------------------------
872 def GetCurrentCommunicationLists(self):
874 for index in MappingDictionary.iterkeys():
875 if 0x1000 <= index < 0x1200:
877 return self.GetProfileLists(MappingDictionary, list)
879 def GetCurrentDS302Lists(self):
880 return self.GetSpecificProfileLists(self.CurrentNode.GetDS302Profile())
882 def GetCurrentProfileLists(self):
883 return self.GetSpecificProfileLists(self.CurrentNode.GetProfile())
885 def GetSpecificProfileLists(self, mappingdictionary):
888 for name, list in self.CurrentNode.GetSpecificMenu():
889 exclusionlist.extend(list)
890 for index in mappingdictionary.iterkeys():
891 if index not in exclusionlist:
892 validlist.append(index)
893 return self.GetProfileLists(mappingdictionary, validlist)
895 def GetProfileLists(self, mappingdictionary, list):
899 dictionary[index] = (mappingdictionary[index]["name"], mappingdictionary[index]["need"])
900 if self.CurrentNode.IsEntry(index):
901 current.append(index)
902 return dictionary, current
904 def GetCurrentNextMapIndex(self):
907 while self.CurrentNode.IsEntry(index) and index < 0x5FFF:
914 def CurrentDS302Defined(self):
916 return len(self.CurrentNode.GetDS302Profile()) > 0
919 #-------------------------------------------------------------------------------
920 # Node State and Values Functions
921 #-------------------------------------------------------------------------------
923 def GetCurrentNodeName(self):
925 return self.CurrentNode.GetNodeName()
929 def GetCurrentNodeCopy(self):
931 return self.CurrentNode.Copy()
935 def GetCurrentNodeID(self, node = None):
937 return self.CurrentNode.GetNodeID()
941 def GetCurrentNodeInfos(self):
942 name = self.CurrentNode.GetNodeName()
943 id = self.CurrentNode.GetNodeID()
944 type = self.CurrentNode.GetNodeType()
945 description = self.CurrentNode.GetNodeDescription()
946 return name, id, type, description
948 def SetCurrentNodeInfos(self, name, id, type, description):
949 self.CurrentNode.SetNodeName(name)
950 self.CurrentNode.SetNodeID(id)
951 self.CurrentNode.SetNodeType(type)
952 self.CurrentNode.SetNodeDescription(description)
953 self.BufferCurrentNode()
955 def GetCurrentNodeDefaultStringSize(self):
957 return self.CurrentNode.GetDefaultStringSize()
959 return Node.DefaultStringSize
961 def SetCurrentNodeDefaultStringSize(self, size):
963 self.CurrentNode.SetDefaultStringSize(size)
965 Node.DefaultStringSize = size
967 def GetCurrentProfileName(self):
969 return self.CurrentNode.GetProfileName()
972 def IsCurrentEntry(self, index):
974 return self.CurrentNode.IsEntry(index)
977 def GetCurrentEntry(self, index, subIndex = None, compute = True):
979 return self.CurrentNode.GetEntry(index, subIndex, compute)
982 def GetCurrentParamsEntry(self, index, subIndex = None):
984 return self.CurrentNode.GetParamsEntry(index, subIndex)
987 def GetCurrentValidIndexes(self, min, max):
989 for index in self.CurrentNode.GetIndexes():
990 if min <= index <= max:
991 validindexes.append((self.GetEntryName(index), index))
994 def GetCurrentValidChoices(self, min, max):
997 for menu, indexes in self.CurrentNode.GetSpecificMenu():
998 exclusionlist.extend(indexes)
1000 for index in indexes:
1001 good &= min <= index <= max
1003 validchoices.append((menu, None))
1004 list = [index for index in MappingDictionary.keys() if index >= 0x1000]
1005 profiles = self.CurrentNode.GetMappings(False)
1006 for profile in profiles:
1007 list.extend(profile.keys())
1010 if min <= index <= max and not self.CurrentNode.IsEntry(index) and index not in exclusionlist:
1011 validchoices.append((self.GetEntryName(index), index))
1014 def HasCurrentEntryCallbacks(self, index):
1015 if self.CurrentNode:
1016 return self.CurrentNode.HasEntryCallbacks(index)
1019 def GetCurrentEntryValues(self, index):
1020 if self.CurrentNode:
1021 return self.GetNodeEntryValues(self.CurrentNode, index)
1023 def GetNodeEntryValues(self, node, index):
1024 if node and node.IsEntry(index):
1025 entry_infos = node.GetEntryInfos(index)
1028 values = node.GetEntry(index, compute = False)
1029 params = node.GetParamsEntry(index)
1030 if isinstance(values, ListType):
1031 for i, value in enumerate(values):
1032 data.append({"value" : value})
1033 data[-1].update(params[i])
1035 data.append({"value" : values})
1036 data[-1].update(params)
1037 for i, dic in enumerate(data):
1038 infos = node.GetSubentryInfos(index, i)
1039 dic["subindex"] = "0x%02X"%i
1040 dic["name"] = infos["name"]
1041 dic["type"] = node.GetTypeName(infos["type"])
1042 dic["access"] = AccessType[infos["access"]]
1043 dic["save"] = OptionType[dic["save"]]
1044 editor = {"subindex" : None, "save" : "option", "callback" : "option", "comment" : "string"}
1045 if isinstance(values, ListType) and i == 0:
1046 editor["name"] = None
1047 editor["type"] = None
1048 if 0x1600 <= index <= 0x17FF or 0x1A00 <= index <= 0x1C00:
1049 editor["access"] = "raccess"
1051 editor["access"] = None
1052 editor["value"] = None
1054 if infos["user_defined"]:
1055 if entry_infos["struct"] & OD_IdenticalSubindexes:
1056 editor["name"] = None
1058 editor["type"] = None
1059 editor["access"] = None
1061 editor["type"] = "type"
1062 editor["access"] = "access"
1064 if entry_infos["struct"] & OD_MultipleSubindexes:
1065 editor["name"] = "string"
1067 editor["name"] = None
1068 editor["type"] = "type"
1069 editor["access"] = "access"
1071 editor["name"] = None
1072 editor["type"] = None
1073 editor["access"] = None
1075 editor["value"] = None
1077 dic["value"] = node.GetTypeName(dic["value"])
1078 elif 0x1600 <= index <= 0x17FF or 0x1A00 <= index <= 0x1C00:
1079 editor["value"] = "map"
1080 dic["value"] = node.GetMapName(dic["value"])
1082 if dic["type"].startswith("VISIBLE_STRING") or dic["type"].startswith("OCTET_STRING"):
1083 editor["value"] = "string"
1084 elif dic["type"] in ["TIME_OF_DAY","TIME_DIFFERENCE"]:
1085 editor["value"] = "time"
1086 elif dic["type"] == "DOMAIN":
1088 editor["value"] = "dcf"
1090 editor["value"] = "domain"
1091 dic["value"] = dic["value"].encode('hex_codec')
1092 elif dic["type"] == "BOOLEAN":
1093 editor["value"] = "bool"
1094 dic["value"] = BoolType[dic["value"]]
1095 result = type_model.match(dic["type"])
1097 values = result.groups()
1098 if values[0] == "UNSIGNED":
1100 format = "0x%0" + str(int(values[1])/4) + "X"
1101 dic["value"] = format%dic["value"]
1104 editor["value"] = "string"
1105 if values[0] == "INTEGER":
1106 editor["value"] = "number"
1107 elif values[0] == "REAL":
1108 editor["value"] = "float"
1109 elif values[0] in ["VISIBLE_STRING", "OCTET_STRING"]:
1110 editor["length"] = values[0]
1111 result = range_model.match(dic["type"])
1113 values = result.groups()
1114 if values[0] in ["UNSIGNED", "INTEGER", "REAL"]:
1115 editor["min"] = values[2]
1116 editor["max"] = values[3]
1117 editors.append(editor)
1118 return data, editors
1122 def AddToDCF(self, node_id, index, subindex, size, value):
1123 if self.CurrentNode.IsEntry(0x1F22, node_id):
1124 dcf_value = self.CurrentNode.GetEntry(0x1F22, node_id)
1126 nbparams = BE_to_LE(dcf_value[:4])
1129 new_value = LE_to_BE(nbparams + 1, 4) + dcf_value[4:]
1130 new_value += LE_to_BE(index, 2) + LE_to_BE(subindex, 1) + LE_to_BE(size, 4) + LE_to_BE(value, size)
1131 self.CurrentNode.SetEntry(0x1F22, node_id, new_value)
1133 #-------------------------------------------------------------------------------
1134 # Node Informations Functions
1135 #-------------------------------------------------------------------------------
1137 def GetCustomisedTypeValues(self, index):
1138 if self.CurrentNode:
1139 values = self.CurrentNode.GetEntry(index)
1140 customisabletypes = self.GetCustomisableTypes()
1141 return values, customisabletypes[values[1]][1]
1145 def GetEntryName(self, index):
1146 if self.CurrentNode:
1147 return self.CurrentNode.GetEntryName(index)
1149 return FindEntryName(index, MappingDictionary)
1151 def GetEntryInfos(self, index):
1152 if self.CurrentNode:
1153 return self.CurrentNode.GetEntryInfos(index)
1155 return FindEntryInfos(index, MappingDictionary)
1157 def GetSubentryInfos(self, index, subindex):
1158 if self.CurrentNode:
1159 return self.CurrentNode.GetSubentryInfos(index, subindex)
1161 result = FindSubentryInfos(index, subindex, MappingDictionary)
1163 result["user_defined"] = False
1166 def GetTypeIndex(self, typename):
1167 if self.CurrentNode:
1168 return self.CurrentNode.GetTypeIndex(typename)
1170 return FindTypeIndex(typename, MappingDictionary)
1172 def GetTypeName(self, typeindex):
1173 if self.CurrentNode:
1174 return self.CurrentNode.GetTypeName(typeindex)
1176 return FindTypeName(typeindex, MappingDictionary)
1178 def GetTypeDefaultValue(self, typeindex):
1179 if self.CurrentNode:
1180 return self.CurrentNode.GetTypeDefaultValue(typeindex)
1182 return FindTypeDefaultValue(typeindex, MappingDictionary)
1184 def GetMapVariableList(self):
1185 if self.CurrentNode:
1186 return self.CurrentNode.GetMapVariableList()
1190 def GetMandatoryIndexes(self):
1191 if self.CurrentNode:
1192 return self.CurrentNode.GetMandatoryIndexes()
1194 return FindMandatoryIndexes(MappingDictionary)
1196 def GetCustomisableTypes(self):
1198 for index, valuetype in CustomisableTypes:
1199 name = self.GetTypeName(index)
1200 dic[index] = [name, valuetype]
1203 def GetCurrentSpecificMenu(self):
1204 if self.CurrentNode:
1205 return self.CurrentNode.GetSpecificMenu()