1

from __future__ import print_function

     2

from __future__ import absolute_import

     3

     4

import csv

     5

     6

from opcua import Client

     7

from opcua import ua

     8

     9

import wx

    10

import wx.lib.gizmos as gizmos  # Formerly wx.gizmos in Classic

    11

import wx.dataview as dv

    12

    13

    14

UA_IEC_types = dict(

    15

#   pyopcua | IEC61131|  C  type  | sz |  open62541  enum  | open62541

    16

    Boolean = ("BOOL" , "uint8_t" , "X", "UA_TYPES_BOOLEAN", "UA_Boolean"),

    17

    SByte   = ("SINT" , "int8_t"  , "B", "UA_TYPES_SBYTE"  , "UA_SByte"  ),

    18

    Byte    = ("USINT", "uint8_t" , "B", "UA_TYPES_BYTE"   , "UA_Byte"   ),

    19

    Int16   = ("INT"  , "int16_t" , "W", "UA_TYPES_INT16"  , "UA_Int16"  ),

    20

    UInt16  = ("UINT" , "uint16_t", "W", "UA_TYPES_UINT16" , "UA_UInt16" ),

    21

    Int32   = ("DINT" , "uint32_t", "D", "UA_TYPES_INT32"  , "UA_Int32"  ),

    22

    UInt32  = ("UDINT", "int32_t" , "D", "UA_TYPES_UINT32" , "UA_UInt32" ),

    23

    Int64   = ("LINT" , "int64_t" , "L", "UA_TYPES_INT64"  , "UA_Int64"  ),

    24

    UInt64  = ("ULINT", "uint64_t", "L", "UA_TYPES_UINT64" , "UA_UInt64" ),

    25

    Float   = ("REAL" , "float"   , "D", "UA_TYPES_FLOAT"  , "UA_Float"  ),

    26

    Double  = ("LREAL", "double"  , "L", "UA_TYPES_DOUBLE" , "UA_Double" ),

    27

)

    28

    29

UA_NODE_ID_types = {

    30

    "int"   : ("UA_NODEID_NUMERIC", "{}"  ),

    31

    "str"   : ("UA_NODEID_STRING" , '"{}"'),

    32

    "UUID"  : ("UA_NODEID_UUID"   , '"{}"'),

    33

}

    34

    35

lstcolnames  = [  "Name", "NSIdx", "IdType", "Id", "Type", "IEC"]

    36

lstcolwidths = [     100,      50,      100,  100,    100,    50]

    37

lstcoltypess = [     str,     int,      str,  str,    str,   int]

    38

    39

directions = ["input", "output"]

    40

    41

