1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2012: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

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

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

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

    17

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

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

from __future__ import absolute_import

    27

from types import TupleType

    28

import numpy

    29

    30

import wx

    31

import wx.lib.buttons

    32

    33

    34

# pylint: disable=wrong-import-position

    35

import matplotlib

    36

matplotlib.use('WX')   # noqa

    37

import matplotlib.pyplot

    38

    39

from editors.DebugViewer import DebugViewer

    40

from util.BitmapLibrary import GetBitmap

    41

    42

from controls.DebugVariablePanel.DebugVariableItem import DebugVariableItem

    43

from controls.DebugVariablePanel.DebugVariableTextViewer import DebugVariableTextViewer

    44

from controls.DebugVariablePanel.DebugVariableGraphicViewer import *

    45

    46

    47

MILLISECOND = 1000000        # Number of nanosecond in a millisecond

    48

SECOND = 1000 * MILLISECOND  # Number of nanosecond in a second

    49

MINUTE = 60 * SECOND         # Number of nanosecond in a minute

    50

HOUR = 60 * MINUTE           # Number of nanosecond in a hour

    51

DAY = 24 * HOUR              # Number of nanosecond in a day

    52

    53

# List of values possible for graph range

    54

# Format is [(time_in_plain_text, value_in_nanosecond),...]

    55

RANGE_VALUES = \

    56

    [(_("%dms") % i, i * MILLISECOND) for i in (10, 20, 50, 100, 200, 500)] + \

    57

    [(_("%ds") % i, i * SECOND) for i in (1, 2, 5, 10, 20, 30)] + \

    58

    [(_("%dm") % i, i * MINUTE) for i in (1, 2, 5, 10, 20, 30)] + \

    59

    [(_("%dh") % i, i * HOUR) for i in (1, 2, 3, 6, 12, 24)]

    60

    61

# Scrollbar increment in pixel

    62

SCROLLBAR_UNIT = 10

    63

    64

    65

def compute_mask(x, y):

    66

    return [(xp if xp == yp else "*")

    67

            for xp, yp in zip(x, y)]

    68

    69

    70

def NextTick(variables):

    71

    next_tick = None

    72

    for _item, data in variables:

    73

        if len(data) == 0:

    74

            continue

    75

    76

        next_tick = (data[0][0]

    77

                     if next_tick is None

    78

                     else min(next_tick, data[0][0]))

    79

    80

    return next_tick

    81

    82

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

    83

#                    Debug Variable Graphic Panel Drop Target

    84

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

    85

    86

    87

class DebugVariableDropTarget(wx.TextDropTarget):

    88

    """

    89

    Class that implements a custom drop target class for Debug Variable Graphic

    90

    Panel

    91

    """

    92

    93

    def __init__(self, window):

    94

        """

    95

        Constructor

    96

        @param window: Reference to the Debug Variable Panel

    97

        """

    98

        wx.TextDropTarget.__init__(self)

    99

        self.ParentWindow = window

   100

   101

    def __del__(self):

   102

        """

   103

        Destructor

   104

        """

   105

        # Remove reference to Debug Variable Panel

   106

        self.ParentWindow = None

   107

   108

    def OnDragOver(self, x, y, d):

   109

        """

   110

        Function called when mouse is dragged over Drop Target

   111

        @param x: X coordinate of mouse pointer

   112

        @param y: Y coordinate of mouse pointer

   113

        @param d: Suggested default for return value

   114

        """

   115

        # Signal Debug Variable Panel to refresh highlight giving mouse position

   116

        self.ParentWindow.RefreshHighlight(x, y)

   117

        return wx.TextDropTarget.OnDragOver(self, x, y, d)

   118

   119

    def OnDropText(self, x, y, data):

   120

        """

   121

        Function called when mouse is released in Drop Target

   122

        @param x: X coordinate of mouse pointer

   123

        @param y: Y coordinate of mouse pointer

   124

        @param data: Text associated to drag'n drop

   125

        """

   126

        # Signal Debug Variable Panel to reset highlight

   127

        self.ParentWindow.ResetHighlight()

   128

   129

        message = None

   130

   131

        # Check that data is valid regarding DebugVariablePanel

   132

        try:

   133

            values = eval(data)

   134

            if not isinstance(values, TupleType):

   135

                raise ValueError

   136

        except Exception:

   137

            message = _("Invalid value \"%s\" for debug variable") % data

   138

            values = None

   139

   140

        # Display message if data is invalid

   141

        if message is not None:

   142

            wx.CallAfter(self.ShowMessage, message)

   143

   144

        # Data contain a reference to a variable to debug

   145

        elif values[1] == "debug":

   146

   147

            # Drag'n Drop is an internal is an internal move inside Debug

   148

            # Variable Panel

   149

            if len(values) > 2 and values[2] == "move":

   150

                self.ParentWindow.MoveValue(values[0])

   151

   152

            # Drag'n Drop was initiated by another control of Beremiz

   153

            else:

   154

                self.ParentWindow.InsertValue(values[0], force=True)

   155

   156

    def OnLeave(self):

   157

        """

   158

        Function called when mouse is leave Drop Target

   159

        """

   160

        # Signal Debug Variable Panel to reset highlight

   161

        self.ParentWindow.ResetHighlight()

   162

        return wx.TextDropTarget.OnLeave(self)

   163

   164

    def ShowMessage(self, message):

   165

        """

   166

        Show error message in Error Dialog

   167

        @param message: Error message to display

   168

        """

   169

        dialog = wx.MessageDialog(self.ParentWindow,

   170

                                  message,

   171

                                  _("Error"),

   172

                                  wx.OK | wx.ICON_ERROR)

   173

        dialog.ShowModal()

   174

        dialog.Destroy()

   175

   176

   177

