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

    14

# assumes that "build" directory was created in paho.mqtt.c source directory,

    15

# and cmake build was invoked from this directory

    16

PahoMqttCLibraryPath = paths.ThirdPartyPath("paho.mqtt.c", "build", "src")

    17

    18

PahoMqttCIncludePaths = [

    19

    paths.ThirdPartyPath("paho.mqtt.c", "build"),  # VersionInfo.h

    20

    paths.ThirdPartyPath("paho.mqtt.c", "src")

    21

]

    22

    23

class MQTTClientEditor(ConfTreeNodeEditor):

    24

    CONFNODEEDITOR_TABS = [

    25

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

    26

    27

    def Log(self, msg):

    28

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

    29

    30

    def CreateMQTTClient_UI(self, parent):

    31

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

    32

    33

class MQTTClient(object):

    34

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

    35

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

    36

      <xsd:element name="MQTTClient">

    37

        <xsd:complexType>

    38

          <xsd:sequence>

    39

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

    40

              <xsd:complexType>

    41

                <xsd:choice minOccurs="0">

    42

                  <xsd:element name="x509">

    43

                    <xsd:complexType>

    44

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

    45

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

    46

                    </xsd:complexType>

    47

                  </xsd:element>

    48

                  <xsd:element name="UserPassword">

    49

                    <xsd:complexType>

    50

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

    51

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

    52

                    </xsd:complexType>

    53

                  </xsd:element>

    54

                </xsd:choice>

    55

              </xsd:complexType>

    56

            </xsd:element>

    57

          </xsd:sequence>

    58

          <xsd:attribute name="Use_MQTT_5" type="xsd:boolean" use="optional" default="true"/>

    59

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

    60

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

    61

        </xsd:complexType>

    62

      </xsd:element>

    63

    </xsd:schema>

    64

    """

    65

    66

    EditorType = MQTTClientEditor

    67

    68

    def __init__(self):

    69

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

    70

    71

        filepath = self.GetFileName()

    72

        if os.path.isfile(filepath):

    73

            self.modeldata.LoadCSV(filepath)

    74

    75

    def Log(self, msg):

    76

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

    77

    78

    def GetModelData(self):

    79

        return self.modeldata

    80

    81

    def GetConfig(self):

    82

        def cfg(path): 

    83

            try:

    84

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

    85

            except ValueError:

    86

                return None

    87

            return attr["value"]

    88

    89

        AuthType = cfg("AuthType")

    90

        res = dict(

    91

            URI=cfg("Broker_URI"),

    92

            AuthType=AuthType,

    93

            clientID=cfg("Client_ID"),

    94

            UseMQTT5=cfg("Use_MQTT_5"))

    95

    96

        paramList = authParams.get(AuthType, None)

    97

        if paramList:

    98

            for name,default in paramList:

    99

                value = cfg("AuthType."+name)

   100

                if value == "" or value is None:

   101

                    value = default

   102

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

   103

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

   104

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

   105

                res[name] = value

   106

   107

        return res

   108

   109

    def GetFileName(self):

   110

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

   111

   112

    def OnCTNSave(self, from_project_path=None):

   113

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

   114

        return True

   115

   116

    def CTNGenerate_C(self, buildpath, locations):

   117

        current_location = self.GetCurrentLocation()

   118

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

   119

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

   120

   121

        c_code = """

   122

#include "iec_types_all.h"

   123

#include "beremiz.h"

   124

"""

   125

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

   126

   127

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

   128

            c_file.write(c_code)

   129

   130

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

   131

   132

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

   133

   134

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

   135

   136

    def GetVariableLocationTree(self):

   137

        current_location = self.GetCurrentLocation()

   138

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

   139

        name = self.BaseParams.getName()

   140

   141

        entries = []

   142

        children = []

   143

   144

        for row in self.modeldata["output"]:

   145

            Topic, QoS, _Retained, iec_type, iec_number = row

   146

            entries.append((Topic, QoS, iec_type, iec_number, "Q", LOCATION_VAR_OUTPUT))

   147

   148

        for row in self.modeldata["input"]:

   149

            Topic, QoS, iec_type, iec_number = row

   150

            entries.append((Topic, QoS, iec_type, iec_number, "I", LOCATION_VAR_INPUT))

   151

   152

        for Topic, QoS, iec_type, iec_number, iec_dir_prefix, loc_type in entries:

   153

            C_type, iec_size_prefix = MQTT_IEC_types[iec_type]

   154

            c_loc_name = "__" + iec_dir_prefix + iec_size_prefix + locstr + "_" + str(iec_number)

   155

            children.append({

   156

                "name": Topic,

   157

                "type": loc_type,

   158

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

   159

                "IEC_type": iec_type,

   160

                "var_name": c_loc_name,

   161

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

   162

                "description": "",

   163

                "children": []})

   164

   165

        return {"name": name,

   166

                "type": LOCATION_CONFNODE,

   167

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

   168

                "children": children}

   169