authParams = {

    42

    "x509":[

    43

        ("Certificate", "certificate.der"),

    44

        ("PrivateKey", "private_key.pem"),

    45

        ("Policy", "Basic256Sha256"),

    48

    "UserPassword":[

    49

        ("User", None),

    50

        ("Password", None)]}

    51

    52

class OPCUASubListModel(dv.DataViewIndexListModel):

    53

    def __init__(self, data, log):

    54

        dv.DataViewIndexListModel.__init__(self, len(data))

    55

        self.data = data

    56

        self.log = log

    57

    58

    def GetColumnType(self, col):

    59

        return "string"

    60

    61

    def GetValueByRow(self, row, col):

    62

        return str(self.data[row][col])

    63

    64

    # This method is called when the user edits a data item in the view.

    65

    def SetValueByRow(self, value, row, col):

    66

        expectedtype = lstcoltypess[col]

    67

    68

        try:

    69

            v = expectedtype(value)

    70

        except ValueError: 

    71

            self.log("String {} is invalid for type {}\n".format(value,expectedtype.__name__))

    72

            return False

    73

    74

        if col == lstcolnames.index("IdType") and v not in UA_NODE_ID_types:

    75

            self.log("{} is invalid for IdType\n".format(value))

    76

            return False

    77

    78

        self.data[row][col] = v

    79

        return True

    80

    81

    # Report how many columns this model provides data for.

    82

    def GetColumnCount(self):

    83

        return len(lstcolnames)

    84

    85

    # Report the number of rows in the model

    86

    def GetCount(self):

    87

        #self.log.write('GetCount')

    88

        return len(self.data)

    89

    90

    # Called to check if non-standard attributes should be used in the

    91

    # cell at (row, col)

    92

    def GetAttrByRow(self, row, col, attr):

    93

        if col == 5:

    94

            attr.SetColour('blue')

    95

            attr.SetBold(True)

    96

            return True

    97

        return False

    98

    99

   100

    def DeleteRows(self, rows):

   101

        # make a copy since we'll be sorting(mutating) the list

   102

        # use reverse order so the indexes don't change as we remove items

   103

        rows = sorted(rows, reverse=True)

   104

   105

        for row in rows:

   106

            # remove it from our data structure

   107

            del self.data[row]

   108

            # notify the view(s) using this model that it has been removed

   109

            self.RowDeleted(row)

   110

   111

   112

    def AddRow(self, value):

   113

        if self.data.append(value):

   114

            # notify views

   115

            self.RowAppended()

   116

   117

    def ResetData(self):

   118

        self.Reset(len(self.data))

   119

   120

OPCUAClientDndMagicWord = "text/beremiz-opcuaclient"

   121

   122

class NodeDropTarget(wx.DropTarget):

   123

   124

    def __init__(self, parent):

   125

        data = wx.CustomDataObject(OPCUAClientDndMagicWord)

   126

        wx.DropTarget.__init__(self, data)

   127

        self.ParentWindow = parent

   128

   129

    def OnDrop(self, x, y):

   130

        self.ParentWindow.OnNodeDnD()

   131

        return True

   132

   133

class OPCUASubListPanel(wx.Panel):

   134

    def __init__(self, parent, log, model, direction):

   135

        self.log = log

   136

        wx.Panel.__init__(self, parent, -1)

   137

   138

        self.dvc = dv.DataViewCtrl(self,

   139

                                   style=wx.BORDER_THEME

   140

                                   | dv.DV_ROW_LINES

   141

                                   | dv.DV_HORIZ_RULES

   142

                                   | dv.DV_VERT_RULES

   143

                                   | dv.DV_MULTIPLE

   144

                                   )

   145

   146

        self.model = model

   147

   148

        self.dvc.AssociateModel(self.model)

   149

   150

        for idx,(colname,width) in enumerate(zip(lstcolnames,lstcolwidths)):

   151

            self.dvc.AppendTextColumn(colname,  idx, width=width, mode=dv.DATAVIEW_CELL_EDITABLE)

   152

   153

        DropTarget = NodeDropTarget(self)

   154

        self.dvc.SetDropTarget(DropTarget)

   155

   156

        self.Sizer = wx.BoxSizer(wx.VERTICAL)

   157

   158

        self.direction =  direction

   159

        titlestr = direction + " variables"

   160

   161

        title = wx.StaticText(self, label = titlestr)

   162

   163

        delbt = wx.Button(self, label="Delete Row(s)")

   164

        self.Bind(wx.EVT_BUTTON, self.OnDeleteRows, delbt)

   165

   166

        topsizer = wx.BoxSizer(wx.HORIZONTAL)

   167

        topsizer.Add(title, 1, wx.ALIGN_CENTER_VERTICAL|wx.LEFT|wx.RIGHT, 5)

   168

        topsizer.Add(delbt, 0, wx.LEFT|wx.RIGHT, 5)

   169

        self.Sizer.Add(topsizer, 0, wx.EXPAND|wx.TOP|wx.BOTTOM, 5)

   170

        self.Sizer.Add(self.dvc, 1, wx.EXPAND)

   171

   172

   173

   174

    def OnDeleteRows(self, evt):

   175

        items = self.dvc.GetSelections()

   176

        rows = [self.model.GetRow(item) for item in items]

   177

        self.model.DeleteRows(rows)

   178

   179

   180

    def OnNodeDnD(self):

   181

        # Have to find OPC-UA client extension panel from here 

   182

        # in order to avoid keeping reference (otherwise __del__ isn't called)

   183

        #             splitter.        panel.      splitter

   184

        ClientPanel = self.GetParent().GetParent().GetParent()

   185

        nodes = ClientPanel.GetSelectedNodes()

   186

        for node in nodes:

   187

            cname = node.get_node_class().name

   188

            dname = node.get_display_name().Text

   189

            if cname != "Variable":

   190

                self.log("Node {} ignored (not a variable)".format(dname))

   191

                continue

   192

   193

            tname = node.get_data_type_as_variant_type().name

   194

            if tname not in UA_IEC_types:

   195

                self.log("Node {} ignored (unsupported type)".format(dname))

   196

                continue

   197

   198

            access = node.get_access_level()

   199

            if {"input":ua.AccessLevel.CurrentRead,

   200

                "output":ua.AccessLevel.CurrentWrite}[self.direction] not in access:

   201

                self.log("Node {} ignored because of insuficient access rights".format(dname))

   202

                continue

   203

   204

            nsid = node.nodeid.NamespaceIndex

   205

            nid =  node.nodeid.Identifier

   206

            nid_type =  type(nid).__name__

   207

            iecid = nid

   208

   209

            value = [dname,

   210

                     nsid,

   211

                     nid_type,

   212

                     nid,

   213

                     tname,

   214

                     iecid]

   215

            self.model.AddRow(value)

   216

   217

   218

   219

il = None

   220

fldridx = None    

   221

fldropenidx = None

   222

fileidx = None

   223

smileidx = None

   224

isz = (16,16)

   225

   226

treecolnames  = [  "Name", "Class", "NSIdx", "Id"]

   227

treecolwidths = [     250,     100,      50,  200]

   228

   229

   230

def prepare_image_list():

   231

    global il, fldridx, fldropenidx, fileidx, smileidx    

   232

   233

    if il is not None: 

   234

        return

   235

   236

    il = wx.ImageList(isz[0], isz[1])

   237

    fldridx     = il.Add(wx.ArtProvider.GetBitmap(wx.ART_FOLDER,      wx.ART_OTHER, isz))

   238

    fldropenidx = il.Add(wx.ArtProvider.GetBitmap(wx.ART_FILE_OPEN,   wx.ART_OTHER, isz))

   239

    fileidx     = il.Add(wx.ArtProvider.GetBitmap(wx.ART_NORMAL_FILE, wx.ART_OTHER, isz))

   240

    smileidx    = il.Add(wx.ArtProvider.GetBitmap(wx.ART_ADD_BOOKMARK, wx.ART_OTHER, isz))

   241

   242

   243

class OPCUAClientPanel(wx.SplitterWindow):

   244

    def __init__(self, parent, modeldata, log, config_getter):

   245

        self.log = log

   246

        wx.SplitterWindow.__init__(self, parent, -1)

   247

   248

        self.ordered_nodes = []

   249

   250

        self.inout_panel = wx.Panel(self)

   251

        self.inout_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)

   252

        self.inout_sizer.AddGrowableCol(0)

   253

        self.inout_sizer.AddGrowableRow(1)

   254

   255

        self.client = None

   256

        self.config_getter = config_getter

   257

   258

        self.connect_button = wx.ToggleButton(self.inout_panel, -1, "Browse Server")

   259

   260

        self.selected_splitter = wx.SplitterWindow(self.inout_panel, style=wx.SUNKEN_BORDER | wx.SP_3D)

   261

   262

        self.selected_datas = modeldata

   263

        self.selected_models = { direction:OPCUASubListModel(self.selected_datas[direction], log) for direction in directions }

   264

        self.selected_lists = { direction:OPCUASubListPanel(

   265

                self.selected_splitter, log, 

   266

                self.selected_models[direction], direction) 

   267

            for direction in directions }

   268

   269

        self.selected_splitter.SplitHorizontally(*[self.selected_lists[direction] for direction in directions]+[300])

   270

   271

        self.inout_sizer.Add(self.connect_button, flag=wx.GROW)

   272

        self.inout_sizer.Add(self.selected_splitter, flag=wx.GROW)

   273

        self.inout_sizer.Layout()

   274

        self.inout_panel.SetAutoLayout(True)

   275

        self.inout_panel.SetSizer(self.inout_sizer)

   276

   277

        self.Initialize(self.inout_panel)

   278

   279

        self.Bind(wx.EVT_TOGGLEBUTTON, self.OnConnectButton, self.connect_button)

   280

   281

    def OnClose(self):

   282

        if self.client is not None:

   283

            self.client.disconnect()

   284

            self.client = None

   285

   286

    def __del__(self):

   287

        self.OnClose()

   288

   289

    def OnConnectButton(self, event):

   290

        if self.connect_button.GetValue():

   291

   292

            self.tree_panel = wx.Panel(self)

   293

            self.tree_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)

   294

            self.tree_sizer.AddGrowableCol(0)

   295

            self.tree_sizer.AddGrowableRow(0)

   296

   297

            self.tree = gizmos.TreeListCtrl(self.tree_panel, -1, style=0, agwStyle=

   298

                                            gizmos.TR_DEFAULT_STYLE

   299

                                            | gizmos.TR_MULTIPLE

   300

                                            | gizmos.TR_FULL_ROW_HIGHLIGHT

   301

                                       )

   302

   303

            prepare_image_list()

   304

            self.tree.SetImageList(il)

   305

   306

            for idx,(colname, width) in enumerate(zip(treecolnames, treecolwidths)):

   307

                self.tree.AddColumn(colname)

   308

                self.tree.SetColumnWidth(idx, width)

   309

   310

            self.tree.SetMainColumn(0)

   311

   312

            config = self.config_getter()

   313

            self.client = Client(config["URI"])

   314

   315

            AuthType = config["AuthType"]

   316

            if AuthType=="UserPasword":

   317

                self.client.set_user(config["User"])

   318

                self.client.set_password(config["Password"])

   319

            elif AuthType=="x509":

   320

                self.client.set_security_string(

   321

                    "{Policy},{Mode},{Certificate},{PrivateKey}".format(**config))

   323

   324

            self.client.connect()

   325

            self.client.load_type_definitions()  # load definition of server specific structures/extension objects

   326

            rootnode = self.client.get_root_node()

   327

   328

            rootitem = self.AddNodeItem(self.tree.AddRoot, rootnode)

   329

   330

            # Populate first level so that root can be expanded

   331

            self.CreateSubItems(rootitem)

   332

   333

            self.tree.Bind(wx.EVT_TREE_ITEM_EXPANDED, self.OnExpand)

   334

   335

            self.tree.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTreeNodeSelection)

   336

            self.tree.Bind(wx.EVT_TREE_BEGIN_DRAG, self.OnTreeBeginDrag)

   337

   338

            self.tree.Expand(rootitem)

   339

   340

            hint = wx.StaticText(self, label = "Drag'n'drop desired variables from tree to Input or Output list")

   341

   342

            self.tree_sizer.Add(self.tree, flag=wx.GROW)

   343

            self.tree_sizer.Add(hint, flag=wx.GROW)

   344

            self.tree_sizer.Layout()

   345

            self.tree_panel.SetAutoLayout(True)

   346

            self.tree_panel.SetSizer(self.tree_sizer)

   347

   348

            self.SplitVertically(self.tree_panel, self.inout_panel, 500)

   349

        else:

   350

            self.client.disconnect()

   351

            self.client = None

   352

            self.Unsplit(self.tree_panel)

   353

            self.tree_panel.Destroy()

   354

   355

   356

    def CreateSubItems(self, item):

   357

        node, browsed = self.tree.GetPyData(item)

   358

        if not browsed:

   359

            for subnode in node.get_children():

   360

                self.AddNodeItem(lambda n: self.tree.AppendItem(item, n), subnode)

   361

            self.tree.SetPyData(item,(node, True))

   362

   363

    def AddNodeItem(self, item_creation_func, node):

   364

        nsid = node.nodeid.NamespaceIndex

   365

        nid =  node.nodeid.Identifier

   366

        dname = node.get_display_name().Text

   367

        cname = node.get_node_class().name

   368

   369

        item = item_creation_func(dname)

   370

   371

        if cname == "Variable":

   372

            access = node.get_access_level()

   373

            normalidx = fileidx

   374

            r = ua.AccessLevel.CurrentRead in access

   375

            w = ua.AccessLevel.CurrentWrite in access

   376

            if r and w:

   377

                ext = "RW"

   378

            elif r:

   379

                ext = "RO"

   380

            elif w:

   381

                ext = "WO"  # not sure this one exist

   382

            else:

   383

                ext = "no access"  # not sure this one exist

   384

            cname = "Var "+node.get_data_type_as_variant_type().name+" (" + ext + ")"

   385

        else:

   386

            normalidx = fldridx

   387

   388

        self.tree.SetPyData(item,(node, False))

   389

        self.tree.SetItemText(item, cname, 1)

   390

        self.tree.SetItemText(item, str(nsid), 2)

   391

        self.tree.SetItemText(item, type(nid).__name__+": "+str(nid), 3)

   392

        self.tree.SetItemImage(item, normalidx, which = wx.TreeItemIcon_Normal)

   393

        self.tree.SetItemImage(item, fldropenidx, which = wx.TreeItemIcon_Expanded)

   394

   395

        return item

   396

   397

    def OnExpand(self, evt):

   398

        for item in evt.GetItem().GetChildren():

   399

            self.CreateSubItems(item)

   400

   401

    # def OnActivate(self, evt):

   402

    #     item = evt.GetItem()

   403

    #     node, browsed = self.tree.GetPyData(item)

   404

   405

    def OnTreeNodeSelection(self, event):

   406

        items = self.tree.GetSelections()

   407

        items_pydata = [self.tree.GetPyData(item) for item in items]

   408

   409

        nodes = [node for node, _unused in items_pydata]

   410

   411

        # append new nodes to ordered list

   412

        for node in nodes:

   413

            if node not in self.ordered_nodes:

   414

                self.ordered_nodes.append(node)

   415

   416

        # filter out vanished items

   417

        self.ordered_nodes = [

   418

            node 

   419

            for node in self.ordered_nodes 

   420

            if node in nodes]

   421

   422

    def GetSelectedNodes(self):

   423

        return self.ordered_nodes 

   424

   425

    def OnTreeBeginDrag(self, event):

   426

        """

   427

        Called when a drag is started in tree

   428

        @param event: wx.TreeEvent

   429

        """

   430

        if self.ordered_nodes:

   431

            # Just send a recognizable mime-type, drop destination

   432

            # will get python data from parent

   433

            data = wx.CustomDataObject(OPCUAClientDndMagicWord)

   434

            dragSource = wx.DropSource(self)

   435

            dragSource.SetData(data)

   436

            dragSource.DoDragDrop()

   437

   438

    def Reset(self):

   439

        for direction in directions:

   440

            self.selected_models[direction].ResetData() 

   441

   442

   443

