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

    27

from datetime import timedelta

    28

import binascii

    29

import numpy as np

    30

from graphics.DebugDataConsumer import DebugDataConsumer, TYPE_TRANSLATOR

    31

from controls.DebugVariablePanel.RingBuffer import RingBuffer

    32

    33

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

    34

#                 Constant for calculate CRC for string variables

    35

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

    36

    37

STRING_CRC_SIZE = 8

    38

STRING_CRC_MASK = 2 ** STRING_CRC_SIZE - 1

    39

    40

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

    41

#                          Debug Variable Item Class

    42

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

    43

    44

    45

class DebugVariableItem(DebugDataConsumer):

    46

    """

    47

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

    48

    stores received values for displaying them in graphic panel or table

    49

    """

    50

    51

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

    52

        """

    53

        Constructor

    54

        @param parent: Reference to debug variable panel

    55

        @param variable: Path of variable to debug

    56

        """

    57

        DebugDataConsumer.__init__(self)

    58

    59

        self.Parent = parent

    60

        self.Variable = variable

    61

        self.StoreData = store_data

    62

    63

        # Get Variable data type

    64

        self.RefreshVariableType()

    65

    66

    def SetVariable(self, variable):

    67

        """

    68

        Set path of variable

    69

        @param variable: Path of variable to debug

    70

        """

    71

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

    72

            # Store variable path

    73

            self.Variable = variable

    74

            # Get Variable data type

    75

            self.RefreshVariableType()

    76

    77

            # Refresh debug variable panel

    78

            self.Parent.RefreshView()

    79

    80

    def GetVariable(self, mask=None):

    81

        """

    82

        Return path of variable

    83

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

    84

        @return: String containing masked variable path

    85

        """

    86

        # Apply mask to variable name

    87

        if mask is not None:

    88

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

    89

    90

            # Extract variable path parts

    91

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

    92

            # Adjust mask size to size of variable path

    93

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

    94

    95

            # Store previous mask

    96

            last = None

    97

            # Init masked variable path

    98

            variable = ""

    99

   100

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

   101

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

   102

                # wasn't masked

   103

                if m == '*':

   104

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

   105

   106

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

   107

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

   108

                    variable += '..'

   109

   110

                last = m

   111

   112

            return variable

   113

   114

        return self.Variable

   115

   116

    def RefreshVariableType(self):

   117

        """

   118

        Get and store variable data type

   119

        """

   120

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

   121

        # Reset data stored

   122

        self.ResetData()

   123

   124

    def GetVariableType(self):

   125

        """

   126

        Return variable data type

   127

        @return: Variable data type

   128

        """

   129

        return self.VariableType

   130

   131

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

   132

        """

   133

        Return data stored contained in given range

   134

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

   135

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

   136

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

   137

        """

   138

        # Return immediately if data empty or none

   139

        if self.Data is None or self.Data.count == 0:

   140

            return None

   141

   142

        # Find nearest data outside given range indexes

   143

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

   144

                     if start_tick is not None

   145

                     else 0)

   146

        end_idx = (self.GetNearestData(end_tick, 1)

   147

                   if end_tick is not None

   148

                   else self.Data.count)

   149

   150

        # Return data between indexes

   151

        return self.Data.view[start_idx:end_idx]

   152

   153

    def GetRawValue(self, index):

   154

        """

   155

        Return raw value at given index for string variables

   156

        @param index: Variable value index

   157

        @return: Variable data type

   158

        """

   159

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

   160

            return self.RawData[index][0]

   161

        return ""

   162

   163

    def GetValueRange(self):

   164

        """

   165

        Return variable value range

   166

        @return: (minimum_value, maximum_value)

   167

        """

   168

        return self.MinValue, self.MaxValue

   169

   170

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

   171

        """

   172

        Return variable data and value range for a given tick range

   173

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

   174

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

   175

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

   176

        calculated on data in given range)

   177

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

   178

                  min_value, max_value)

   179

        """

   180

        # Get data in given tick range

   181

        data = self.GetData(start_tick, end_tick)

   182

   183

        if data is None:

   184

            return None, None, None

   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[np.argmin(values), 1],

   196

                    data[np.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 = RingBuffer(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

            self.MinValue = None

   221

            self.MaxValue = None

   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). Time variables are considered

   229

        as number of seconds

   230

        @return: True if data type is numeric

   231

        """

   232

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

   233

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

   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

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

   257

                    # String data value is CRC

   258

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

   259

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

   260

                    # Numeric value of time type variables

   261

                    # is represented in seconds

   262

                    num_value = float(value.total_seconds())

   263

                else:

   264

                    num_value = float(value)

   265

   266

                # Update variable range values

   267

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

   268

                                 if self.MinValue is not None

   269

                                 else num_value)

   270

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

   271

                                 if self.MaxValue is not None

   272

                                 else num_value)

   273

   274

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

   275

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

   276

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

   277

                # data third column

   278

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

   279

                    raw_data = (value, forced_value)

   280

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

   281

                        last_raw_data_idx += 1

   282

                        last_raw_data = raw_data

   283

                        self.RawData.append(raw_data)

   284

                    extra_value = last_raw_data_idx

   285

   286

                # In other case, data third column is forced flag

   287

                else:

   288

                    extra_value = forced_value

   289

   290

                data_values.append(

   291

                    [float(tick), num_value, extra_value])

   292

   293

            # Add New data to stored data table

   294

            self.Data.append(data_values)

   295

   296

            # Signal to debug variable panel to refresh

   297

            self.Parent.HasNewData = True

   298

   299

    def SetForced(self, forced):

   300

        """

   301

        Update Forced flag

   302

        @param forced: New forced flag

   303

        """

   304

        # Store forced flag

   305

        if self.Forced != forced:

   306

            self.Forced = forced

   307

   308

            # Signal to debug variable panel to refresh

   309

            self.Parent.HasNewData = True

   310

   311

    def SetValue(self, value):

   312

        """

   313

        Update value.

   314

        @param value: New value

   315

        """

   316

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

   317

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

   318

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

   319

            value = value[1:-1]

   320

   321

        # Store variable value

   322

        if self.Value != value:

   323

            self.Value = value

   324

   325

            # Signal to debug variable panel to refresh

   326

            self.Parent.HasNewData = True

   327

   328

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

   329

        """

   330

        Return current value or value and forced flag for tick given

   331

        @return: Current value or value and forced flag

   332

        """

   333

        # If tick given and stored data option enabled

   334

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

   335

   336

            # Return current value and forced flag if data empty

   337

            if self.Data.count == 0:

   338

                return self.Value, self.IsForced()

   339

   340

            # Get index of nearest data from tick given

   341

            idx = self.GetNearestData(tick, 0)

   342

   343

            # Get value and forced flag at given index

   344

            value, forced = \

   345

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

   346

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

   347

                else self.Data.view[idx, 1:3]

   348

   349

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

   350

                value = timedelta(seconds=value)

   351

   352

            # Get raw value if asked

   353

            if not raw:

   354

                value = TYPE_TRANSLATOR.get(

   355

                    self.VariableType, str)(value)

   356

   357

            return value, forced

   358

   359

        # Return raw value if asked

   360

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

   361

            return TYPE_TRANSLATOR.get(

   362

                self.VariableType, str)(self.Value)

   363

        return self.Value

   364

   365

    def GetNearestData(self, tick, adjust):

   366

        """

   367

        Return index of nearest data from tick given

   368

        @param tick: Tick where find nearest data

   369

        @param adjust: Constraint for data position from tick

   370

                       -1: older than tick

   371

                       1:  newer than tick

   372

                       0:  doesn't matter

   373

        @return: Index of nearest data

   374

        """

   375

        # Return immediately if data is empty

   376

        if self.Data is None:

   377

            return None

   378

   379

        # Extract data ticks

   380

        ticks = self.Data.view[:, 0]

   381

   382

        # Get nearest data from tick

   383

        idx = min(np.searchsorted(ticks, tick), self.Data.count - 1)

   384

   385

        # Adjust data index according to constraint

   386

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

   387

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

   388

            idx += adjust

   389

   390

        return idx