1

# mqtt/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 .mqtt_client_gen import MQTTClientPanel, MQTTClientModel, MQTT_IEC_types, authParams

    10

    11

import util.paths as paths

    12

    13

PahoMqttCPath = paths.ThirdPartyPath("MQTT")

    14

PahoMqttCLibraryPath = PahoMqttCPath 

    15

PahoMqttCIncludePaths = [PahoMqttCPath]

    16

    17

class MQTTClientEditor(ConfTreeNodeEditor):

    18

    CONFNODEEDITOR_TABS = [

    19

        (_("MQTT Client"), "CreateMQTTClient_UI")]

    20

    21

    def Log(self, msg):

    22

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

    23

    24

    def CreateMQTTClient_UI(self, parent):

    25

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

    26

    27

class MQTTClient(object):

    28

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

    29

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

    30

      <xsd:element name="MQTTClient">

    31

        <xsd:complexType>

    32

          <xsd:sequence>

    33

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

    34

              <xsd:complexType>

    35

                <xsd:choice minOccurs="0">

    36

                  <xsd:element name="x509">

    37

                    <xsd:complexType>

    38

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

    39

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

    40

                    </xsd:complexType>

    41

                  </xsd:element>

    42

                  <xsd:element name="UserPassword">

    43

                    <xsd:complexType>

    44

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

    45

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

    46

                    </xsd:complexType>

    47

                  </xsd:element>

    48

                </xsd:choice>

    49

              </xsd:complexType>

    50

            </xsd:element>

    51

          </xsd:sequence>

    52

          <xsd:attribute name="Broker_URI" type="xsd:string" use="optional" default="ws://localhost:1883"/>

    53

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

    54

        </xsd:complexType>

    55

      </xsd:element>

    56

    </xsd:schema>

    57

    """

    58

    59

    EditorType = MQTTClientEditor

    60

    61

    def __init__(self):

    62

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

    63

    64

        filepath = self.GetFileName()

    65

        if os.path.isfile(filepath):

    66

            self.modeldata.LoadCSV(filepath)

    67

    68

    def Log(self, msg):

    69

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

    70

    71

    def GetModelData(self):

    72

        return self.modeldata

    73

    74

    def GetConfig(self):

    75

        def cfg(path): 

    76

            try:

    77

                attr=self.GetParamsAttributes("MQTTClient."+path)

    78

            except ValueError:

    79

                return None

    80

            return attr["value"]

    81

    82

        AuthType = cfg("AuthType")

    83

        res = dict(URI=cfg("Broker_URI"), AuthType=AuthType, clientID=cfg("Client_ID"))

    84

    85

        paramList = authParams.get(AuthType, None)

    86

        if paramList:

    87

            for name,default in paramList:

    88

                value = cfg("AuthType."+name)

    89

                if value == "" or value is None:

    90

                    value = default

    91

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

    92

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

    93

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

    94

                res[name] = value

    95

    96

        return res

    97

    98

    def GetFileName(self):

    99

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

   100

   101

    def OnCTNSave(self, from_project_path=None):

   102

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

   103

        return True

   104

   105

    def CTNGenerate_C(self, buildpath, locations):

   106

        current_location = self.GetCurrentLocation()

   107

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

   108

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

   109

   110

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

   111

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

   112

   113

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

   114

            c_file.write(c_code)

   115

   116

        LDFLAGS = [' "' + os.path.join(PahoMqttCLibraryPath, "libpaho-mqtt3as.a") + '"', '-lcrypto']

   117

   118

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

   119

   120

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

   121

   122

    def GetVariableLocationTree(self):

   123

        current_location = self.GetCurrentLocation()

   124

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

   125

        name = self.BaseParams.getName()

   126

        entries = []

   127

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

   128

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

   129

            for row in data:

   130

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

   131

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

   132

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

   133

                entries.append({

   134

                    "name": dname,

   135

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

   136

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

   137

                    "IEC_type": iec_type,

   138

                    "var_name": c_loc_name,

   139

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

   140

                    "description": "",

   141

                    "children": []})

   142

        return {"name": name,

   143

                "type": LOCATION_CONFNODE,

   144

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

   145

                "children": entries}

   146