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 time import time as gettime

    27

from cycler import cycler

    28

    29

import numpy

    30

import wx

    31

import matplotlib

    32

import matplotlib.pyplot

    33

from matplotlib.backends.backend_wxagg import FigureCanvasWxAgg as FigureCanvas

    34

from matplotlib.backends.backend_agg import FigureCanvasAgg

    35

from mpl_toolkits.mplot3d import Axes3D

    36

    37

from editors.DebugViewer import REFRESH_PERIOD

    38

from controls.DebugVariablePanel.DebugVariableViewer import *

    39

from controls.DebugVariablePanel.GraphButton import GraphButton

    40

    41

    42

# Graph variable display type

    43

GRAPH_PARALLEL, GRAPH_ORTHOGONAL = list(range(2))

    44

    45

# Canvas height

    46

[SIZE_MINI, SIZE_MIDDLE, SIZE_MAXI] = [0, 100, 200]

    47

    48

CANVAS_BORDER = (30., 20.)  # Border height on at bottom and top of graph

    49

CANVAS_PADDING = 8.5        # Border inside graph where no label is drawn

    50

VALUE_LABEL_HEIGHT = 17.    # Height of variable label in graph

    51

AXES_LABEL_HEIGHT = 12.75   # Height of variable value in graph

    52

    53

# Colors used cyclically for graph curves

    54

COLOR_CYCLE = ['r', 'b', 'g', 'm', 'y', 'k']

    55

# Color for graph cursor

    56

CURSOR_COLOR = '#800080'

    57

    58

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

    59

#                      Debug Variable Graphic Viewer Helpers

    60

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

    61

    62

    63

def merge_ranges(ranges):

    64

    """

    65

    Merge variables data range in a list to return a range of minimal min range

    66

    value and maximal max range value extended of 10% for keeping a padding

    67

    around graph in canvas

    68

    @param ranges: [(range_min_value, range_max_value),...]

    69

    @return: merged_range_min_value, merged_range_max_value

    70

    """

    71

    # Get minimal and maximal range value

    72

    min_value = max_value = None

    73

    for range_min, range_max in ranges:

    74

        # Update minimal range value

    75

        if min_value is None:

    76

            min_value = range_min

    77

        elif range_min is not None:

    78

            min_value = min(min_value, range_min)

    79

    80

        # Update maximal range value

    81

        if max_value is None:

    82

            max_value = range_max

    83

        elif range_min is not None:

    84

            max_value = max(max_value, range_max)

    85

    86

    # Calculate range center and width if at least one valid range is defined

    87

    if min_value is not None and max_value is not None:

    88

        center = (min_value + max_value) / 2.

    89

        range_size = max(1.0, max_value - min_value)

    90

    91

    # Set default center and with if no valid range is defined

    92

    else:

    93

        center = 0.5

    94

        range_size = 1.0

    95

    96

    # Return range expended from 10 %

    97

    return center - range_size * 0.55, center + range_size * 0.55

    98

    99

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

   100

#                   Debug Variable Graphic Viewer Drop Target

   101

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

   102

   103

   104

