dialogs/ForceVariableDialog.py
author laurent
Fri, 01 Apr 2011 17:19:31 +0200
changeset 519 722714c04dcd
parent 516 40290ddff19c
child 525 e8d5ab0855d3
permissions -rw-r--r--
Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
469
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
     2
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
     3
#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
     4
#based on the plcopen standard. 
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
     5
#
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
     6
#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
     7
#
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
     8
#See COPYING file for copyrights details.
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
     9
#
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    10
#This library is free software; you can redistribute it and/or
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    11
#modify it under the terms of the GNU General Public
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    12
#License as published by the Free Software Foundation; either
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    13
#version 2.1 of the License, or (at your option) any later version.
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    14
#
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    15
#This library is distributed in the hope that it will be useful,
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    16
#but WITHOUT ANY WARRANTY; without even the implied warranty of
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    17
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    18
#General Public License for more details.
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    19
#
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    20
#You should have received a copy of the GNU General Public
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    21
#License along with this library; if not, write to the Free Software
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    22
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    23
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    24
import wx
519
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    25
import re
516
40290ddff19c Initial TIME support in forcing
Edouard Tisserant
parents: 479
diff changeset
    26
import datetime
469
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    27
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    28
#-------------------------------------------------------------------------------
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    29
#                            Force Variable Dialog
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    30
#-------------------------------------------------------------------------------
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    31
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    32
LOCATIONDATATYPES = {"X" : ["BOOL"],
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    33
                     "B" : ["SINT", "USINT", "BYTE", "STRING"],
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    34
                     "W" : ["INT", "UINT", "WORD", "WSTRING"],
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    35
                     "D" : ["DINT", "UDINT", "REAL", "DWORD"],
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    36
                     "L" : ["LINT", "ULINT", "LREAL", "LWORD"]} 
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    37
475
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    38
def gen_get_function(f):
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    39
    def get_function(v):
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    40
        try:
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    41
            return f(v)
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    42
        except:
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    43
            return None
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    44
    return get_function
469
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    45
476
Edouard TISSERANT <edouard.tisserant@gmail.com>
parents: 475
diff changeset
    46
getinteger = gen_get_function(int)
Edouard TISSERANT <edouard.tisserant@gmail.com>
parents: 475
diff changeset
    47
getfloat = gen_get_function(float)
Edouard TISSERANT <edouard.tisserant@gmail.com>
parents: 475
diff changeset
    48
getstring = gen_get_function(str)
469
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    49
519
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    50
SECOND = 1000000
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    51
MINUTE = 60 * SECOND
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    52
HOUR = 60 * MINUTE
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    53
DAY = 24 * HOUR
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    54
IEC_TIME_MODEL = re.compile("(?:T|TIME)#(-)?(?:(%(float)s)D_?)?(?:(%(float)s)H_?)?(?:(%(float)s)M_?)?(?:(%(float)s)S_?)?(?:(%(float)s)MS)?" % {"float": "[0-9]+(?:\.[0-9]+)?"})
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    55
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    56
def gettime(v):    
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    57
    result = IEC_TIME_MODEL.match(v.upper())
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    58
    if result is not None:
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    59
        negative, days, hours, minutes, seconds, milliseconds = result.groups()
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    60
        microseconds = 0
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    61
        not_null = False
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    62
        for value, factor in [(days, DAY),
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    63
                              (hours, HOUR),
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    64
                              (minutes, MINUTE),
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    65
                              (seconds, SECOND),
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    66
                              (milliseconds, 1000)]:
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    67
            if value is not None:
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    68
                microseconds += float(value) * factor
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    69
                not_null = True
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    70
        if not not_null:
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    71
            return None
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    72
        if negative is not None:
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    73
            microseconds = -microseconds
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    74
        return datetime.timedelta(microseconds=microseconds)
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    75
    
722714c04dcd Adding support for displaying and forcing TIME variables according to IEC 61131 literal format
laurent
parents: 516
diff changeset
    76
    else: 
516
40290ddff19c Initial TIME support in forcing
Edouard Tisserant
parents: 479
diff changeset
    77
        return None
