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

    27

import binascii

    28

import numpy

    29

from graphics.DebugDataConsumer import DebugDataConsumer, TYPE_TRANSLATOR

    30

    31

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

    32

#                 Constant for calculate CRC for string variables

    33

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

    34

    35

STRING_CRC_SIZE = 8

    36

STRING_CRC_MASK = 2 ** STRING_CRC_SIZE - 1

    37

    38

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

    39

#                          Debug Variable Item Class

    40

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

    41

    42

    43

class DebugVariableItem(DebugDataConsumer):

    44

    """

    45

    Class that implements an element that consumes debug values for PLC variable and

    46

    stores received values for displaying them in graphic panel or table

    47

    """

    48

    49

    def __init__(self, parent, variable, store_data=False):

    50

        """

    51

        Constructor

    52

        @param parent: Reference to debug variable panel

    53

        @param variable: Path of variable to debug

    54

        """

    55

        DebugDataConsumer.__init__(self)

    56

    57

        self.Parent = parent

    58

        self.Variable = variable

    59

        self.StoreData = store_data

    60

    61

        # Get Variable data type

    62

        self.RefreshVariableType()

    63

    64

    def __del__(self):

    65

        """

    66

        Destructor

    67

        """

    68

        # Reset reference to debug variable panel

    69

        self.Parent = None

    70

    71

    def SetVariable(self, variable):

    72

        """

    73

        Set path of variable

    74

        @param variable: Path of variable to debug

    75

        """

    76

        if self.Parent is not None and self.Variable != variable:

    77

            # Store variable path

    78

            self.Variable = variable

    79

            # Get Variable data type

    80

            self.RefreshVariableType()

    81

    82

            # Refresh debug variable panel

    83

            self.Parent.RefreshView()

    84

    85

    def GetVariable(self, mask=None):

    86

        """

    87

        Return path of variable

    88

        @param mask: Mask to apply to variable path [var_name, '*',...]

    89

        @return: String containing masked variable path

    90

        """

    91

        # Apply mask to variable name

    92

        if mask is not None:

    93

            # '#' correspond to parts that are different between all items

    94

    95

            # Extract variable path parts

    96

            parts = self.Variable.split('.')

    97

            # Adjust mask size to size of variable path

    98

            mask = mask + ['*'] * max(0, len(parts) - len(mask))

    99

   100

            # Store previous mask

   101

            last = None

   102

            # Init masked variable path

   103

            variable = ""

   104

   105

            for m, p in zip(mask, parts):

   106

                # Part is not masked, add part prefixed with '.' is previous

   107

                # wasn't masked

   108

                if m == '*':

   109

                    variable += ('.' if last == '*' else '') + p

   110

   111

                # Part is mask, add '..' if first or previous wasn't masked

   112

                elif last is None or last == '*':

   113

                    variable += '..'

   114

   115

                last = m

   116

   117

            return variable

   118

   119

        return self.Variable

   120

   121

    def RefreshVariableType(self):

   122

        """

   123

        Get and store variable data type

   124

        """

   125

        self.VariableType = self.Parent.GetDataType(self.Variable)

   126

        # Reset data stored

   127

        self.ResetData()

   128

   129

    def GetVariableType(self):

   130

        """

   131

        Return variable data type

   132

        @return: Variable data type

   133

        """

   134

        return self.VariableType

   135

   136

    def GetData(self, start_tick=None, end_tick=None):

   137

        """

   138

        Return data stored contained in given range

   139

        @param start_tick: Start tick of given range (default None, first data)

   140

        @param end_tick: end tick of given range (default None, last data)

   141

        @return: Data as numpy.array([(tick, value, forced),...])

   142

        """

   143

        # Return immediately if data empty or none

   144

        if self.Data is None or len(self.Data) == 0:

   145

            return self.Data

   146

   147

        # Find nearest data outside given range indexes

   148

        start_idx = (self.GetNearestData(start_tick, -1)

   149

                     if start_tick is not None

   150

                     else 0)

   151

        end_idx = (self.GetNearestData(end_tick, 1)

   152

                   if end_tick is not None

   153

                   else len(self.Data))

   154

   155

        # Return data between indexes

   156

        return self.Data[start_idx:end_idx]

   157

   158

    def GetRawValue(self, index):

   159

        """

   160

        Return raw value at given index for string variables

   161

        @param index: Variable value index

   162

        @return: Variable data type

   163

        """

   164

        if self.VariableType in ["STRING", "WSTRING"] and index < len(self.RawData):

   165

            return self.RawData[index][0]

   166

        return ""

   167

   168

    def GetValueRange(self):

   169

        """

   170

        Return variable value range

   171

        @return: (minimum_value, maximum_value)

   172

        """

   173

        return self.MinValue, self.MaxValue

   174

   175

    def GetDataAndValueRange(self, start_tick, end_tick, full_range=True):

   176

        """

   177

        Return variable data and value range for a given tick range

   178

        @param start_tick: Start tick of given range (default None, first data)

   179

        @param end_tick: end tick of given range (default None, last data)

   180

        @param full_range: Value range is calculated on whole data (False: only

   181

        calculated on data in given range)

   182

        @return: (numpy.array([(tick, value, forced),...]),

   183

                  min_value, max_value)

   184

        """

   185

        # Get data in given tick range

   186

        data = self.GetData(start_tick, end_tick)

   187

   188

        # Value range is calculated on whole data

   189

        if full_range:

   190

            return data, self.MinValue, self.MaxValue

   191

   192

        # Check that data in given range is not empty

   193

        values = data[:, 1]

   194

        if len(values) > 0:

   195

            # Return value range for data in given tick range

   196

            return (data,

   197

                    data[numpy.argmin(values), 1],

   198

                    data[numpy.argmax(values), 1])

   199

   200

        # Return default values

   201

        return data, None, None

   202

   203

    def ResetData(self):

   204

        """

   205

        Reset data stored when store data option enabled

   206

        """

   207

        if self.StoreData and self.IsNumVariable():

   208

            # Init table storing data

   209

            self.Data = numpy.array([]).reshape(0, 3)

   210

   211

            # Init table storing raw data if variable is strin

   212

            self.RawData = ([]

   213

                            if self.VariableType in ["STRING", "WSTRING"]

   214

                            else None)

   215

   216

            # Init Value range variables

   217

            self.MinValue = None

   218

            self.MaxValue = None

   219

   220

        else:

   221

            self.Data = None

   222

   223

        # Init variable value

   224

        self.Value = ""

   225

   226

    def IsNumVariable(self):

   227

        """

   228

        Return if variable data type is numeric. String variables are

   229

        considered as numeric (string CRC)

   230

        @return: True if data type is numeric

   231

        """

   232

        return (self.Parent.IsNumType(self.VariableType) or

   233

                self.VariableType in ["STRING", "WSTRING"])

   234

   235

    def NewValues(self, ticks, values):

   236

        """

   237

        Function called by debug thread when a new debug value is available

   238

        @param tick: PLC tick when value was captured

   239

        @param value: Value captured

   240

        @param forced: Forced flag, True if value is forced (default: False)

   241

        """

   242

        DebugDataConsumer.NewValues(self, ticks[-1], values[-1], raw=None)

   243

   244

        if self.Data is not None:

   245

   246

            if self.VariableType in ["STRING", "WSTRING"]:

   247

                last_raw_data = (self.RawData[-1]

   248

                                 if len(self.RawData) > 0 else None)

   249

                last_raw_data_idx = len(self.RawData) - 1

   250

   251

            data_values = []

   252

            for tick, (value, forced) in zip(ticks, values):

   253

                # Translate forced flag to float for storing in Data table

   254

                forced_value = float(forced)

   255

   256

                # String data value is CRC

   257

                num_value = (binascii.crc32(value) & STRING_CRC_MASK

   258

                             if self.VariableType in ["STRING", "WSTRING"]

   259

                             else float(value))

   260

   261

                # Update variable range values

   262

                self.MinValue = (min(self.MinValue, num_value)

   263

                                 if self.MinValue is not None

   264

                                 else num_value)

   265

                self.MaxValue = (max(self.MaxValue, num_value)

   266

                                 if self.MaxValue is not None

   267

                                 else num_value)

   268

   269

                # In the case of string variables, we store raw string value and

   270

                # forced flag in raw data table. Only changes in this two values

   271

                # are stored. Index to the corresponding raw value is stored in

   272

                # data third column

   273

                if self.VariableType in ["STRING", "WSTRING"]:

   274

                    raw_data = (value, forced_value)

   275

                    if len(self.RawData) == 0 or last_raw_data != raw_data:

   276

                        last_raw_data_idx += 1

   277

                        last_raw_data = raw_data

   278

                        self.RawData.append(raw_data)

   279

                    extra_value = last_raw_data_idx

   280

   281

                # In other case, data third column is forced flag

   282

                else:

   283

                    extra_value = forced_value

   284

   285

                data_values.append(

   286

                    [float(tick), num_value, extra_value])

   287

   288

            # Add New data to stored data table

   289

            self.Data = numpy.append(self.Data, data_values, axis=0)

   290

   291

            # Signal to debug variable panel to refresh

   292

            self.Parent.HasNewData = True

   293

   294

    def SetForced(self, forced):

   295

        """

   296

        Update Forced flag

   297

        @param forced: New forced flag

   298

        """

   299

        # Store forced flag

   300

        if self.Forced != forced:

   301

            self.Forced = forced

   302

   303

            # Signal to debug variable panel to refresh

   304

            self.Parent.HasNewData = True

   305

   306

    def SetValue(self, value):

   307

        """

   308

        Update value.

   309

        @param value: New value

   310

        """

   311

        # Remove quote and double quote surrounding string value to get raw value

   312

        if self.VariableType == "STRING" and value.startswith("'") and value.endswith("'") or \

   313

           self.VariableType == "WSTRING" and value.startswith('"') and value.endswith('"'):

   314

            value = value[1:-1]

   315

   316

        # Store variable value

   317

        if self.Value != value:

   318

            self.Value = value

   319

   320

            # Signal to debug variable panel to refresh

   321

            self.Parent.HasNewData = True

   322

   323

    def GetValue(self, tick=None, raw=False):

   324

        """

   325

        Return current value or value and forced flag for tick given

   326

        @return: Current value or value and forced flag

   327

        """

   328

        # If tick given and stored data option enabled

   329

        if tick is not None and self.Data is not None:

   330

   331

            # Return current value and forced flag if data empty

   332

            if len(self.Data) == 0:

   333

                return self.Value, self.IsForced()

   334

   335

            # Get index of nearest data from tick given

   336

            idx = self.GetNearestData(tick, 0)

   337

   338

            # Get value and forced flag at given index

   339

            value, forced = \

   340

                self.RawData[int(self.Data[idx, 2])] \

   341

                if self.VariableType in ["STRING", "WSTRING"] \

   342

                else self.Data[idx, 1:3]

   343

   344

            # Get raw value if asked

   345

            if not raw:

   346

                value = TYPE_TRANSLATOR.get(

   347

                    self.VariableType, str)(value)

   348

   349

            return value, forced

   350

   351

        # Return raw value if asked

   352

        if not raw and self.VariableType in ["STRING", "WSTRING"]:

   353

            return TYPE_TRANSLATOR.get(

   354

                self.VariableType, str)(self.Value)

   355

        return self.Value

   356

   357

    def GetNearestData(self, tick, adjust):

   358

        """

   359

        Return index of nearest data from tick given

   360

        @param tick: Tick where find nearest data

   361

        @param adjust: Constraint for data position from tick

   362

                       -1: older than tick

   363

                       1:  newer than tick

   364

                       0:  doesn't matter

   365

        @return: Index of nearest data

   366

        """

   367

        # Return immediately if data is empty

   368

        if self.Data is None:

   369

            return None

   370

   371

        # Extract data ticks

   372

        ticks = self.Data[:, 0]

   373

   374

        # Get nearest data from tick

   375

        idx = numpy.argmin(abs(ticks - tick))

   376

   377

        # Adjust data index according to constraint

   378

        if adjust < 0 and ticks[idx] > tick and idx > 0 or \

   379

           adjust > 0 and ticks[idx] < tick and idx < len(ticks):

   380

            idx += adjust

   381

   382

        return idx