class OPCUAClientList(list):

   444

    def __init__(self, log = lambda m:None):

   445

        super(OPCUAClientList, self).__init__(self)

   446

        self.log = log

   447

   448

    def append(self, value):

   449

        v = dict(zip(lstcolnames, value))

   450

   451

        if type(v["IEC"]) != int:

   452

            if len(self) == 0:

   453

                v["IEC"] = 0

   454

            else:

   455

                iecnums = set(zip(*self)[lstcolnames.index("IEC")])

   456

                greatest = max(iecnums)

   457

                holes = set(range(greatest)) - iecnums

   458

                v["IEC"] = min(holes) if holes else greatest+1

   459

   460

        if v["IdType"] not in UA_NODE_ID_types:

   461

            self.log("Unknown IdType\n".format(value))

   462

            return False

   463

   464

        try:

   465

            for t,n in zip(lstcoltypess, lstcolnames):

   466

                v[n] = t(v[n]) 

   467

        except ValueError: 

   468

            self.log("Variable {} (Id={}) has invalid type\n".format(v["Name"],v["Id"]))

   469

            return False

   470

   471

        if len(self)>0 and v["Id"] in zip(*self)[lstcolnames.index("Id")]:

   472

            self.log("Variable {} (Id={}) already in list\n".format(v["Name"],v["Id"]))

   473

            return False

   474

   475

        list.append(self, [v[n] for n in lstcolnames])

   476

   477

        return True

   478

   479

