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

from wx.lib.agw.hypertreelist import HyperTreeList as TreeListCtrl

    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

class OPCUASubListModel(dv.PyDataViewIndexListModel):

    42

    def __init__(self, data, log):

    43

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

    44

        self.data = data

    45

        self.log = log

    46

    47

    def GetColumnType(self, col):

    48

        return "string"

    49

    50

    def GetValueByRow(self, row, col):

    51

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

    52

    53

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

    54

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

    55

        expectedtype = lstcoltypess[col]

    56

    57

        try:

    58

            v = expectedtype(value)

    59

        except ValueError: 

    60

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

    61

            return False

    62

    63

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

    64

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

    65

            return False

    66

    67

        self.data[row][col] = v

    68

        return True

    69

    70

    # Report how many columns this model provides data for.

    71

    def GetColumnCount(self):

    72

        return len(lstcolnames)

    73

    74

    # Report the number of rows in the model

    75

    def GetCount(self):

    76

        #self.log.write('GetCount')

    77

        return len(self.data)

    78

    79

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

    80

    # cell at (row, col)

    81

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

    82

        if col == 5:

    83

            attr.SetColour('blue')

    84

            attr.SetBold(True)

    85

            return True

    86

        return False

    87

    88

    89

    def DeleteRows(self, rows):

    90

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

    91

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

    92

        rows = sorted(rows, reverse=True)

    93

    94

        for row in rows:

    95

            # remove it from our data structure

    96

            del self.data[row]

    97

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

    98

            self.RowDeleted(row)

    99

   100

   101

    def AddRow(self, value):

   102

        if self.data.append(value):

   103

            # notify views

   104

            self.RowAppended()

   105

   106

    def ResetData(self):

   107

        self.Reset(len(self.data))

   108

   109

OPCUAClientDndMagicWord = "text/beremiz-opcuaclient"

   110

   111

class NodeDropTarget(wx.DropTarget):

   112

   113

    def __init__(self, parent):

   114

        data = wx.CustomDataObject(OPCUAClientDndMagicWord)

   115

        wx.DropTarget.__init__(self, data)

   116

        self.ParentWindow = parent

   117

   118

    def OnDrop(self, x, y):

   119

        self.ParentWindow.OnNodeDnD()

   120

        return True

   121

   122

class OPCUASubListPanel(wx.Panel):

   123

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

   124

        self.log = log

   125

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

   126

   127

        self.dvc = dv.DataViewCtrl(self,

   128

                                   style=wx.BORDER_THEME

   129

                                   | dv.DV_ROW_LINES

   130

                                   | dv.DV_HORIZ_RULES

   131

                                   | dv.DV_VERT_RULES

   132

                                   | dv.DV_MULTIPLE

   133

                                   )

   134

   135

        self.model = model

   136

   137

        self.dvc.AssociateModel(self.model)

   138

   139

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

   140

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

   141

   142

        DropTarget = NodeDropTarget(self)

   143

        self.dvc.SetDropTarget(DropTarget)

   144

   145

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

   146

   147

        self.direction =  direction

   148

        titlestr = direction + " variables"

   149

   150

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

   151

   152

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

   153

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

   154

   155

        topsizer = wx.BoxSizer(wx.HORIZONTAL)

   156

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

   157

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

   158

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

   159

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

   160

   161

   162

   163

    def OnDeleteRows(self, evt):

   164

        items = self.dvc.GetSelections()

   165

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

   166

        self.model.DeleteRows(rows)

   167

   168

   169

    def OnNodeDnD(self):

   170

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

   171

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

   172

        #             splitter.        panel.      splitter

   173

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

   174

        nodes = ClientPanel.GetSelectedNodes()

   175

        for node in nodes:

   176

            cname = node.get_node_class().name

   177

            dname = node.get_display_name().Text

   178

            if cname != "Variable":

   179

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

   180

                continue

   181

   182

            tname = node.get_data_type_as_variant_type().name

   183

            if tname not in UA_IEC_types:

   184

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

   185

                continue

   186

   187

            access = node.get_access_level()

   188

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

   189

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

   190

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

   191

                continue

   192

   193

            nsid = node.nodeid.NamespaceIndex

   194

            nid =  node.nodeid.Identifier

   195

            nid_type =  type(nid).__name__

   196

            iecid = nid

   197

   198

            value = [dname,

   199

                     nsid,

   200

                     nid_type,

   201

                     nid,

   202

                     tname,

   203

                     iecid]

   204

            self.model.AddRow(value)

   205

   206

   207

   208

il = None

   209

fldridx = None    

   210