class DebugVariableGraphicDropTarget(wx.TextDropTarget):

   105

    """

   106

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

   107

    Viewer

   108

    """

   109

   110

    def __init__(self, parent, window):

   111

        """

   112

        Constructor

   113

        @param parent: Reference to Debug Variable Graphic Viewer

   114

        @param window: Reference to the Debug Variable Panel

   115

        """

   116

        wx.TextDropTarget.__init__(self)

   117

        self.ParentControl = parent

   118

        self.ParentWindow = window

   119

   120

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

   121

        """

   122

        Function called when mouse is dragged over Drop Target

   123

        @param x: X coordinate of mouse pointer

   124

        @param y: Y coordinate of mouse pointer

   125

        @param d: Suggested default for return value

   126

        """

   127

        # Signal parent that mouse is dragged over

   128

        self.ParentControl.OnMouseDragging(x, y)

   129

   130

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

   131

   132

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

   133

        """

   134

        Function called when mouse is released in Drop Target

   135

        @param x: X coordinate of mouse pointer

   136

        @param y: Y coordinate of mouse pointer

   137

        @param data: Text associated to drag'n drop

   138

        """

   139

        # Signal Debug Variable Panel to reset highlight

   140

        self.ParentWindow.ResetHighlight()

   141

   142

        message = None

   143

   144

        # Check that data is valid regarding DebugVariablePanel

   145

        try:

   146

            values = eval(data)

   147

            if not isinstance(values, tuple):

   148

                raise ValueError

   149

        except Exception:

   150

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

   151

            values = None

   152

   153

        # Display message if data is invalid

   154

        if message is not None:

   155

            wx.CallAfter(self.ShowMessage, message)

   156

            return False

   157

   158

        # Data contain a reference to a variable to debug

   159

        elif values[1] == "debug":

   160

            target_idx = self.ParentControl.GetIndex()

   161

   162

            # If mouse is dropped in graph canvas bounding box and graph is

   163

            # not 3D canvas, graphs will be merged

   164

            rect = self.ParentControl.GetAxesBoundingBox()

   165

            if not self.ParentControl.Is3DCanvas() and rect.Contains(x, y):

   166

                # Default merge type is parallel

   167

                merge_type = GRAPH_PARALLEL

   168

   169

                # If mouse is dropped in left part of graph canvas, graph

   170

                # wall be merged orthogonally

   171

                merge_rect = wx.Rect(rect.x, rect.y,

   172

                                     rect.width / 2., rect.height)

   173

                if merge_rect.Contains(x, y):

   174

                    merge_type = GRAPH_ORTHOGONAL

   175

   176

                # Merge graphs

   177

                wx.CallAfter(self.ParentWindow.MergeGraphs,

   178

                             values[0], target_idx,

   179

                             merge_type, force=True)

   180

   181

            else:

   182

                _width, height = self.ParentControl.GetSize()

   183

   184

                # Get Before which Viewer the variable has to be moved or added

   185

                # according to the position of mouse in Viewer.

   186

                if y > height // 2:

   187

                    target_idx += 1

   188

   189

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

   190

                # Variable Panel

   191

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

   192

                    self.ParentWindow.MoveValue(values[0],

   193

                                                target_idx)

   194

   195

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

   196

                else:

   197

                    self.ParentWindow.InsertValue(values[0],

   198

                                                  target_idx,

   199

                                                  force=True)

   200

            return True

   201

        return False

   202

   203

    def OnLeave(self):

   204

        """

   205

        Function called when mouse is leave Drop Target

   206

        """

   207

        # Signal Debug Variable Panel to reset highlight

   208

        self.ParentWindow.ResetHighlight()

   209

        return wx.TextDropTarget.OnLeave(self)

   210

   211

    def ShowMessage(self, message):

   212

        """

   213

        Show error message in Error Dialog

   214

        @param message: Error message to display

   215

        """

   216

        dialog = wx.MessageDialog(self.ParentWindow,

   217

                                  message,

   218

                                  _("Error"),

   219

                                  wx.OK | wx.ICON_ERROR)

   220

        dialog.ShowModal()

   221

        dialog.Destroy()

   222

   223

   224

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

   225

#                      Debug Variable Graphic Viewer Class

   226

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

   227

   228

   229