class OPCUAClientModel(dict):

   480

    def __init__(self, log = lambda m:None):

   481

        super(OPCUAClientModel, self).__init__()

   482

        for direction in directions:

   483

            self[direction] = OPCUAClientList(log)

   484

   485

    def LoadCSV(self,path):

   486

        with open(path, 'rb') as csvfile:

   487

            reader = csv.reader(csvfile, delimiter=',', quotechar='"')

   488

            buf = {direction:[] for direction, _model in self.iteritems()}

   489

            for direction, model in self.iteritems():

   490

                self[direction][:] = []

   491

            for row in reader:

   492

                direction = row[0]

   493

                self[direction].append(row[1:])

   494

   495

    def SaveCSV(self,path):

   496

        with open(path, 'wb') as csvfile:

   497

            for direction, data in self.iteritems():

   498

                writer = csv.writer(csvfile, delimiter=',',

   499

                                quotechar='"', quoting=csv.QUOTE_MINIMAL)

   500

                for row in data:

   501

                    writer.writerow([direction] + row)

   502

   503

    def GenerateC(self, path, locstr, config):

   504

        template = """/* code generated by beremiz OPC-UA extension */

   505

   506

#include <open62541/client_config_default.h>

   507

#include <open62541/client_highlevel.h>

   508

#include <open62541/plugin/log_stdout.h>

   509

#include <open62541/plugin/securitypolicy.h>

   510

   511

#include <open62541/types.h>

   512

#include <open62541/types_generated_handling.h>

   513

   514

#define _Log(level, ...)                                                                           \\

   515

    {{                                                                                             \\

   516

        char mstr[256];                                                                            \\

   517

        snprintf(mstr, 255, __VA_ARGS__);                                                          \\

   518

        LogMessage(level, mstr, strlen(mstr));                                                     \\

   519

    }}

   520