fldropenidx = None

   211

fileidx = None

   212

smileidx = None

   213

isz = (16,16)

   214

   215

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

   216

treecolwidths = [     250,     100,      50,  200]

   217

   218

   219

def prepare_image_list():

   220

    global il, fldridx, fldropenidx, fileidx, smileidx    

   221

   222

    if il is not None: 

   223

        return

   224

   225

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

   226

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

   227

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

   228

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

   229

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

   230

   231

   232

class OPCUAClientPanel(wx.SplitterWindow):

   233

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

   234

        self.log = log

   235

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

   236

   237

        self.ordered_nodes = []

   238

   239

        self.inout_panel = wx.Panel(self)

   240

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

   241

        self.inout_sizer.AddGrowableCol(0)

   242

        self.inout_sizer.AddGrowableRow(1)

   243

   244

        self.client = None

   245

        self.uri_getter = uri_getter

   246

   247

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

   248

   249

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

   250

   251

        self.selected_datas = modeldata

   252

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

   253

        self.selected_lists = { direction:OPCUASubListPanel(

   254

                self.selected_splitter, log, 

   255

                self.selected_models[direction], direction) 

   256

            for direction in directions }

   257

   258

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

   259

   260

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

   261

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

   262

        self.inout_sizer.Layout()

   263

        self.inout_panel.SetAutoLayout(True)

   264

        self.inout_panel.SetSizer(self.inout_sizer)

   265

   266

        self.Initialize(self.inout_panel)

   267

   268

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

   269

   270

    def OnClose(self):

   271

        if self.client is not None:

   272

            self.client.disconnect()

   273

            self.client = None

   274

   275

    def __del__(self):

   276

        self.OnClose()

   277

   278

    def OnConnectButton(self, event):

   279

        if self.connect_button.GetValue():

   280

   281

            self.tree_panel = wx.Panel(self)

   282

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

   283

            self.tree_sizer.AddGrowableCol(0)

   284

            self.tree_sizer.AddGrowableRow(0)

   285

   286

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

   287

                                            wx.TR_DEFAULT_STYLE

   288

                                            | wx.TR_MULTIPLE

   289

                                            | wx.TR_FULL_ROW_HIGHLIGHT

   290

                                       )

   291

   292

            prepare_image_list()

   293

            self.tree.SetImageList(il)

   294

   295

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

   296

                self.tree.AddColumn(colname)

   297

                self.tree.SetColumnWidth(idx, width)

   298

   299

            self.tree.SetMainColumn(0)

   300

   301

            self.client = Client(self.uri_getter())

   302

            self.client.connect()

   303

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

   304

            rootnode = self.client.get_root_node()

   305

   306

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

   307

   308

            # Populate first level so that root can be expanded

   309

            self.CreateSubItems(rootitem)

   310

   311

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

   312

   313

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

   314

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

   315

   316

            self.tree.Expand(rootitem)

   317

   318

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

   319

   320

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

   321

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

   322

            self.tree_sizer.Layout()

   323

            self.tree_panel.SetAutoLayout(True)

   324

            self.tree_panel.SetSizer(self.tree_sizer)

   325

   326

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

   327

        else:

   328

            self.client.disconnect()

   329

            self.client = None

   330

            self.Unsplit(self.tree_panel)

   331

            self.tree_panel.Destroy()

   332

   333

   334

    def CreateSubItems(self, item):

   335

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

   336

        if not browsed:

   337

            for subnode in node.get_children():

   338

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

   339

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

   340

   341

    def AddNodeItem(self, item_creation_func, node):

   342

        nsid = node.nodeid.NamespaceIndex

   343

        nid =  node.nodeid.Identifier

   344

        dname = node.get_display_name().Text

   345

        cname = node.get_node_class().name

   346

   347

        item = item_creation_func(dname)

   348

   349

        if cname == "Variable":

   350

            access = node.get_access_level()

   351

            normalidx = fileidx

   352

            r = ua.AccessLevel.CurrentRead in access

   353

            w = ua.AccessLevel.CurrentWrite in access

   354

            if r and w:

   355

                ext = "RW"

   356

            elif r:

   357

                ext = "RO"

   358

            elif w:

   359

                ext = "WO"  # not sure this one exist

   360

            else:

   361

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

   362

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

   363

        else:

   364

            normalidx = fldridx

   365

   366

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

   367

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

   368

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

   369

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

   370

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

   371

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

   372

   373

        return item

   374

   375

    def OnExpand(self, evt):

   376

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

   377

            self.CreateSubItems(item)

   378

   379

    # def OnActivate(self, evt):

   380

    #     item = evt.GetItem()

   381

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

   382

   383

    def OnTreeNodeSelection(self, event):

   384

        items = self.tree.GetSelections()

   385

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

   386

   387

        nodes = [node for node, _unused in items_pydata]

   388

   389

        # append new nodes to ordered list

   390

        for node in nodes:

   391

            if node not in self.ordered_nodes:

   392

                self.ordered_nodes.append(node)

   393

   394

        # filter out vanished items

   395

        self.ordered_nodes = [

   396

            node 

   397

            for node in self.ordered_nodes 

   398

            if node in nodes]

   399

   400

    def GetSelectedNodes(self):

   401

        return self.ordered_nodes 

   402

   403

    def OnTreeBeginDrag(self, event):

   404

        """

   405

        Called when a drag is started in tree

   406

        @param event: wx.TreeEvent

   407

        """

   408

        if self.ordered_nodes:

   409

            # Just send a recognizable mime-type, drop destination

   410

            # will get python data from parent

   411

            data = wx.CustomDataObject(OPCUAClientDndMagicWord)

   412

            dragSource = wx.DropSource(self)

   413

            dragSource.SetData(data)

   414

            dragSource.DoDragDrop()

   415

   416

    def Reset(self):

   417

        for direction in directions:

   418

            self.selected_models[direction].ResetData() 

   419

   420

   421