class DebugVariablePanel(wx.Panel, DebugViewer):

   178

    """

   179

    Class that implements a Viewer that display variable values as a graphs

   180

    """

   181

   182

    def __init__(self, parent, producer, window):

   183

        """

   184

        Constructor

   185

        @param parent: Reference to the parent wx.Window

   186

        @param producer: Object receiving debug value and dispatching them to

   187

        consumers

   188

        @param window: Reference to Beremiz frame

   189

        """

   190

        wx.Panel.__init__(self, parent, style=wx.SP_3D | wx.TAB_TRAVERSAL)

   191

   192

        # Save Reference to Beremiz frame

   193

        self.ParentWindow = window

   194

   195

        # Variable storing flag indicating that variable displayed in table

   196

        # received new value and then table need to be refreshed

   197

        self.HasNewData = False

   198

   199

        # Variable storing flag indicating that refresh has been forced, and

   200

        # that next time refresh is possible, it will be done even if no new

   201

        # data is available

   202

        self.Force = False

   203

   204

        self.SetBackgroundColour(wx.WHITE)

   205

   206

        main_sizer = wx.BoxSizer(wx.VERTICAL)

   207

   208

        self.Ticks = numpy.array([])  # List of tick received

   209

        self.StartTick = 0            # Tick starting range of data displayed

   210

        self.Fixed = False            # Flag that range of data is fixed

   211

        self.CursorTick = None        # Tick of cursor for displaying values

   212

   213

        self.DraggingAxesPanel = None

   214

        self.DraggingAxesBoundingBox = None

   215

        self.DraggingAxesMousePos = None

   216

        self.VetoScrollEvent = False

   217

   218

        self.VariableNameMask = []

   219

   220

        self.GraphicPanels = []

   221

   222

        graphics_button_sizer = wx.BoxSizer(wx.HORIZONTAL)

   223

        main_sizer.AddSizer(graphics_button_sizer, border=5, flag=wx.GROW | wx.ALL)

   224

   225

        range_label = wx.StaticText(self, label=_('Range:'))

   226

        graphics_button_sizer.AddWindow(range_label, flag=wx.ALIGN_CENTER_VERTICAL)

   227

   228

        self.CanvasRange = wx.ComboBox(self, style=wx.CB_READONLY)

   229

        self.Bind(wx.EVT_COMBOBOX, self.OnRangeChanged, self.CanvasRange)

   230

        graphics_button_sizer.AddWindow(self.CanvasRange, 1,

   231

                                        border=5,

   232

                                        flag=wx.LEFT | wx.ALIGN_CENTER_VERTICAL)

   233

   234

        self.CanvasRange.Clear()

   235

        default_range_idx = 0

   236

        for idx, (text, _value) in enumerate(RANGE_VALUES):

   237

            self.CanvasRange.Append(text)

   238

            if _value == 1000000000:

   239

                default_range_idx = idx

   240

        self.CanvasRange.SetSelection(default_range_idx)

   241

   242

        for name, bitmap, help in [

   243

                ("CurrentButton",     "current",      _("Go to current value")),

   244

                ("ExportGraphButton", "export_graph", _("Export graph values to clipboard"))]:

   245

            button = wx.lib.buttons.GenBitmapButton(

   246

                self, bitmap=GetBitmap(bitmap),

   247

                size=wx.Size(28, 28), style=wx.NO_BORDER)

   248

            button.SetToolTipString(help)

   249

            setattr(self, name, button)

   250

            self.Bind(wx.EVT_BUTTON, getattr(self, "On" + name), button)

   251

            graphics_button_sizer.AddWindow(button, border=5, flag=wx.LEFT)

   252

   253

        self.CanvasPosition = wx.ScrollBar(

   254

            self, size=wx.Size(0, 16), style=wx.SB_HORIZONTAL)

   255

        self.CanvasPosition.Bind(wx.EVT_SCROLL_THUMBTRACK,

   256

                                 self.OnPositionChanging, self.CanvasPosition)

   257

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEUP,

   258

                                 self.OnPositionChanging, self.CanvasPosition)

   259

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEDOWN,

   260

                                 self.OnPositionChanging, self.CanvasPosition)

   261

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEUP,

   262

                                 self.OnPositionChanging, self.CanvasPosition)

   263

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEDOWN,

   264

                                 self.OnPositionChanging, self.CanvasPosition)

   265

        main_sizer.AddWindow(self.CanvasPosition, border=5, flag=wx.GROW | wx.LEFT | wx.RIGHT | wx.BOTTOM)

   266

   267

        self.TickSizer = wx.BoxSizer(wx.HORIZONTAL)

   268

        main_sizer.AddSizer(self.TickSizer, border=5, flag=wx.ALL | wx.GROW)

   269

   270

        self.TickLabel = wx.StaticText(self)

   271

        self.TickSizer.AddWindow(self.TickLabel, border=5, flag=wx.RIGHT)

   272

   273

        self.MaskLabel = wx.TextCtrl(self, style=wx.TE_READONLY | wx.TE_CENTER | wx.NO_BORDER)

   274

        self.TickSizer.AddWindow(self.MaskLabel, 1, border=5, flag=wx.RIGHT | wx.GROW)

   275

   276

        self.TickTimeLabel = wx.StaticText(self)

   277

        self.TickSizer.AddWindow(self.TickTimeLabel)

   278

   279

        self.GraphicsWindow = wx.ScrolledWindow(self, style=wx.HSCROLL | wx.VSCROLL)

   280

        self.GraphicsWindow.SetBackgroundColour(wx.WHITE)

   281

        self.GraphicsWindow.SetDropTarget(DebugVariableDropTarget(self))

   282

        self.GraphicsWindow.Bind(wx.EVT_ERASE_BACKGROUND, self.OnGraphicsWindowEraseBackground)

   283

        self.GraphicsWindow.Bind(wx.EVT_PAINT, self.OnGraphicsWindowPaint)

   284

        self.GraphicsWindow.Bind(wx.EVT_SIZE, self.OnGraphicsWindowResize)

   285

        self.GraphicsWindow.Bind(wx.EVT_MOUSEWHEEL, self.OnGraphicsWindowMouseWheel)

   286

   287

        main_sizer.AddWindow(self.GraphicsWindow, 1, flag=wx.GROW)

   288

   289

        self.GraphicsSizer = wx.BoxSizer(wx.VERTICAL)

   290

        self.GraphicsWindow.SetSizer(self.GraphicsSizer)

   291

   292

        DebugViewer.__init__(self, producer, True)

   293

   294

        self.SetSizer(main_sizer)

   295

        self.SetTickTime()

   296

   297

    def SetTickTime(self, ticktime=0):

   298

        """

   299

        Set Ticktime for calculate data range according to time range selected

   300

        @param ticktime: Ticktime to apply to range (default: 0)

   301

        """

   302

        # Save ticktime

   303

        self.Ticktime = ticktime

   304

   305

        # Set ticktime to millisecond if undefined

   306

        if self.Ticktime == 0:

   307

            self.Ticktime = MILLISECOND

   308

   309

        # Calculate range to apply to data

   310

        self.CurrentRange = RANGE_VALUES[

   311

            self.CanvasRange.GetSelection()][1] / self.Ticktime

   312

   313

    def SetDataProducer(self, producer):

   314

        """

   315

        Set Data Producer

   316

        @param producer: Data Producer

   317

        """

   318

        DebugViewer.SetDataProducer(self, producer)

   319

   320

        # Set ticktime if data producer is available

   321

        if self.DataProducer is not None:

   322

            self.SetTickTime(self.DataProducer.GetTicktime())

   323

   324

    def RefreshNewData(self):

   325

        """

   326

        Called to refresh Panel according to values received by variables

   327

        Can receive any parameters (not used here)

   328

        """

   329

        # Refresh graphs if new data is available or refresh is forced

   330

        if self.HasNewData or self.Force:

   331

            self.HasNewData = False

   332

            self.RefreshView()

   333

   334

        DebugViewer.RefreshNewData(self)

   335

   336

    def NewDataAvailable(self, ticks):

   337

        """

   338

        Called by DataProducer for each tick captured or by panel to refresh

   339

        graphs

   340

        @param tick: PLC tick captured

   341

        All other parameters are passed to refresh function

   342

        """

   343

        # If tick given

   344

        if ticks is not None:

   345

            tick = ticks[-1]

   346

   347

            # Save tick as start tick for range if data is still empty

   348

            if len(self.Ticks) == 0:

   349

                self.StartTick = ticks[0]

   350

   351

            # Add tick to list of ticks received

   352

            self.Ticks = numpy.append(self.Ticks, ticks)

   353

   354

            # Update start tick for range if range follow ticks received

   355

            if not self.Fixed or tick < self.StartTick + self.CurrentRange:

   356

                self.StartTick = max(self.StartTick, tick - self.CurrentRange)

   357

   358

            # Force refresh if graph is fixed because range of data received

   359

            # is too small to fill data range selected

   360

            if self.Fixed and \

   361

               self.Ticks[-1] - self.Ticks[0] < self.CurrentRange:

   362

                self.Force = True

   363

   364

            self.HasNewData = False

   365

            self.RefreshView()

   366

   367

        else:

   368

            DebugViewer.NewDataAvailable(self, ticks)

   369

   370

    def ForceRefresh(self):

   371

        """

   372

        Called to force refresh of graphs

   373

        """

   374

        self.Force = True

   375

        wx.CallAfter(self.NewDataAvailable, None)

   376

   377

    def SetCursorTick(self, cursor_tick):

   378

        """

   379

        Set Cursor for displaying values of items at a tick given

   380

        @param cursor_tick: Tick of cursor

   381

        """

   382

        # Save cursor tick

   383

        self.CursorTick = cursor_tick

   384

        self.Fixed = cursor_tick is not None

   385

        self.UpdateCursorTick()

   386

   387

    def MoveCursorTick(self, move):

   388

        if self.CursorTick is not None:

   389

            cursor_tick = max(self.Ticks[0],

   390

                              min(self.CursorTick + move, self.Ticks[-1]))

   391

            cursor_tick_idx = numpy.argmin(numpy.abs(self.Ticks - cursor_tick))

   392

            if self.Ticks[cursor_tick_idx] == self.CursorTick:

   393

                cursor_tick_idx = max(0,

   394

                                      min(cursor_tick_idx + abs(move) / move,

   395

                                          len(self.Ticks) - 1))

   396

            self.CursorTick = self.Ticks[cursor_tick_idx]

   397

            self.StartTick = max(

   398

                self.Ticks[numpy.argmin(

   399

                    numpy.abs(self.Ticks - self.CursorTick + self.CurrentRange))],

   400

                min(self.StartTick, self.CursorTick))

   401

            self.RefreshCanvasPosition()

   402

            self.UpdateCursorTick()

   403

   404

    def ResetCursorTick(self):

   405

        self.CursorTick = None

   406

        self.Fixed = False

   407

        self.UpdateCursorTick()

   408

   409

    def UpdateCursorTick(self):

   410

        for panel in self.GraphicPanels:

   411

            if isinstance(panel, DebugVariableGraphicViewer):

   412

                panel.SetCursorTick(self.CursorTick)

   413

        self.ForceRefresh()

   414

   415

    def StartDragNDrop(self, panel, item, x_mouse, y_mouse, x_mouse_start, y_mouse_start):

   416

        if len(panel.GetItems()) > 1:

   417

            self.DraggingAxesPanel = DebugVariableGraphicViewer(self.GraphicsWindow, self, [item], GRAPH_PARALLEL)

   418

            self.DraggingAxesPanel.SetCursorTick(self.CursorTick)

   419

            width, height = panel.GetSize()

   420

            self.DraggingAxesPanel.SetSize(wx.Size(width, height))

   421

            self.DraggingAxesPanel.ResetGraphics()

   422

            self.DraggingAxesPanel.SetPosition(wx.Point(0, -height))

   423

        else:

   424

            self.DraggingAxesPanel = panel

   425

        self.DraggingAxesBoundingBox = panel.GetAxesBoundingBox(parent_coordinate=True)

   426

        self.DraggingAxesMousePos = wx.Point(

   427

            x_mouse_start - self.DraggingAxesBoundingBox.x,

   428

            y_mouse_start - self.DraggingAxesBoundingBox.y)

   429

        self.MoveDragNDrop(x_mouse, y_mouse)

   430

   431

    def MoveDragNDrop(self, x_mouse, y_mouse):

   432

        self.DraggingAxesBoundingBox.x = x_mouse - self.DraggingAxesMousePos.x

   433

        self.DraggingAxesBoundingBox.y = y_mouse - self.DraggingAxesMousePos.y

   434

        self.RefreshHighlight(x_mouse, y_mouse)

   435

   436

    def RefreshHighlight(self, x_mouse, y_mouse):

   437

        for idx, panel in enumerate(self.GraphicPanels):

   438

            x, y = panel.GetPosition()

   439

            width, height = panel.GetSize()

   440

            rect = wx.Rect(x, y, width, height)

   441

            if rect.InsideXY(x_mouse, y_mouse) or \

   442

               idx == 0 and y_mouse < 0 or \

   443

               idx == len(self.GraphicPanels) - 1 and y_mouse > panel.GetPosition()[1]:

   444

                panel.RefreshHighlight(x_mouse - x, y_mouse - y)

   445

            else:

   446

                panel.SetHighlight(HIGHLIGHT_NONE)

   447

        if wx.Platform == "__WXMSW__":

   448

            self.RefreshView()

   449

        else:

   450

            self.ForceRefresh()

   451

   452

    def ResetHighlight(self):

   453

        for panel in self.GraphicPanels:

   454

            panel.SetHighlight(HIGHLIGHT_NONE)

   455

        if wx.Platform == "__WXMSW__":

   456

            self.RefreshView()

   457

        else:

   458

            self.ForceRefresh()

   459

   460

    def IsDragging(self):

   461

        return self.DraggingAxesPanel is not None

   462

   463

    def GetDraggingAxesClippingRegion(self, panel):

   464

        x, y = panel.GetPosition()

   465

        width, height = panel.GetSize()

   466

        bbox = wx.Rect(x, y, width, height)

   467

        bbox = bbox.Intersect(self.DraggingAxesBoundingBox)

   468

        bbox.x -= x

   469

        bbox.y -= y

   470

        return bbox

   471

   472

    def GetDraggingAxesPosition(self, panel):

   473

        x, y = panel.GetPosition()

   474

        return wx.Point(self.DraggingAxesBoundingBox.x - x,

   475

                        self.DraggingAxesBoundingBox.y - y)

   476

   477

    def StopDragNDrop(self, variable, x_mouse, y_mouse):

   478

        if self.DraggingAxesPanel not in self.GraphicPanels:

   479

            self.DraggingAxesPanel.Destroy()