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 binascii

    26

import numpy

    27

from graphics.DebugDataConsumer import DebugDataConsumer, TYPE_TRANSLATOR

    28

    29

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

    30

#                 Constant for calculate CRC for string variables

    31

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

    32

    33

STRING_CRC_SIZE = 8

    34

STRING_CRC_MASK = 2 ** STRING_CRC_SIZE - 1

    35

    36

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

    37

#                          Debug Variable Item Class

    38

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

    39

    40

    41

class DebugVariableItem(DebugDataConsumer):

    42

    """

    43

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

    44

    stores received values for displaying them in graphic panel or table

    45

    """

    46

    47

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

    48

        """

    49

        Constructor

    50

        @param parent: Reference to debug variable panel

    51

        @param variable: Path of variable to debug

    52

        """

    53

        DebugDataConsumer.__init__(self)

    54

    55

        self.Parent = parent

    56

        self.Variable = variable

    57

        self.StoreData = store_data

    58

    59

        # Get Variable data type

    60

        self.RefreshVariableType()

    61

    62

    def __del__(self):

    63

        """

    64

        Destructor

    65

        """

    66

        # Reset reference to debug variable panel

    67

        self.Parent = None

    68

    69

    def SetVariable(self, variable):

    70

        """

    71

        Set path of variable

    72

        @param variable: Path of variable to debug

    73

        """

    74

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

    75

            # Store variable path

    76

            self.Variable = variable

    77

            # Get Variable data type

    78

            self.RefreshVariableType()

    79

    80

            # Refresh debug variable panel

    81

            self.Parent.RefreshView()

    82

    83

    def GetVariable(self, mask=None):

    84

        """

    85

        Return path of variable

    86

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

    87

        @return: String containing masked variable path

    88

        """

    89

        # Apply mask to variable name

    90

        if mask is not None:

    91

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

    92

    93

            # Extract variable path parts

    94

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

    95

            # Adjust mask size to size of variable path

    96

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

    97

    98

            # Store previous mask

    99

            last = None

   100

            # Init masked variable path

   101

            variable = ""

   102

   103

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

   104

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

   105

                # wasn't masked

   106

                if m == '*':

   107

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

   108

   109

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

   110

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

   111

                    variable += '..'

   112

   113

                last = m

   114

   115

            return variable

   116

   117

        return self.Variable

   118

   119

    def RefreshVariableType(self):

   120

        """

   121

        Get and store variable data type

   122

        """

   123

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

   124

        # Reset data stored

   125

        self.ResetData()

   126

   127

    def GetVariableType(self):

   128

        """

   129

        Return variable data type

   130

        @return: Variable data type

   131

        """

   132

        return self.VariableType

   133

   134

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

   135

        """

   136

        Return data stored contained in given range

   137

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

   138

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

   139

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

   140

        """

   141

        # Return immediately if data empty or none

   142

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

   143

            return self.Data

   144

   145

        # Find nearest data outside given range indexes

   146

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

   147

                     if start_tick is not None

   148

                     else 0)

   149

        end_idx = (self.GetNearestData(end_tick, 1)

   150

                   if end_tick is not None

   151

                   else len(self.Data))

   152

   153

        # Return data between indexes

   154

        return self.Data[start_idx:end_idx]

   155

   156

    def GetRawValue(self, index):

   157

        """

   158

        Return raw value at given index for string variables

   159

        @param index: Variable value index

   160

        @return: Variable data type

   161

        """

   162

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

   163

            return self.RawData[index][0]

   164

        return ""

   165

   166

    def GetValueRange(self):

   167

        """

   168

        Return variable value range

   169

        @return: (minimum_value, maximum_value)

   170

        """

   171

        return self.MinValue, self.MaxValue

   172

   173

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

   174

        """

   175

        Return variable data and value range for a given tick range

   176

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

   177

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

   178

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

   179

        calculated on data in given range)

   180

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

   181

                  min_value, max_value)

   182

        """

   183

        # Get data in given tick range

   184

        data = self.GetData(start_tick, end_tick)

   185

   186

        # Value range is calculated on whole data

   187

        if full_range:

   188

            return data, self.MinValue, self.MaxValue

   189

   190

        # Check that data in given range is not empty

   191

        values = data[:, 1]

   192

        if len(values) > 0:

   193

            # Return value range for data in given tick range

   194

            return (data,

   195

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

   196

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

   197

   198

        # Return default values

   199

        return data, None, None

   200

   201

    def ResetData(self):

   202

        """

   203

        Reset data stored when store data option enabled

   204

        """

   205

        if self.StoreData and self.IsNumVariable():

   206

            # Init table storing data

   207

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

   208

   209

            # Init table storing raw data if variable is strin

   210

            self.RawData = ([]

   211

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

   212

                            else None)

   213

   214

            # Init Value range variables

   215

            self.MinValue = None

   216

            self.MaxValue = None

   217

   218

        else:

   219

            self.Data = None

   220

   221

        # Init variable value

   222

        self.Value = ""

   223

   224

    def IsNumVariable(self):

   225

        """

   226

        Return if variable data type is numeric. String variables are

   227

        considered as numeric (string CRC)

   228

        @return: True if data type is numeric

   229

        """

   230

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

   231

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

   232

   233

    def NewValues(self, ticks, values):

   234

        """

   235

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

   236

        @param tick: PLC tick when value was captured

   237

        @param value: Value captured

   238

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

   239

        """

   240

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

   241

   242

        if self.Data is not None:

   243

   244

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

   245

                last_raw_data = (self.RawData[-1]

   246

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

   247

                last_raw_data_idx = len(self.RawData) - 1

   248

   249

            data_values = []

   250

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

   251

                # Translate forced flag to float for storing in Data table

   252

                forced_value = float(forced)

   253

   254

                # String data value is CRC

   255

                num_value = (binascii.crc32(value) & STRING_CRC_MASK

   256

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

   257

                             else float(value))

   258

   259

                # Update variable range values

   260

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

   261

                                 if self.MinValue is not None

   262

                                 else num_value)

   263

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

   264

                                 if self.MaxValue is not None

   265

                                 else num_value)

   266

   267

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

   268

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

   269

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

   270

                # data third column

   271

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

   272

                    raw_data = (value, forced_value)

   273

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

   274

                        last_raw_data_idx += 1

   275

                        last_raw_data = raw_data

   276

                        self.RawData.append(raw_data)

   277

                    extra_value = last_raw_data_idx

   278

   279

                # In other case, data third column is forced flag

   280

                else:

   281

                    extra_value = forced_value

   282

   283

                data_values.append(

   284

                    [float(tick), num_value, extra_value])

   285

   286

            # Add New data to stored data table

   287

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

   288

   289

            # Signal to debug variable panel to refresh

   290

            self.Parent.HasNewData = True

   291

   292

    def SetForced(self, forced):

   293

        """

   294

        Update Forced flag

   295

        @param forced: New forced flag

   296

        """

   297

        # Store forced flag

   298

        if self.Forced != forced:

   299

            self.Forced = forced

   300

   301

            # Signal to debug variable panel to refresh

   302

            self.Parent.HasNewData = True

   303

   304

    def SetValue(self, value):

   305

        """

   306

        Update value.

   307

        @param value: New value

   308

        """

   309

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

   310

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

   311

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

   312

            value = value[1:-1]

   313

   314

        # Store variable value

   315

        if self.Value != value:

   316

            self.Value = value

   317

   318

            # Signal to debug variable panel to refresh

   319

            self.Parent.HasNewData = True

   320

   321

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

   322

        """

   323

        Return current value or value and forced flag for tick given

   324

        @return: Current value or value and forced flag

   325

        """

   326

        # If tick given and stored data option enabled

   327

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

   328

   329

            # Return current value and forced flag if data empty

   330

            if len(self.Data) == 0:

   331

                return self.Value, self.IsForced()

   332

   333

            # Get index of nearest data from tick given

   334

            idx = self.GetNearestData(tick, 0)

   335

   336

            # Get value and forced flag at given index

   337

            value, forced = \

   338

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

   339

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

   340

                else self.Data[idx, 1:3]

   341

   342

            # Get raw value if asked

   343

            if not raw:

   344

                value = TYPE_TRANSLATOR.get(

   345

                        self.VariableType, str)(value)

   346

   347

            return value, forced

   348

   349

        # Return raw value if asked

   350

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

   351

            return TYPE_TRANSLATOR.get(

   352

                    self.VariableType, str)(self.Value)

   353

        return self.Value

   354

   355

    def GetNearestData(self, tick, adjust):

   356

        """

   357

        Return index of nearest data from tick given

   358

        @param tick: Tick where find nearest data

   359

        @param adjust: Constraint for data position from tick

   360

                       -1: older than tick

   361

                       1:  newer than tick

   362

                       0:  doesn't matter

   363

        @return: Index of nearest data

   364

        """

   365

        # Return immediately if data is empty

   366

        if self.Data is None:

   367

            return None

   368

   369

        # Extract data ticks

   370

        ticks = self.Data[:, 0]

   371

   372

        # Get nearest data from tick

   373

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

   374

   375

        # Adjust data index according to constraint

   376

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

   377

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

   378

            idx += adjust

   379

   380

        return idx