class OPCUAClientList(list):

   422

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

   423

        super(OPCUAClientList, self).__init__(self)

   424

        self.log = log

   425

   426

    def append(self, value):

   427

        v = dict(zip(lstcolnames, value))

   428

   429

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

   430

            if len(self) == 0:

   431

                v["IEC"] = 0

   432

            else:

   433

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

   434

                greatest = max(iecnums)

   435

                holes = set(range(greatest)) - iecnums

   436

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

   437

   438

        if v["IdType"] not in UA_NODE_ID_types:

   439

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

   440

            return False

   441

   442

        try:

   443

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

   444

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

   445

        except ValueError: 

   446

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

   447

            return False

   448

   449

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

   450

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

   451

            return False

   452

   453

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

   454

   455

        return True

   456

   457

class OPCUAClientModel(dict):

   458

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

   459

        super(OPCUAClientModel, self).__init__()

   460

        for direction in directions:

   461

            self[direction] = OPCUAClientList(log)

   462

   463

    def LoadCSV(self,path):

   464

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

   465

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

   466

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

   467

            for direction, model in self.iteritems():

   468

                self[direction][:] = []

   469

            for row in reader:

   470

                direction = row[0]

   471

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

   472

   473

    def SaveCSV(self,path):

   474

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

   475

            for direction, data in self.iteritems():

   476

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

   477

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

   478

                for row in data:

   479

                    writer.writerow([direction] + row)

   480

   481

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

   482

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

   483

   484

#include <open62541/client_config_default.h>

   485

#include <open62541/client_highlevel.h>

   486

#include <open62541/plugin/log_stdout.h>

   487

   488

static UA_Client *client;

   489

   490

#define DECL_VAR(ua_type, C_type, c_loc_name)                                                       \\

   491

static UA_Variant c_loc_name##_variant;                                                             \\

   492

static C_type c_loc_name##_buf = 0;                                                                 \\

   493

C_type *c_loc_name = &c_loc_name##_buf;

   494

   495

%(decl)s

   496

   497

void __cleanup_%(locstr)s(void)

   498

{

   499

    UA_Client_disconnect(client);

   500

    UA_Client_delete(client);

   501

}

   502

   503

   504

#define INIT_READ_VARIANT(ua_type, c_loc_name)                                                     \\

   505

    UA_Variant_init(&c_loc_name##_variant);

   506

   507

#define INIT_WRITE_VARIANT(ua_type, ua_type_enum, c_loc_name)       \\

   508

    UA_Variant_setScalar(&c_loc_name##_variant, (ua_type*)c_loc_name, &UA_TYPES[ua_type_enum]);

   509

   510

int __init_%(locstr)s(int argc,char **argv)

   511

{

   512

    UA_StatusCode retval;

   513

    client = UA_Client_new();

   514

    UA_ClientConfig_setDefault(UA_Client_getConfig(client));

   515

%(init)s

   516

   517

    /* Connect to server */

   518

    retval = UA_Client_connect(client, "%(uri)s");

   519

    if(retval != UA_STATUSCODE_GOOD) {

   520

        UA_Client_delete(client);

   521

        return EXIT_FAILURE;

   522

    }

   523

}