1

# opcua/client.py

     2

     3

from __future__ import absolute_import

     4

     5

import os

     6

     7

from editors.ConfTreeNodeEditor import ConfTreeNodeEditor

     8

from PLCControler import LOCATION_CONFNODE, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT

     9

from .opcua_client_maker import OPCUAClientPanel, OPCUAClientModel, UA_IEC_types, authParams

    10

    11

import util.paths as paths

    12

    13

# Paths to open62541 assume that 

    14

# - open62541 directory is aside beremiz directory

    15

# - open62541 was just built (not installed)

    16

    17

Open62541Path = paths.ThirdPartyPath("open62541")

    18

Open62541LibraryPath = os.path.join(Open62541Path,"build","bin") 

    19

Open62541IncludePaths = [os.path.join(Open62541Path, *dirs) for dirs in [

    20

    ("plugins","include"),

    21

    ("build","src_generated"),

    22

    ("include",),

    23

    ("arch",)]]

    24

    25

class OPCUAClientEditor(ConfTreeNodeEditor):

    26

    CONFNODEEDITOR_TABS = [

    27

        (_("OPC-UA Client"), "CreateOPCUAClient_UI")]

    28

    29

    def Log(self, msg):

    30

        self.Controler.GetCTRoot().logger.write(msg)

    31

    32

    def CreateOPCUAClient_UI(self, parent):

    33

        return OPCUAClientPanel(parent, self.Controler.GetModelData(), self.Log, self.Controler.GetConfig)

    34

    35

