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 datetime import timedelta

    28

import binascii

    29

import numpy

    30

from graphics.DebugDataConsumer import DebugDataConsumer, TYPE_TRANSLATOR

    31

    32

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

    33

#                 Constant for calculate CRC for string variables

    34

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

    35

    36

STRING_CRC_SIZE = 8

    37

STRING_CRC_MASK = 2 ** STRING_CRC_SIZE - 1

    38

    39

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

    40

#                          Debug Variable Item Class

    41

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

    42

    43

    44

class DebugVariableItem(DebugDataConsumer):

    45

    """

    46

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

    47

    stores received values for displaying them in graphic panel or table

    48

    """

    49

    50

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

    51

        """

    52

        Constructor

    53

        @param parent: Reference to debug variable panel

    54

        @param variable: Path of variable to debug

    55

        """

    56

        DebugDataConsumer.__init__(self)

    57

    58

        self.Parent = parent

    59

        self.Variable = variable

    60

        self.StoreData = store_data

    61

    62

        # Get Variable data type

    63

        self.RefreshVariableType()

    64

    65

    def __del__(self):

    66

        """

    67

        Destructor

    68

        """

    69

        # Reset reference to debug variable panel

    70

        self.Parent = None

    71

    72

    def SetVariable(self, variable):

    73

        """

    74

        Set path of variable

    75

        @param variable: Path of variable to debug

    76

        """

    77

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

    78

            # Store variable path

    79

            self.Variable = variable

    80

            # Get Variable data type

    81

            self.RefreshVariableType()

    82

    83

            # Refresh debug variable panel

    84

            self.Parent.RefreshView()

    85

    86

    def GetVariable(self, mask=None):

    87

        """

    88

        Return path of variable

    89

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

    90

        @return: String containing masked variable path

    91

        """

    92

        # Apply mask to variable name

    93

        if mask is not None:

    94

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

    95

    96

            # Extract variable path parts

    97

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

    98

            # Adjust mask size to size of variable path

    99

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

   100

   101

            # Store previous mask

   102

            last = None

   103

            # Init masked variable path

   104

            variable = ""

   105

   106

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

   107

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

   108

                # wasn't masked

   109

                if m == '*':

   110

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

   111

   112

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

   113

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

   114

                    variable += '..'

   115

   116

                last = m

   117

   118

            return variable

   119

   120

        return self.Variable

   121

   122

    def RefreshVariableType(self):

   123

        """

   124

        Get and store variable data type

   125

        """

   126

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

   127

        # Reset data stored

   128

        self.ResetData()

   129

   130

    def GetVariableType(self):

   131

        """

   132

        Return variable data type

   133

        @return: Variable data type

   134

        """

   135

        return self.VariableType

   136

   137

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

   138

        """

   139

        Return data stored contained in given range

   140

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

   141

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

   142

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

   143

        """

   144

        # Return immediately if data empty or none

   145

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

   146

            return self.Data

   147

   148

        # Find nearest data outside given range indexes

   149

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

   150

                     if start_tick is not None

   151

                     else 0)

   152

        end_idx = (self.GetNearestData(end_tick, 1)

   153

                   if end_tick is not None

   154

                   else len(self.Data))

   155

   156

        # Return data between indexes

   157

        return self.Data[start_idx:end_idx]

   158

   159

    def GetRawValue(self, index):

   160

        """

   161

        Return raw value at given index for string variables

   162

        @param index: Variable value index

   163

        @return: Variable data type

   164

        """

   165

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

   166

            return self.RawData[index][0]

   167

        return ""

   168

   169

    def GetValueRange(self):

   170

        """

   171

        Return variable value range

   172

        @return: (minimum_value, maximum_value)

   173

        """

   174

        return self.MinValue, self.MaxValue

   175

   176

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

   177

        """

   178

        Return variable data and value range for a given tick range

   179

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

   180

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

   181

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

   182

        calculated on data in given range)

   183

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

   184

                  min_value, max_value)

   185

        """

   186

        # Get data in given tick range

   187

        data = self.GetData(start_tick, end_tick)

   188

   189

        # Value range is calculated on whole data

   190

        if full_range:

   191

            return data, self.MinValue, self.MaxValue

   192

   193

        # Check that data in given range is not empty

   194

        values = data[:, 1]

   195

        if len(values) > 0:

   196

            # Return value range for data in given tick range

   197

            return (data,

   198

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

   199

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

   200

   201

        # Return default values

   202

        return data, None, None

   203

   204

    def ResetData(self):

   205

        """

   206

        Reset data stored when store data option enabled

   207

        """

   208

        if self.StoreData and self.IsNumVariable():

   209

            # Init table storing data

   210

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

   211

   212

            # Init table storing raw data if variable is strin

   213

            self.RawData = ([]

   214

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

   215

                            else None)

   216

   217

            # Init Value range variables

   218

            self.MinValue = None

   219

            self.MaxValue = None

   220

   221

        else:

   222

            self.Data = None

   223

            self.MinValue = None

   224

            self.MaxValue = None

   225

        # Init variable value

   226

        self.Value = ""

   227

   228

    def IsNumVariable(self):

   229

        """

   230

        Return if variable data type is numeric. String variables are

   231

        considered as numeric (string CRC). Time variables are considered

   232

        as number of seconds

   233

        @return: True if data type is numeric

   234

        """

   235

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

   236

                self.VariableType in ["STRING", "WSTRING", "TIME", "TOD", "DT", "DATE"])

   237

   238

    def NewValues(self, ticks, values):

   239

        """

   240

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

   241

        @param tick: PLC tick when value was captured

   242

        @param value: Value captured

   243

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

   244

        """

   245

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

   246

   247

        if self.Data is not None:

   248

   249

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

   250

                last_raw_data = (self.RawData[-1]

   251

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

   252

                last_raw_data_idx = len(self.RawData) - 1

   253

   254

            data_values = []

   255

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

   256

                # Translate forced flag to float for storing in Data table

   257

                forced_value = float(forced)

   258

   259

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

   260

                    # String data value is CRC

   261

                    num_value = (binascii.crc32(value) & STRING_CRC_MASK)

   262

                elif self.VariableType in ["TIME", "TOD", "DT", "DATE"]:

   263

                    # Numeric value of time type variables

   264

                    # is represented in seconds

   265

                    num_value = float(value.total_seconds())

   266

                else:

   267

                    num_value = float(value)

   268

   269

                # Update variable range values

   270

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

   271

                                 if self.MinValue is not None

   272

                                 else num_value)

   273

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

   274

                                 if self.MaxValue is not None

   275

                                 else num_value)

   276

   277

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

   278

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

   279

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

   280

                # data third column

   281

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

   282

                    raw_data = (value, forced_value)

   283

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

   284

                        last_raw_data_idx += 1

   285

                        last_raw_data = raw_data

   286

                        self.RawData.append(raw_data)

   287

                    extra_value = last_raw_data_idx

   288

   289

                # In other case, data third column is forced flag

   290

                else:

   291

                    extra_value = forced_value

   292

   293

                data_values.append(

   294

                    [float(tick), num_value, extra_value])

   295

   296

            # Add New data to stored data table

   297

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

   298

   299

            # Signal to debug variable panel to refresh

   300

            self.Parent.HasNewData = True

   301

   302

    def SetForced(self, forced):

   303

        """

   304

        Update Forced flag

   305

        @param forced: New forced flag

   306

        """

   307

        # Store forced flag

   308

        if self.Forced != forced:

   309

            self.Forced = forced

   310

   311

            # Signal to debug variable panel to refresh

   312

            self.Parent.HasNewData = True

   313

   314

    def SetValue(self, value):

   315

        """

   316

        Update value.

   317

        @param value: New value

   318

        """

   319

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

   320

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

   321

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

   322

            value = value[1:-1]

   323

   324

        # Store variable value

   325

        if self.Value != value:

   326

            self.Value = value

   327

   328

            # Signal to debug variable panel to refresh

   329

            self.Parent.HasNewData = True

   330

   331

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

   332

        """

   333

        Return current value or value and forced flag for tick given

   334

        @return: Current value or value and forced flag

   335

        """

   336

        # If tick given and stored data option enabled

   337

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

   338

   339

            # Return current value and forced flag if data empty

   340

            if len(self.Data) == 0:

   341

                return self.Value, self.IsForced()

   342

   343

            # Get index of nearest data from tick given

   344

            idx = self.GetNearestData(tick, 0)

   345

   346

            # Get value and forced flag at given index

   347

            value, forced = \

   348

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

   349

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

   350

                else self.Data[idx, 1:3]

   351

   352

            if self.VariableType in ["TIME", "TOD", "DT", "DATE"]:

   353

                value = timedelta(seconds=value)

   354

   355

            # Get raw value if asked

   356

            if not raw:

   357

                value = TYPE_TRANSLATOR.get(

   358

                    self.VariableType, str)(value)

   359

   360

            return value, forced

   361

   362

        # Return raw value if asked

   363

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

   364

            return TYPE_TRANSLATOR.get(

   365

                self.VariableType, str)(self.Value)

   366

        return self.Value

   367

   368

    def GetNearestData(self, tick, adjust):

   369

        """

   370

        Return index of nearest data from tick given

   371

        @param tick: Tick where find nearest data

   372

        @param adjust: Constraint for data position from tick

   373

                       -1: older than tick

   374

                       1:  newer than tick

   375

                       0:  doesn't matter

   376

        @return: Index of nearest data

   377

        """

   378

        # Return immediately if data is empty

   379

        if self.Data is None:

   380

            return None

   381

   382

        # Extract data ticks

   383

        ticks = self.Data[:, 0]

   384

   385

        # Get nearest data from tick

   386

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

   387

   388

        # Adjust data index according to constraint

   389

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

   390

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

   391

            idx += adjust

   392

   393

        return idx