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

import numpy

    26

import binascii

    27

    28

from graphics.DebugDataConsumer import DebugDataConsumer, TYPE_TRANSLATOR

    29

    30

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

    31

#                 Constant for calculate CRC for string variables

    32

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

    33

    34

STRING_CRC_SIZE = 8

    35

STRING_CRC_MASK = 2 ** STRING_CRC_SIZE - 1

    36

    37

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

    38

#                          Debug Variable Item Class

    39

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

    40

    41

    42

class DebugVariableItem(DebugDataConsumer):

    43

    """

    44

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

    45

    stores received values for displaying them in graphic panel or table

    46

    """

    47

    48

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

    49

        """

    50

        Constructor

    51

        @param parent: Reference to debug variable panel

    52

        @param variable: Path of variable to debug

    53

        """

    54

        DebugDataConsumer.__init__(self)

    55

    56

        self.Parent = parent

    57

        self.Variable = variable

    58

        self.StoreData = store_data

    59

    60

        # Get Variable data type

    61

        self.RefreshVariableType()

    62

    63

    def __del__(self):

    64

        """

    65

        Destructor

    66

        """

    67

        # Reset reference to debug variable panel

    68

        self.Parent = None

    69

    70

    def SetVariable(self, variable):

    71

        """

    72

        Set path of variable

    73

        @param variable: Path of variable to debug

    74

        """

    75

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

    76

            # Store variable path

    77

            self.Variable = variable

    78

            # Get Variable data type

    79

            self.RefreshVariableType()

    80

    81

            # Refresh debug variable panel

    82

            self.Parent.RefreshView()

    83

    84

    def GetVariable(self, mask=None):

    85

        """

    86

        Return path of variable

    87

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

    88

        @return: String containing masked variable path

    89

        """

    90

        # Apply mask to variable name

    91

        if mask is not None:

    92

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

    93

    94

            # Extract variable path parts

    95

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

    96

            # Adjust mask size to size of variable path

    97

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

    98

    99

            # Store previous mask

   100

            last = None

   101

            # Init masked variable path

   102

            variable = ""

   103

   104

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

   105

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

   106

                # wasn't masked

   107

                if m == '*':

   108

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

   109

   110

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

   111

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

   112

                    variable += '..'

   113

   114

                last = m

   115

   116

            return variable

   117

   118

        return self.Variable

   119

   120

    def RefreshVariableType(self):

   121

        """

   122

        Get and store variable data type

   123

        """

   124

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

   125

        # Reset data stored

   126

        self.ResetData()

   127

   128

    def GetVariableType(self):

   129

        """

   130

        Return variable data type

   131

        @return: Variable data type

   132

        """

   133

        return self.VariableType

   134

   135

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

   136

        """

   137

        Return data stored contained in given range

   138

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

   139

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

   140

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

   141

        """

   142

        # Return immediately if data empty or none

   143

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

   144

            return self.Data

   145

   146

        # Find nearest data outside given range indexes

   147

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

   148

                     if start_tick is not None

   149

                     else 0)

   150

        end_idx = (self.GetNearestData(end_tick, 1)

   151

                   if end_tick is not None

   152

                   else len(self.Data))

   153

   154

        # Return data between indexes

   155

        return self.Data[start_idx:end_idx]

   156

   157

    def GetRawValue(self, index):

   158

        """

   159

        Return raw value at given index for string variables

   160

        @param index: Variable value index

   161

        @return: Variable data type

   162

        """

   163

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

   164

            return self.RawData[index][0]

   165

        return ""

   166

   167

    def GetValueRange(self):

   168

        """

   169

        Return variable value range

   170

        @return: (minimum_value, maximum_value)

   171

        """

   172

        return self.MinValue, self.MaxValue

   173

   174

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

   175

        """

   176

        Return variable data and value range for a given tick range

   177

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

   178

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

   179

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

   180

        calculated on data in given range)

   181

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

   182

                  min_value, max_value)

   183

        """

   184

        # Get data in given tick range

   185

        data = self.GetData(start_tick, end_tick)

   186

   187

        # Value range is calculated on whole data

   188

        if full_range:

   189

            return data, self.MinValue, self.MaxValue

   190

   191

        # Check that data in given range is not empty

   192

        values = data[:, 1]

   193

        if len(values) > 0:

   194

            # Return value range for data in given tick range

   195

            return (data,

   196

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

   197

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

   198

   199

        # Return default values

   200

        return data, None, None

   201

   202

    def ResetData(self):

   203

        """

   204

        Reset data stored when store data option enabled

   205

        """

   206

        if self.StoreData and self.IsNumVariable():

   207

            # Init table storing data

   208

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

   209

   210

            # Init table storing raw data if variable is strin

   211

            self.RawData = ([]

   212

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

   213

                            else None)

   214

   215

            # Init Value range variables

   216

            self.MinValue = None

   217

            self.MaxValue = None

   218

   219

        else:

   220

            self.Data = None

   221

   222

        # Init variable value

   223

        self.Value = ""

   224

   225

    def IsNumVariable(self):

   226

        """

   227

        Return if variable data type is numeric. String variables are

   228

        considered as numeric (string CRC)

   229

        @return: True if data type is numeric

   230

        """

   231

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

   232

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

   233

   234

    def NewValues(self, ticks, values):

   235

        """

   236

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

   237

        @param tick: PLC tick when value was captured

   238

        @param value: Value captured

   239

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

   240

        """

   241

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

   242

   243

        if self.Data is not None:

   244

   245

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

   246

                last_raw_data = (self.RawData[-1]

   247

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

   248

                last_raw_data_idx = len(self.RawData) - 1

   249

   250

            data_values = []

   251

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

   252

                # Translate forced flag to float for storing in Data table

   253

                forced_value = float(forced)

   254

   255

                # String data value is CRC

   256

                num_value = (binascii.crc32(value) & STRING_CRC_MASK

   257

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

   258

                             else float(value))

   259

   260

                # Update variable range values

   261

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

   262

                                 if self.MinValue is not None

   263

                                 else num_value)

   264

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

   265

                                 if self.MaxValue is not None

   266

                                 else num_value)

   267

   268

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

   269

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

   270

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

   271

                # data third column

   272

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

   273

                    raw_data = (value, forced_value)

   274

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

   275

                        last_raw_data_idx += 1

   276

                        last_raw_data = raw_data

   277

                        self.RawData.append(raw_data)

   278

                    extra_value = last_raw_data_idx

   279

   280

                # In other case, data third column is forced flag

   281

                else:

   282

                    extra_value = forced_value

   283

   284

                data_values.append(

   285

                    [float(tick), num_value, extra_value])

   286

   287

            # Add New data to stored data table

   288

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

   289

   290

            # Signal to debug variable panel to refresh

   291

            self.Parent.HasNewData = True

   292

   293

    def SetForced(self, forced):

   294

        """

   295

        Update Forced flag

   296

        @param forced: New forced flag

   297

        """

   298

        # Store forced flag

   299

        if self.Forced != forced:

   300

            self.Forced = forced

   301

   302

            # Signal to debug variable panel to refresh

   303

            self.Parent.HasNewData = True

   304

   305

    def SetValue(self, value):

   306

        """

   307

        Update value.

   308

        @param value: New value

   309

        """

   310

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

   311

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

   312

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

   313

            value = value[1:-1]

   314

   315

        # Store variable value

   316

        if self.Value != value:

   317

            self.Value = value

   318

   319

            # Signal to debug variable panel to refresh

   320

            self.Parent.HasNewData = True

   321

   322

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

   323

        """

   324

        Return current value or value and forced flag for tick given

   325

        @return: Current value or value and forced flag

   326

        """

   327

        # If tick given and stored data option enabled

   328

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

   329

   330

            # Return current value and forced flag if data empty

   331

            if len(self.Data) == 0:

   332

                return self.Value, self.IsForced()

   333

   334

            # Get index of nearest data from tick given

   335

            idx = self.GetNearestData(tick, 0)

   336

   337

            # Get value and forced flag at given index

   338

            value, forced = \

   339

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

   340

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

   341

                else self.Data[idx, 1:3]

   342

   343

            # Get raw value if asked

   344

            if not raw:

   345

                value = TYPE_TRANSLATOR.get(

   346

                        self.VariableType, str)(value)

   347

   348

            return value, forced

   349

   350

        # Return raw value if asked

   351

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

   352

            return TYPE_TRANSLATOR.get(

   353

                    self.VariableType, str)(self.Value)

   354

        return self.Value

   355

   356

    def GetNearestData(self, tick, adjust):

   357

        """

   358

        Return index of nearest data from tick given

   359

        @param tick: Tick where find nearest data

   360

        @param adjust: Constraint for data position from tick

   361

                       -1: older than tick

   362

                       1:  newer than tick

   363

                       0:  doesn't matter

   364

        @return: Index of nearest data

   365

        """

   366

        # Return immediately if data is empty

   367

        if self.Data is None:

   368

            return None

   369

   370

        # Extract data ticks

   371

        ticks = self.Data[:, 0]

   372

   373

        # Get nearest data from tick

   374

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

   375

   376

        # Adjust data index according to constraint

   377

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

   378

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

   379

            idx += adjust

   380

   381

        return idx