class OPCUAClient(object):

    36

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

    37

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    38

      <xsd:element name="OPCUAClient">

    39

        <xsd:complexType>

    40

          <xsd:sequence>

    41

            <xsd:element name="AuthType" minOccurs="0">

    42

              <xsd:complexType>

    43

                <xsd:choice minOccurs="0">

    44

                  <xsd:element name="x509">

    45

                    <xsd:complexType>

    46

                      <xsd:sequence>

    47

                        <xsd:element name="Policy">

    48

                          <xsd:annotation>

    49

                            <xsd:documentation>Default to Basic256Sha256 if not specified</xsd:documentation>

    50

                          </xsd:annotation>

    51

                          <xsd:complexType>

    52

                            <xsd:choice minOccurs="0">

    53

                              <xsd:element name="Basic256Sha256"/>

    54

                              <xsd:element name="Basic128Rsa15"/>

    55

                              <xsd:element name="Basic256"/>

    56

                            </xsd:choice>

    57

                          </xsd:complexType>

    58

                        </xsd:element>

    59

                        <xsd:element name="Mode">

    60

                          <xsd:complexType>

    61

                            <xsd:choice minOccurs="0">

    62

                              <xsd:element name="SignAndEncrypt"/>

    63

                              <xsd:element name="Sign"/>

    64

                            </xsd:choice>

    65

                          </xsd:complexType>

    66

                        </xsd:element>

    67

                      </xsd:sequence>

    68

                      <xsd:attribute name="Certificate" type="xsd:string" use="optional" default="certificate.pem"/>

    69

                      <xsd:attribute name="PrivateKey" type="xsd:string" use="optional" default="private_key.pem"/>

    70

                    </xsd:complexType>

    71

                  </xsd:element>

    72

                  <xsd:element name="UserPassword">

    73

                    <xsd:complexType>

    74

                      <xsd:attribute name="User" type="xsd:string" use="optional"/>

    75

                      <xsd:attribute name="Password" type="xsd:string" use="optional"/>

    76

                    </xsd:complexType>

    77

                  </xsd:element>

    78

                </xsd:choice>

    79

              </xsd:complexType>

    80

            </xsd:element>

    81

          </xsd:sequence>

    82

          <xsd:attribute name="Server_URI" type="xsd:string" use="optional" default="opc.tcp://localhost:4840"/>

    83

        </xsd:complexType>

    84

      </xsd:element>

    85

    </xsd:schema>

    86

    """

    87

    88

    EditorType = OPCUAClientEditor

    89

    90

    def __init__(self):

    91

        self.modeldata = OPCUAClientModel(self.Log, self.CTNMarkModified)

    92

    93

        filepath = self.GetFileName()

    94

        if os.path.isfile(filepath):

    95

            self.modeldata.LoadCSV(filepath)

    96

    97

    def Log(self, msg):

    98

        self.GetCTRoot().logger.write(msg)

    99

   100

    def GetModelData(self):

   101

        return self.modeldata

   102

   103

    def GetConfig(self):

   104

        cfg = lambda path: self.GetParamsAttributes("OPCUAClient."+path)["value"]

   105

        AuthType = cfg("AuthType")

   106

        res = dict(URI=cfg("Server_URI"), AuthType=AuthType)

   107

   108

        paramList = authParams.get(AuthType, None)

   109

        if paramList:

   110

            for name,default in paramList:

   111

                value = cfg("AuthType."+name)

   112

                if value == "" or value is None:

   113

                    value = default

   114

                # cryptomaterial is expected to be in project's user provide file directory

   115

                if name in ["Certificate","PrivateKey"]:

   116

                    value = os.path.join(self.GetCTRoot()._getProjectFilesPath(), value)

   117

                res[name] = value

   118

   119

        return res

   120

   121

    def GetFileName(self):

   122

        return os.path.join(self.CTNPath(), 'selected.csv')

   123

   124

    def OnCTNSave(self, from_project_path=None):

   125

        self.modeldata.SaveCSV(self.GetFileName())

   126

        return True

   127

   128

    def CTNGenerate_C(self, buildpath, locations):

   129

        current_location = self.GetCurrentLocation()

   130

        locstr = "_".join(map(str, current_location))

   131

        c_path = os.path.join(buildpath, "opcua_client__%s.c" % locstr)

   132

   133

        c_code = '#include "beremiz.h"\n'

   134

        c_code += self.modeldata.GenerateC(c_path, locstr, self.GetConfig())

   135

   136

        with open(c_path, 'wb') as c_file:

   137

            c_file.write(c_code)

   138

   139

        LDFLAGS = ['"' + os.path.join(Open62541LibraryPath, "libopen62541.a") + '"', '-lcrypto']

   140

   141

        CFLAGS = ' '.join(['-I"' + path + '"' for path in Open62541IncludePaths])

   142

   143

        # Note: all user provided files are systematicaly copied, including cryptomaterial

   144

   145

        return [(c_path, CFLAGS)], LDFLAGS, True

   146

   147

    def GetVariableLocationTree(self):

   148

        current_location = self.GetCurrentLocation()

   149

        locstr = "_".join(map(str, current_location))

   150

        name = self.BaseParams.getName()

   151

        entries = []

   152

        for direction, data in self.modeldata.iteritems():

   153

            iec_direction_prefix = {"input": "__I", "output": "__Q"}[direction]

   154

            for row in data:

   155

                dname, ua_nsidx, ua_nodeid_type, _ua_node_id, ua_type, iec_number = row

   156

                iec_type, C_type, iec_size_prefix, ua_type_enum, ua_type = UA_IEC_types[ua_type]

   157

                c_loc_name = iec_direction_prefix + iec_size_prefix + locstr + "_" + str(iec_number)

   158

                entries.append({

   159

                    "name": dname,

   160

                    "type": {"input": LOCATION_VAR_INPUT, "output": LOCATION_VAR_OUTPUT}[direction],

   161

                    "size": {"X":1, "B":8, "W":16, "D":32, "L":64}[iec_size_prefix],

   162

                    "IEC_type": iec_type,

   163

                    "var_name": c_loc_name,

   164

                    "location": iec_size_prefix + ".".join([str(i) for i in current_location]) + "." + str(iec_number),

   165

                    "description": "",

   166

                    "children": []})

   167

        return {"name": name,

   168

                "type": LOCATION_CONFNODE,

   169

                "location": ".".join([str(i) for i in current_location]) + ".x",

   170

                "children": entries}

   171