40290ddff19c Initial TIME support in forcing
Edouard Tisserant
parents: 479
diff changeset
    78
40290ddff19c Initial TIME support in forcing
Edouard Tisserant
parents: 479
diff changeset
    79
479
2fab0eefa66e Adding support for getting current value in ForceVariableDialog default value and adding variable in DebugVariablePanel when forced
laurent
parents: 476
diff changeset
    80
GetTypeValue = {"BOOL": lambda x: {"TRUE": True, "FALSE": False}.get(x.upper(), None),
475
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    81
                "SINT": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    82
                "INT": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    83
                "DINT": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    84
                "LINT": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    85
                "USINT": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    86
                "UINT": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    87
                "UDINT": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    88
                "ULINT": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    89
                "BYTE": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    90
                "WORD": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    91
                "DWORD": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    92
                "LWORD": getinteger,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    93
                "REAL": getfloat,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    94
                "LREAL": getfloat,
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
    95
                "STRING": getstring,
516
40290ddff19c Initial TIME support in forcing
Edouard Tisserant
parents: 479
diff changeset
    96
                "WSTRING": getstring,
40290ddff19c Initial TIME support in forcing
Edouard Tisserant
parents: 479
diff changeset
    97
                "TIME": gettime}
469
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    98
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
    99
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   100
class ForceVariableDialog(wx.TextEntryDialog):
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   101
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   102
    if wx.VERSION < (2, 6, 0):
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   103
        def Bind(self, event, function, id = None):
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   104
            if id is not None:
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   105
                event(self, id, function)
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   106
            else:
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   107
                event(self, function)
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   108
479
2fab0eefa66e Adding support for getting current value in ForceVariableDialog default value and adding variable in DebugVariablePanel when forced
laurent
parents: 476
diff changeset
   109
    def __init__(self, parent, iec_type, defaultValue=""):
469
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   110
        wx.TextEntryDialog.__init__(self, parent, message = _("Forcing Variable Value"), 
479
2fab0eefa66e Adding support for getting current value in ForceVariableDialog default value and adding variable in DebugVariablePanel when forced
laurent
parents: 476
diff changeset
   111
                caption = _("Please enter value for a \"%s\" variable:"%iec_type), defaultValue = defaultValue, 
469
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   112
                style = wx.OK|wx.CANCEL|wx.CENTRE, pos = wx.DefaultPosition)
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   113
        
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   114
        self.IEC_Type = iec_type 
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   115
        if wx.VERSION >= (2, 8, 0):
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   116
            self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetSizer().GetItem(2).GetSizer().GetItem(1).GetSizer().GetAffirmativeButton().GetId())
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   117
        elif wx.VERSION >= (2, 6, 0):
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   118
            self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetSizer().GetItem(3).GetSizer().GetAffirmativeButton().GetId())
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   119
        else:
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   120
            self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetSizer().GetItem(3).GetSizer().GetChildren()[0].GetSizer().GetChildren()[0].GetWindow().GetId())
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   121
    
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   122
    def OnOK(self, event):
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   123
        value = self.GetSizer().GetItem(1).GetWindow().GetValue()
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   124
        if value == "":
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   125
            message = wx.MessageDialog(self, _("You must type a value!"), _("Error"), wx.OK|wx.ICON_ERROR)
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   126
            message.ShowModal()
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   127
            message.Destroy()
475
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
   128
        elif GetTypeValue[self.IEC_Type](value) is None:
469
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   129
            message = wx.MessageDialog(self, _("Invalid value \"%s\" for \"%s\" variable!")%(value, self.IEC_Type), _("Error"), wx.OK|wx.ICON_ERROR)
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   130
            message.ShowModal()
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   131
            message.Destroy()
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   132
        else:
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   133
            self.EndModal(wx.ID_OK)
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   134
17411b970353 Adding support for forcing PLC variable in Viewer
laurent
parents:
diff changeset
   135
    def GetValue(self):
475
9ca03fdff80f ForceVariableDialog return a python value instead of string
laurent
parents: 469
diff changeset
   136
        return GetTypeValue[self.IEC_Type](self.GetSizer().GetItem(1).GetWindow().GetValue())