class DebugVariableGraphicViewer(DebugVariableViewer, FigureCanvas):

   230

    """

   231

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

   232

    """

   233

   234

    def __init__(self, parent, window, items, graph_type):

   235

        """

   236

        Constructor

   237

        @param parent: Parent wx.Window of DebugVariableText

   238

        @param window: Reference to the Debug Variable Panel

   239

        @param items: List of DebugVariableItem displayed by Viewer

   240

        @param graph_type: Graph display type (Parallel or orthogonal)

   241

        """

   242

        DebugVariableViewer.__init__(self, window, items)

   243

   244

        self.GraphType = graph_type        # Graph type display

   245

        self.CursorTick = None             # Tick of the graph cursor

   246

   247

        # Mouse position when start dragging

   248

        self.MouseStartPos = None

   249

        # Tick when moving tick start

   250

        self.StartCursorTick = None

   251

        # Canvas size when starting to resize canvas

   252

        self.CanvasStartSize = None

   253

   254

        # List of current displayed contextual buttons

   255

        self.ContextualButtons = []

   256

        # Reference to item for which contextual buttons was displayed

   257

        self.ContextualButtonsItem = None

   258

   259

        # Flag indicating that zoom fit current displayed data range or whole

   260

        # data range if False

   261

        self.ZoomFit = False

   262

   263

        # Create figure for drawing graphs

   264

        self.Figure = matplotlib.figure.Figure(facecolor='w')

   265

        # Defined border around figure in canvas

   266

        self.Figure.subplotpars.update(top=0.95, left=0.1,

   267

                                       bottom=0.1, right=0.95)

   268

   269

        FigureCanvas.__init__(self, parent, -1, self.Figure)

   270

        self.SetWindowStyle(wx.WANTS_CHARS)

   271

   272

        # Bind wx events

   273

        self.Bind(wx.EVT_LEFT_DCLICK, self.OnLeftDClick)

   274

        self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)

   275

        self.Bind(wx.EVT_ENTER_WINDOW, self.OnEnter)

   276

        self.Bind(wx.EVT_LEAVE_WINDOW, self.OnLeave)

   277

        self.Bind(wx.EVT_ERASE_BACKGROUND, self.OnEraseBackground)

   278

        self.Bind(wx.EVT_SIZE, self.OnResize)

   279

   280

        # Set canvas min size

   281

        canvas_size = self.GetCanvasMinSize()

   282

        self.SetMinSize(canvas_size)

   283

   284

        # Define Viewer drop target

   285

        self.SetDropTarget(DebugVariableGraphicDropTarget(self, window))

   286

   287

        # Connect matplotlib events

   288

        self.mpl_connect('button_press_event', self.OnCanvasButtonPressed)

   289

        self.mpl_connect('motion_notify_event', self.OnCanvasMotion)

   290

        self.mpl_connect('button_release_event', self.OnCanvasButtonReleased)

   291

        self.mpl_connect('scroll_event', self.OnCanvasScroll)

   292

   293

        # Add buttons for zooming on current displayed data range

   294

        self.Buttons.append(

   295

            GraphButton(0, 0, "fit_graph", self.OnZoomFitButton))

   296

   297

        # Add buttons for changing canvas size with predefined height

   298

        for size, bitmap in zip(

   299

                [SIZE_MINI, SIZE_MIDDLE, SIZE_MAXI],

   300

                ["minimize_graph", "middle_graph", "maximize_graph"]):

   301

            self.Buttons.append(GraphButton(0, 0, bitmap,

   302

                                            self.GetOnChangeSizeButton(size)))

   303

   304

        # Add buttons for exporting graph values to clipboard and close graph

   305

        for bitmap, callback in [

   306

                ("export_graph_mini", self.OnExportGraphButton),

   307

                ("delete_graph", self.OnCloseButton)]:

   308

            self.Buttons.append(GraphButton(0, 0, bitmap, callback))

   309

   310

        # Update graphs elements

   311

        self.ResetGraphics()

   312

        self.RefreshLabelsPosition(canvas_size.height)

   313

   314

    def AddItem(self, item):

   315

        """

   316

        Add an item to the list of items displayed by Viewer

   317

        @param item: Item to add to the list

   318

        """

   319

        DebugVariableViewer.AddItem(self, item)

   320

        self.ResetGraphics()

   321

   322

    def RemoveItem(self, item):

   323

        """

   324

        Remove an item from the list of items displayed by Viewer

   325

        @param item: Item to remove from the list

   326

        """

   327

        DebugVariableViewer.RemoveItem(self, item)

   328

   329

        # If list of items is not empty

   330

        if not self.ItemsIsEmpty():

   331

            # Return to parallel graph if there is only one item

   332

            # especially if it's actually orthogonal

   333

            if len(self.Items) == 1:

   334

                self.GraphType = GRAPH_PARALLEL

   335

            self.ResetGraphics()

   336

   337

    def SetCursorTick(self, cursor_tick):

   338

        """

   339

        Set cursor tick

   340

        @param cursor_tick: Cursor tick

   341

        """

   342

        self.CursorTick = cursor_tick

   343

   344

    def SetZoomFit(self, zoom_fit):

   345

        """

   346

        Set flag indicating that zoom fit current displayed data range

   347

        @param zoom_fit: Flag for zoom fit (False: zoom fit whole data range)

   348

        """

   349

        # Flag is different from the actual one

   350

        if zoom_fit != self.ZoomFit:

   351

            # Save new flag value

   352

            self.ZoomFit = zoom_fit

   353

   354

            # Update button for zoom fit bitmap

   355

            self.Buttons[0].SetBitmap("full_graph" if zoom_fit else "fit_graph")

   356

   357

            # Refresh canvas

   358

            self.RefreshViewer()

   359

   360

    def SubscribeAllDataConsumers(self):

   361

        """

   362

        Function that unsubscribe and remove every item that store values of

   363

        a variable that doesn't exist in PLC anymore

   364

        """

   365

        DebugVariableViewer.SubscribeAllDataConsumers(self)

   366

   367

        # Graph still have data to display

   368

        if not self.ItemsIsEmpty():

   369

            # Reset flag indicating that zoom fit current displayed data range

   370

            self.SetZoomFit(False)

   371

   372

            self.ResetGraphics()

   373

   374

    def Is3DCanvas(self):

   375

        """

   376

        Return if Viewer is a 3D canvas

   377

        @return: True if Viewer is a 3D canvas

   378

        """

   379

        return self.GraphType == GRAPH_ORTHOGONAL and len(self.Items) == 3

   380

   381

    def GetButtons(self):

   382

        """

   383

        Return list of buttons defined in Viewer

   384

        @return: List of buttons

   385

        """

   386

        # Add contextual buttons to default buttons

   387

        return self.Buttons + self.ContextualButtons

   388

   389

    def PopupContextualButtons(self, item, rect, direction=wx.RIGHT):

   390

        """

   391

        Show contextual menu for item aside a label of this item defined

   392

        by the bounding box of label in figure

   393

        @param item: Item for which contextual is shown

   394

        @param rect: Bounding box of label aside which drawing menu

   395

        @param direction: Direction in which buttons must be drawn

   396

        """

   397

        # Return immediately if contextual menu for item is already shown

   398

        if self.ContextualButtonsItem == item:

   399

            return

   400

   401

        # Close already shown contextual menu

   402

        self.DismissContextualButtons()

   403

   404

        # Save item for which contextual menu is shown

   405

        self.ContextualButtonsItem = item

   406

   407

        # If item variable is forced, add button for release variable to

   408

        # contextual menu

   409

        if self.ContextualButtonsItem.IsForced():

   410

            self.ContextualButtons.append(

   411

                GraphButton(0, 0, "release", self.OnReleaseItemButton))

   412

   413

        # Add other buttons to contextual menu

   414

        for bitmap, callback in [

   415

                ("force", self.OnForceItemButton),

   416

                ("export_graph_mini", self.OnExportItemGraphButton),

   417

                ("delete_graph", self.OnRemoveItemButton)]:

   418

            self.ContextualButtons.append(GraphButton(0, 0, bitmap, callback))

   419

   420

        # If buttons are shown at left side or upper side of rect, positions

   421

        # will be set in reverse order

   422

        buttons = self.ContextualButtons[:]

   423

        if direction in [wx.TOP, wx.LEFT]:

   424

            buttons.reverse()

   425

   426

        # Set contextual menu buttons position aside rect depending on

   427

        # direction given

   428

        offset = 0

   429

        for button in buttons:

   430

            w, h = button.GetSize()

   431

            if direction in [wx.LEFT, wx.RIGHT]:

   432

                x = rect.x + (- w - offset

   433

                              if direction == wx.LEFT

   434

                              else rect.width + offset)

   435

                y = rect.y + (rect.height - h) // 2

   436

                offset += w

   437

            else:

   438

                x = rect.x + (rect.width - w) // 2

   439

                y = rect.y + (- h - offset

   440

                              if direction == wx.TOP

   441

                              else rect.height + offset)

   442

                offset += h

   443

            button.SetPosition(x, y)

   444

            button.Show()

   445

   446

        # Refresh canvas

   447

        self.ParentWindow.ForceRefresh()

   448

   449

    def DismissContextualButtons(self):

   450

        """

   451

        Close current shown contextual menu

   452

        """

   453

        # Return immediately if no contextual menu is shown

   454

        if self.ContextualButtonsItem is None:

   455

            return

   456

   457

        # Reset variables corresponding to contextual menu

   458

        self.ContextualButtonsItem = None

   459

        self.ContextualButtons = []

   460

   461

        # Refresh canvas

   462

        self.ParentWindow.ForceRefresh()

   463

   464

    def IsOverContextualButton(self, x, y):

   465

        """

   466

        Return if point is over one contextual button of Viewer

   467

        @param x: X coordinate of point

   468

        @param y: Y coordinate of point

   469

        @return: contextual button where point is over

   470

        """

   471

        for button in self.ContextualButtons:

   472

            if button.HitTest(x, y):

   473

                return button

   474

        return None

   475

   476

    def ExportGraph(self, item=None):

   477

        """

   478

        Export item(s) data to clipboard in CSV format

   479

        @param item: Item from which data to export, all items if None

   480

        (default None)

   481

        """